Cavestory Mod API
Public Attributes | List of all members
MYCHAR_STATE_INFO Struct Reference

Player state information. More...

#include <CSMAPI_types.h>

Public Attributes

char * StateName
 The name of this player state.
 
PlayerState_ActFuncType ActFunc
 The act function for this player state. More...
 
PlayerState_AnimFuncType AnimFunc
 The animation function for this player state. More...
 
PlayerState_DrawFuncType DrawFunc
 The draw function for this player state. More...
 
PlayerStateAnimator_OutputType AnimateRetType
 The return type of the animate function.
 
unsigned long long int Flags
 The flags for this player state. More...
 
unsigned int TransmitFlags
 The transmit flags for this player state. More...
 
MYCHAR_STATE_ARG_INFOArgList
 The custom argument list for this player state.
 
bool LoadedByMod
 Whether this was loaded / overloaded by the currently loaded mod or not.
 

Detailed Description

Player state information.

Member Data Documentation

◆ ActFunc

PlayerState_ActFuncType MYCHAR_STATE_INFO::ActFunc

The act function for this player state.

Parameters
bKeyWhether key inputs should be allowed for this tick or not.
pInterfaceThe safe interface for this player.
pMCThe player character we should be manipulating.
pPhysicsThe physics we should be using for this tick. If the player is in water, this will be pMC->physics_underwater. If not, then it will be pMC->physics_normal.

◆ AnimFunc

PlayerState_AnimFuncType MYCHAR_STATE_INFO::AnimFunc

The animation function for this player state.

Parameters
bKeyWhether key inputs should be allowed for this tick or not.
pMCThe player character we should be manipulating.
pInterfaceThe safe interface for this player.
Returns
Should return a value corresponding to the set AnimateRetType value. This will be set as the current player animation.

◆ DrawFunc

PlayerState_DrawFuncType MYCHAR_STATE_INFO::DrawFunc

The draw function for this player state.

Parameters
iFrameXThe camera X offset.
iFrameYThe camera Y offset.
pMCThe player character we should be manipulating.
pInterfaceThe interface for this player.

◆ Flags

unsigned long long int MYCHAR_STATE_INFO::Flags

The flags for this player state.

See also
PLAYER_STATE_FLAGS

◆ TransmitFlags

unsigned int MYCHAR_STATE_INFO::TransmitFlags

The transmit flags for this player state.

See also
PLAYER_STATE_TRANSMIT_FLAGS

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