Cavestory Mod API
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | List of all members
CaveNet::DataStructures::NetScoreType Class Reference

Score type. More...

#include <CaveNet_ExportedTypes.h>

Public Member Functions

 NetScoreType ()
 Constructor.
 
 ~NetScoreType ()
 Deconstructor.
 
void Init ()
 Initialize this mode.
 
bool BuildUIString (CaveNet::DataStructures::NetClient *pClient, NetScoreInstance *pInstance, char *pOutBuffer, unsigned int iBufferSize, const char *pStatHexColor=NULL, const char *pDynamicFormatAdd=NULL)
 Build the UI string. More...
 

Public Attributes

NetScoreTypegNext
 Next object in the linkage.
 
NetScoreTypegPrev
 Previous object in the linkage.
 
char * m_Name
 The name of this score type.
 
char * m_DispFormatName
 The display format of this type.
 
char * m_DispFormatDynamic
 The display format of this type.
 
unsigned int m_NameHash
 The hash of this type's name.
 
CSM_NetScore_GetScoreModifyAmount m_GetScoreFunc
 A pointer to the function that will calculate the amount of score to be modified.
 
unsigned long long int m_MaskBits
 This type's mask bits. More...
 
unsigned long long int m_Flags
 This type's flags. More...
 

Static Public Attributes

static NetScoreTypegFirst
 First object in the linkage.
 

Protected Member Functions

bool operator< (const NetScoreType &other) const
 
bool operator<= (const NetScoreType &other) const
 
bool operator> (const NetScoreType &other) const
 
bool operator>= (const NetScoreType &other) const
 
bool operator!= (const NetScoreType &other) const
 
bool operator== (const NetScoreType &other) const
 

Detailed Description

Score type.

Holds information for events that contribute / impede a client's overall score.

Member Function Documentation

◆ BuildUIString()

bool CaveNet::DataStructures::NetScoreType::BuildUIString ( CaveNet::DataStructures::NetClient pClient,
NetScoreInstance pInstance,
char *  pOutBuffer,
unsigned int  iBufferSize,
const char *  pStatHexColor = NULL,
const char *  pDynamicFormatAdd = NULL 
)

Build the UI string.

Parameters
pClientThe client to use in calculating the buffer contents.
pInstanceThe instance to use in calculating the buffer contents.
pOutBufferThe buffer that will hold the formatted string.
iBufferSizeThe size of pOutBuffer.
pStatHexColorIf this is not NULL, it will be used as the color for statistic values. Must be formatted like "FF0000".
pDynamicFormatAddIf this is not NULL, it will use m_DispFormatDynamic as the format string and substitute "%s" with pDynamicFormatAdd.

Member Data Documentation

◆ m_Flags

unsigned long long int CaveNet::DataStructures::NetScoreType::m_Flags

This type's flags.

See also
NetScoreTypeFlags

◆ m_MaskBits

unsigned long long int CaveNet::DataStructures::NetScoreType::m_MaskBits

This type's mask bits.

See also
NetScoreMaskBits

The documentation for this class was generated from the following file: