trophy.c File Reference

Detailed Description

Trophies for swadge modes.

Author

Jerem.nosp@m.y.St.nosp@m.intzc.nosp@m.um@g.nosp@m.mail..nosp@m.com

Date

2025-05-22

Data Structures
struct	trophyDataWrapper_t
struct	trophyDisplayList_t
struct	trophySystem_t
struct	packedTrophy_t

Macros
#define	DEFAULT_MILESTONE   25
#define	BANNER_HEIGHT   48
#define	BANNER_MAX_ICON_DIM   36
#define	SCREEN_CORNER_CLEARANCE   19
#define	IMAGE_BUFFER   8
#define	NUMBER_TEXT_BUFFER   25
#define	NUM_COLORS   6

Functions
void	trophySystemInit (const trophyDataList_t *data, const char *modeName)
	Initializes the Trophy system settings. The system is a global setting and every mode needs to set this when entered to avoid copying from other modes.
bool	trophyUpdate (const trophyData_t *t, int newVal, bool drawUpdate)
	Updates specifed trophy if required.
bool	trophyUpdateMilestone (const trophyData_t *t, int newVal, int threshold)
	Updates just like trophyUpdate(), but only draws when crossing percentage boundary.
int32_t	trophyGetSavedValue (const trophyData_t *t)
	Returns the value saved to the NVS or 0 if the key isn't found.
bool	trophySetChecklistTask (const trophyData_t *t, int32_t flag, bool set, bool drawUpdate)
	Sets or unsets a checklist item.
void	trophyClear (const trophyData_t *t)
	Erases completion data from swadge. Only use in extreme circumstances.
bool	checkBitFlag (int32_t flags, int8_t idx)
	Checks an individual bit flag out of a int32.
void	setBitFlag (int32_t *flags, int8_t idx, bool setTrue)
	Set a bit flag.
int	trophyGetPoints (bool total, const char *namespace)
	Get the point totals for the gamer score.
const trophyData_t *	trophyGetLatest ()
	Get the Latest Trophy Idx object.
void	trophySetSystemData (const trophyDataList_t *dl, const char *modeName)
	Set the Trophy System to a specific mode's values.
bool	isTrophyDrawing (void)
	Check if a trophy is currently being drawn.
void	trophyDraw (font_t *fnt, int64_t elapsedUs)
	Draws the banner if one is queued.
void	trophyDrawListInit (trophyListDisplayMode_t mode)
	Initialize the trophy Draw list.
void	trophyDrawListColors (paletteColor_t background, paletteColor_t panel, paletteColor_t shadowBoxes, paletteColor_t dimText, paletteColor_t titleText, paletteColor_t checkmark)
	Set the colors of the panel to custom. Call after initialization of the list, or it'll be overwritten.
void	trophyDrawListDeinit ()
	Tears down the WSGs and height list.
void	trophyDrawList (font_t *fnt, int yOffset)
	Draws the list.

---

Data Structure Documentation

trophyDataWrapper_t

struct trophyDataWrapper_t

Data Fields
trophyData_t	trophyData	Individual trophy data.
int32_t	currentVal	Saved value of the trophy.
wsg_t	image	Where the image is loaded.
bool	active	If this slot is loaded and ready to animate.

trophyDisplayList_t

struct trophyDisplayList_t

Data Fields
int *	heights	Total height of the stack.
int	platHeight	Height of ther plat frame.
wsg_t *	images	Array of images to display.
trophyListDisplayMode_t	mode	Current display mode.
paletteColor_t	colorList[NUM_COLORS]

trophySystem_t

struct trophySystem_t

Data Fields
const trophyDataList_t *	data	The settings of how the trophies behave.
list_t	trophyQueue	List of trophy updates to display. Holds type trophyDataWrapper_t*.
int	numTrophiesScore	Num of trophies adjusted for difficulty.
trophyData_t	plat	Platinum trophy data.
int32_t	platVal	Value of the platinum trophy.
wsg_t	platImg	Platinum's image.
bool	active	If the mode should be drawing a banner.
int32_t	animTimer	Timer used for sliding in and out.
wsgPalette_t	grayPalette	Grayscale palette for locked trophies.
wsgPalette_t	normalPalette	Normal colors.
trophyDisplayList_t	tdl	Display list data.

packedTrophy_t

struct packedTrophy_t

Data Fields
int	modeIdx: 8
int	trophyIdx: 24

Macro Definition Documentation

DEFAULT_MILESTONE

