orxCommand.h File Reference

#include "orxInclude.h"
#include "math/orxVector.h"

Go to the source code of this file.

Data Structures
struct	orxCOMMAND_VAR
struct	orxCOMMAND_VAR_DEF

Macros
#define	orxCOMMAND_KC_BLOCK_MARKER   '"'
#define	orxCOMMAND_KC_GUID_MARKER   '^'
#define	orxCOMMAND_KC_POP_MARKER   '<'
#define	orxCOMMAND_KC_PUSH_MARKER   '>'
#define	orxCOMMAND_KC_SEPARATOR   ','
#define	orxCOMMAND_REGISTER(NAME, FUNCTION, RESULT_NAME, RESULT_TYPE, REQ_PARAM_NUMBER, OPT_PARAM_NUMBER, ...)
#define	orxCOMMAND_REGISTER_CORE_COMMAND(MODULE, COMMAND, RESULT_NAME, RESULT_TYPE, REQ_PARAM_NUMBER, OPT_PARAM_NUMBER, ...)
#define	orxCOMMAND_UNREGISTER(NAME)
#define	orxCOMMAND_UNREGISTER_CORE_COMMAND(MODULE, COMMAND)

Typedefs
typedef void(orxFASTCALL *	orxCOMMAND_FUNCTION) (orxU32 _u32ArgNumber, const orxCOMMAND_VAR *_astArgList, orxCOMMAND_VAR *_pstResult)

Enumerations
enum	orxCOMMAND_VAR_TYPE {   orxCOMMAND_VAR_TYPE_STRING = 0 , orxCOMMAND_VAR_TYPE_FLOAT , orxCOMMAND_VAR_TYPE_S32 , orxCOMMAND_VAR_TYPE_U32 ,   orxCOMMAND_VAR_TYPE_S64 , orxCOMMAND_VAR_TYPE_U64 , orxCOMMAND_VAR_TYPE_BOOL , orxCOMMAND_VAR_TYPE_VECTOR ,   orxCOMMAND_VAR_TYPE_NUMERIC , orxCOMMAND_VAR_TYPE_NUMBER , orxCOMMAND_VAR_TYPE_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxCommand_AddAlias (const orxSTRING _zAlias, const orxSTRING _zCommand, const orxSTRING _zArgs)
orxDLLAPI orxCOMMAND_VAR *orxFASTCALL	orxCommand_Evaluate (const orxSTRING _zCommandLine, orxCOMMAND_VAR *_pstResult)
orxDLLAPI orxCOMMAND_VAR *orxFASTCALL	orxCommand_EvaluateWithGUID (const orxSTRING _zCommandLine, orxU64 _u64GUID, orxCOMMAND_VAR *_pstResult)
orxDLLAPI orxCOMMAND_VAR *orxFASTCALL	orxCommand_Execute (const orxSTRING _zCommand, orxU32 _u32ArgNumber, const orxCOMMAND_VAR *_astArgList, orxCOMMAND_VAR *_pstResult)
orxDLLAPI void orxFASTCALL	orxCommand_Exit ()
orxDLLAPI const orxSTRING orxFASTCALL	orxCommand_GetNext (const orxSTRING _zBase, const orxSTRING _zPrevious, orxU32 *_pu32CommonLength)
orxDLLAPI const orxSTRING orxFASTCALL	orxCommand_GetPrototype (const orxSTRING _zCommand)
orxDLLAPI orxSTATUS orxFASTCALL	orxCommand_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxCommand_IsAlias (const orxSTRING _zAlias)
orxDLLAPI orxBOOL orxFASTCALL	orxCommand_IsRegistered (const orxSTRING _zCommand)
orxDLLAPI orxSTATUS orxFASTCALL	orxCommand_ParseNumericalArguments (orxU32 _u32ArgNumber, const orxCOMMAND_VAR *_astArgList, orxCOMMAND_VAR *_astOperandList)
orxDLLAPI orxU32 orxFASTCALL	orxCommand_PrintVar (orxSTRING _zDstString, orxU32 _u32Size, const orxCOMMAND_VAR *_pstVar)
orxDLLAPI orxSTATUS orxFASTCALL	orxCommand_Register (const orxSTRING _zCommand, const orxCOMMAND_FUNCTION _pfnFunction, orxU32 _u32RequiredParamNumber, orxU32 _u32OptionalParamNumber, const orxCOMMAND_VAR_DEF *_astParamList, const orxCOMMAND_VAR_DEF *_pstResult)
orxDLLAPI orxSTATUS orxFASTCALL	orxCommand_RemoveAlias (const orxSTRING _zAlias)
orxDLLAPI void orxFASTCALL	orxCommand_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxCommand_Unregister (const orxSTRING _zCommand)

Detailed Description

Date

29/04/2012

Author

iarwa.nosp@m.in@o.nosp@m.rx-pr.nosp@m.ojec.nosp@m.t.org

Definition in file orxCommand.h.