trophy.h

Go to the documentation of this file.

 
#pragma once
 
//==============================================================================
// Includes
//==============================================================================
 
#include <stdint.h>
#include <stdbool.h>
#include "hdw-nvs.h"
#include "wsgPalette.h"
#include "fs_font.h"
 
//==============================================================================
// Defines
//==============================================================================
 
#define TROPHY_MAX_TITLE_LEN 48  
#define TROPHY_MAX_DESC_LEN  128 
 
#define DRAW_SLIDE_US  262144 
#define DRAW_STATIC_US 524288 
 
#define NO_IMAGE_SET CNFS_NUM_FILES 
 
//==============================================================================
// Enum
//==============================================================================

typedef enum
{
    TROPHY_TYPE_TRIGGER,   
    TROPHY_TYPE_ADDITIVE,  
    TROPHY_TYPE_PROGRESS,  
    TROPHY_TYPE_CHECKLIST, 
} trophyType_t;

typedef enum
{
    TROPHY_DIFF_FINAL,   
    TROPHY_DIFF_EASY,    
    TROPHY_DIFF_MEDIUM,  
    TROPHY_DIFF_HARD,    
    TROPHY_DIFF_EXTREME, 
} trophyDifficulty_t;

typedef enum
{
    TROPHY_DISPLAY_ALL,         
    TROPHY_DISPLAY_UNLOCKED,    
    TROPHY_DISPLAY_LOCKED,      
    TROPHY_DISPLAY_INCL_HIDDEN, 
} trophyListDisplayMode_t;
 
//==============================================================================
// Structs
//==============================================================================

typedef struct
{
    char title[TROPHY_MAX_TITLE_LEN];      
    char description[TROPHY_MAX_DESC_LEN]; 
    cnfsFileIdx_t image;                   
    trophyType_t type;                     
    trophyDifficulty_t difficulty;         
    int32_t maxVal;                        
    bool hidden;                           
    bool noImage;                          
    const void* identifier; 
} trophyData_t;

typedef struct
{
    bool drawFromBottom;      
    int32_t staticDurationUs; 
    int32_t slideDurationUs;  
    const char* namespaceKey; 
} trophySettings_t;

typedef struct
{
    int32_t length;                   
    const trophyData_t* const list;   
    const trophySettings_t* settings; 
} trophyDataList_t;
 
//==============================================================================
// Functions
//==============================================================================
 
// Trophy system

void trophySystemInit(const trophyDataList_t* settings, const char* modeName);
 
// Utilize trophies

bool trophyUpdate(const trophyData_t* t, int newVal, bool drawUpdate);

bool trophyUpdateMilestone(const trophyData_t* t, int newVal, int threshold);

int32_t trophyGetSavedValue(const trophyData_t* t);

bool trophySetChecklistTask(const trophyData_t* t, int32_t flag, bool unset, bool drawUpdate);

void trophyClear(const trophyData_t* t);
 
// Helpers

bool checkBitFlag(int32_t flags, int8_t idx);

void setBitFlag(int32_t* flags, int8_t idx, bool setTrue);

int trophyGetPoints(bool total, const char* namespace);

const trophyData_t* trophyGetLatest(void);

void trophySetSystemData(const trophyDataList_t* dl, const char* modeName);
 
// Drawing functions

void trophyDraw(font_t* fnt, int64_t elapsedUs);

void trophyDrawListInit(trophyListDisplayMode_t mode);

void trophyDrawListColors(paletteColor_t background, paletteColor_t panel, paletteColor_t shadowBoxes,
                          paletteColor_t dimText, paletteColor_t titleText, paletteColor_t checkmark);

void trophyDrawListDeinit(void);

void trophyDrawList(font_t* fnt, int yOffset);

bool isTrophyDrawing(void);