#define DEFAULT_MILESTONE   25

BANNER_HEIGHT

#define BANNER_HEIGHT   48

BANNER_MAX_ICON_DIM

#define BANNER_MAX_ICON_DIM   36

SCREEN_CORNER_CLEARANCE

#define SCREEN_CORNER_CLEARANCE   19

IMAGE_BUFFER

#define IMAGE_BUFFER   8

NUMBER_TEXT_BUFFER

#define NUMBER_TEXT_BUFFER   25

NUM_COLORS

#define NUM_COLORS   6

Function Documentation

trophySystemInit()

void trophySystemInit	(	const trophyDataList_t *	settings,
		const char *	modeName )

Initializes the Trophy system settings. The system is a global setting and every mode needs to set this when entered to avoid copying from other modes.

Parameters

settings	The settings data
modeName	Name of the mode

trophyUpdate()

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

Updates specifed trophy if required.

Parameters

t	Trophy to update
newVal	New value to try to set. Behavior is set by trophy type
drawUpdate	If this update should be drawn to the screen

Returns

true if a notification is being drawn, false otherwise

trophyUpdateMilestone()

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

Updates just like trophyUpdate(), but only draws when crossing percentage boundary.

Parameters

t	Trophy to update
newVal	Value to attempt to set
threshold	Value (0-100, representing a percent) to draw at

Returns

true if a notification is being drawn, false otherwise

trophyGetSavedValue()

int32_t trophyGetSavedValue

(

const trophyData_t *

t

)

Returns the value saved to the NVS or 0 if the key isn't found.

Parameters

t	Trophy to grab value for

Returns

int32_t Stored value for the requested trophy

trophySetChecklistTask()

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

Sets or unsets a checklist item.

Parameters

t	Trophy to set
flag	Task that was just completed
unset	If we're unsetting the bit
drawUpdate	If this update should be drawn

Returns

true if a notification is being drawn, false otherwise

trophyClear()

void trophyClear

(

const trophyData_t *

t

)

Erases completion data from swadge. Only use in extreme circumstances.

Parameters

t	Trophy to set to 0

checkBitFlag()

bool checkBitFlag	(	int32_t	flags,
		int8_t	idx )

Checks an individual bit flag out of a int32.

Parameters

flags	int32 containing the flag to check
idx	Index of the bit

Returns

true If bit is set

false If bit is not set

setBitFlag()

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

Set a bit flag.

Parameters

flags	pointer to variable to store flags
idx	Index of the bit to set
setTrue	Set to false to unset the

trophyGetPoints()

int trophyGetPoints	(	bool	total,
		const char *	namespace )

Get the point totals for the gamer score.

Parameters

total	If loading the full score or for the current mode
namespace	namespace to load points from. Set to NULL to get currently loaded mode

Returns

int Value of the score

trophyGetLatest()

const trophyData_t * trophyGetLatest

(

void

)

Get the Latest Trophy Idx object.

Returns

trophyData_t data for the latest win. NULL if no trophies have been won yet.

trophySetSystemData()

void trophySetSystemData	(	const trophyDataList_t *	dl,
		const char *	modeName )

Set the Trophy System to a specific mode's values.

Parameters

dl	Data object from the mode
modeName	Name of the mode

isTrophyDrawing()

bool isTrophyDrawing

(

void

)

Check if a trophy is currently being drawn.

Returns

true if a trophy is being drawn, false otherwise

trophyDraw()

void trophyDraw	(	font_t *	fnt,
		int64_t	elapsedUs )

Draws the banner if one is queued.

Parameters

fnt	Font to be used
elapsedUs	Time since last frame

trophyDrawListInit()

void trophyDrawListInit

(

trophyListDisplayMode_t

mode

)

Initialize the trophy Draw list.

Parameters

mode	What display mode to draw

trophyDrawListColors()

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

Set the colors of the panel to custom. Call after initialization of the list, or it'll be overwritten.

Parameters

background	Color of the background behind the panels
panel	The main panel color
shadowBoxes	The check box and image shadowbox colors
dimText	Description text and numbers
titleText	Title of the trophy
checkmark	Color of the checkmark

trophyDrawListDeinit()

void trophyDrawListDeinit

(

void

)

Tears down the WSGs and height list.

trophyDrawList()

void trophyDrawList	(	font_t *	fnt,
		int	yOffset )

Draws the list.

Parameters

fnt	Font to use
yOffset	Current Y offset. Higher numbers effectively scroll down