Cavestory Mod API
Functions
Flags

Functions

CAVESTORY_MOD_API void SetNPCFlag (long iFlagNo, bool bTransmit=true)
 Set an NPC flag to 'true'. More...
 
CAVESTORY_MOD_API void CutNPCFlag (long iFlagNo, bool bTransmit=true)
 Set an NPC flag to 'false'. More...
 
CAVESTORY_MOD_API BOOL GetNPCFlag (long iFlagNo)
 Check if an NPC flag is set. More...
 
CAVESTORY_MOD_API void SetSkipFlag (long iFlagNo, bool bTransmit=true)
 Set a skip flag to 'true'. More...
 
CAVESTORY_MOD_API void CutSkipFlag (long iFlagNo, bool bTransmit=true)
 Set a skip flag to 'true'. More...
 
CAVESTORY_MOD_API BOOL GetSkipFlag (long iFlagNo)
 Check if a skip flag is set. More...
 

Detailed Description

Function Documentation

◆ CutNPCFlag()

CAVESTORY_MOD_API void CutNPCFlag ( long  iFlagNo,
bool  bTransmit = true 
)

Set an NPC flag to 'false'.

Parameters
iFlagNoThe flag number.
bTransmitWhether to transmit the change to the entire server or not.

◆ CutSkipFlag()

CAVESTORY_MOD_API void CutSkipFlag ( long  iFlagNo,
bool  bTransmit = true 
)

Set a skip flag to 'true'.

Parameters
iFlagNoThe flag number.
bTransmitWhether to transmit the change to the entire server or not.

◆ GetNPCFlag()

CAVESTORY_MOD_API BOOL GetNPCFlag ( long  iFlagNo)

Check if an NPC flag is set.

Parameters
iFlagNoThe flag number.
Returns
Returns TRUE if the NPC flag is set, FALSE if it isn't.

◆ GetSkipFlag()

CAVESTORY_MOD_API BOOL GetSkipFlag ( long  iFlagNo)

Check if a skip flag is set.

Parameters
iFlagNoThe flag number.
Returns
Returns TRUE if the skip flag is set, FALSE if it isn't.

◆ SetNPCFlag()

CAVESTORY_MOD_API void SetNPCFlag ( long  iFlagNo,
bool  bTransmit = true 
)

Set an NPC flag to 'true'.

Parameters
iFlagNoThe flag number.
bTransmitWhether to transmit the change to the entire server or not.

◆ SetSkipFlag()

CAVESTORY_MOD_API void SetSkipFlag ( long  iFlagNo,
bool  bTransmit = true 
)

Set a skip flag to 'true'.

Parameters
iFlagNoThe flag number.
bTransmitWhether to transmit the change to the entire server or not.