Cavestory Mod API
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
ModTextScriptCommand Class Reference

Automatically sets up every textscript command in the mod after calling ModTextScriptCommand::Init(). More...

#include <ModTextScriptCommand.h>

Public Types

typedef void(* TSCRunFunc) (int &x, int &y, int &z, int &w, bool &bExit, int &iError)
 Run a TextScriptCommand object's code. More...
 

Public Member Functions

 ModTextScriptCommand ()
 Blank constructor, for sorted bin list.
 
 ModTextScriptCommand (TSCRunFunc pCommand, char pFirst, char pSecond, char pThird, const char *pShortDesc, const char *pDesc, const char *pArgs)
 Constructor.
 
 ~ModTextScriptCommand ()
 Deconstructor.
 

Static Public Member Functions

static void Init ()
 Initialize the text script commands.
 

Public Attributes

char mCommand [4]
 This command's identifier.
 
char * mShortDesc
 This command's shorthand descriptor.
 
char * mDesc
 This command's descriptor.
 
char * mArguments
 This command's arguments.
 

Protected Attributes

TSCRunFunc mExecute
 Execute function.
 

Detailed Description

Automatically sets up every textscript command in the mod after calling ModTextScriptCommand::Init().

Member Typedef Documentation

◆ TSCRunFunc

typedef void(* ModTextScriptCommand::TSCRunFunc) (int &x, int &y, int &z, int &w, bool &bExit, int &iError)

Run a TextScriptCommand object's code.

Parameters
xX value.
yY value.
zZ value.
wW value.
iErrorThe error code. Don't mess with it if there is no error.

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