OrxTrigger

Data Structures
struct	orxTRIGGER_EVENT_PAYLOAD

Macros
#define	orxTRIGGER_KC_SEPARATOR   ':'
#define	orxTRIGGER_KC_STOP_MARKER   '!'

Typedefs
typedef struct __orxTRIGGER_t	orxTRIGGER

Enumerations
enum	orxTRIGGER_EVENT {   orxTRIGGER_EVENT_SET_ADD = 0 , orxTRIGGER_EVENT_SET_REMOVE , orxTRIGGER_EVENT_FIRE , orxTRIGGER_EVENT_NUMBER ,   orxTRIGGER_EVENT_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxTrigger_AddSetFromConfig (orxTRIGGER *_pstTrigger, const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxTrigger_ClearCache ()
orxDLLAPI orxTRIGGER *orxFASTCALL	orxTrigger_Create ()
orxDLLAPI orxSTATUS orxFASTCALL	orxTrigger_Delete (orxTRIGGER *_pstTrigger)
orxDLLAPI void orxFASTCALL	orxTrigger_Enable (orxTRIGGER *_pstTrigger, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxTrigger_Exit ()
orxDLLAPI orxSTATUS orxFASTCALL	orxTrigger_Fire (orxTRIGGER *_pstTrigger, const orxSTRING _zEvent, const orxSTRING *_azRefinementList, orxU32 _u32Count)
orxDLLAPI orxU32 orxFASTCALL	orxTrigger_GetCount (const orxTRIGGER *_pstTrigger)
orxDLLAPI orxSTATUS orxFASTCALL	orxTrigger_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxTrigger_IsEnabled (const orxTRIGGER *_pstTrigger)
orxDLLAPI orxSTATUS orxFASTCALL	orxTrigger_RemoveSetFromConfig (orxTRIGGER *_pstTrigger, const orxSTRING _zConfigID)
orxDLLAPI void orxFASTCALL	orxTrigger_Setup ()

Detailed Description

Trigger module Allows to creates triggers: chained sequence of events

Macro Definition Documentation

orxTRIGGER_KC_SEPARATOR

#define orxTRIGGER_KC_SEPARATOR   ':'

Misc defines

Definition at line 53 of file orxTrigger.h.

orxTRIGGER_KC_STOP_MARKER

#define orxTRIGGER_KC_STOP_MARKER   '!'

Definition at line 54 of file orxTrigger.h.

Typedef Documentation

orxTRIGGER

typedef struct __orxTRIGGER_t orxTRIGGER

Internal Trigger structure

Definition at line 59 of file orxTrigger.h.

Enumeration Type Documentation

orxTRIGGER_EVENT

enum orxTRIGGER_EVENT

Event enum

Enumerator
orxTRIGGER_EVENT_SET_ADD	Event sent when a set is added to a trigger
orxTRIGGER_EVENT_SET_REMOVE	Event sent when a set is removed from a trigger
orxTRIGGER_EVENT_FIRE	Event sent when a trigger fires
orxTRIGGER_EVENT_NUMBER
orxTRIGGER_EVENT_NONE

Definition at line 64 of file orxTrigger.h.

Function Documentation

orxTrigger_AddSetFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxTrigger_AddSetFromConfig ( orxTRIGGER * _pstTrigger, const orxSTRING _zConfigID )

extern

Adds a set to a Trigger from config

Parameters

[in]	_pstTrigger	Concerned Trigger
[in]	_zConfigID	Config ID of the set to add return orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTrigger_ClearCache()

orxDLLAPI orxSTATUS orxFASTCALL orxTrigger_ClearCache ( )

extern

Clears cache (if any Trigger is still in active use, it'll remain in memory until not referenced anymore)

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTrigger_Create()

orxDLLAPI orxTRIGGER *orxFASTCALL orxTrigger_Create ( )

extern

Creates an empty Trigger

Returns

orxTrigger / orxNULL

orxTrigger_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxTrigger_Delete ( orxTRIGGER * _pstTrigger )

extern

Deletes a Trigger

Parameters

[in]

_pstTrigger

Concerned Trigger

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTrigger_Enable()

orxDLLAPI void orxFASTCALL orxTrigger_Enable ( orxTRIGGER * _pstTrigger, orxBOOL _bEnable )

extern

Enables/disables a Trigger

Parameters

[in]	_pstTrigger	Concerned Trigger
[in]	_bEnable	Enable / disable

orxTrigger_Exit()

orxDLLAPI void orxFASTCALL orxTrigger_Exit ( )

extern

Exits from the Trigger module

orxTrigger_Fire()

orxDLLAPI orxSTATUS orxFASTCALL orxTrigger_Fire ( orxTRIGGER * _pstTrigger, const orxSTRING _zEvent, const orxSTRING * _azRefinementList, orxU32 _u32Count )

extern

Fire a Trigger's event

Parameters

[in]	_pstTrigger	Concerned Trigger
[in]	_zEvent	Event to fire
[in]	_azRefinementList	List of refinements for this event, unused if _u32Count == 0
[in]	_u32Count	Number of refinements in the list, 0 for none

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTrigger_GetCount()

orxDLLAPI orxU32 orxFASTCALL orxTrigger_GetCount ( const orxTRIGGER * _pstTrigger )

extern

Gets how many sets are defined in the trigger

Parameters

[in]

_pstTrigger

Concerned Trigger

Returns

Count of sets defined in the trigger

orxTrigger_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxTrigger_Init ( )

extern

Inits the Trigger module

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTrigger_IsEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxTrigger_IsEnabled ( const orxTRIGGER * _pstTrigger )

extern

Is Trigger enabled?

Parameters

[in]

_pstTrigger

Concerned Trigger

Returns

orxTRUE if enabled, orxFALSE otherwise

orxTrigger_RemoveSetFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxTrigger_RemoveSetFromConfig ( orxTRIGGER * _pstTrigger, const orxSTRING _zConfigID )

extern

Removes a set from a Trigger using its config ID

Parameters

[in]	_pstTrigger	Concerned Trigger
[in]	_zConfigID	Config ID of the set to remove

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTrigger_Setup()

orxDLLAPI void orxFASTCALL orxTrigger_Setup ( )

extern

Trigger module setup