GS5 Action Object. More...

Inheritance diagram for gs::TGSAction:

Collaboration diagram for gs::TGSAction:

Public Member Functions
Properties
const char *	name ()
	Gets action name.

action_id_t	id ()
	Gets action unique id.

const char *	description ()
	Gets action description.

const char *	whatToDo ()
	Gets action what-to-do string (ref: What to do action string)

Inspect action's parameters
int	paramCount ()
	Gets the total number of action parameters.

TGSVariable *	getParamByIndex (int index)
	Gets action parameter by its index. More...

TGSVariable *	getParamByName (const char *name)
	Gets action parameter by its name. More...

Public Member Functions inherited from gs::TGSObject
gs_handle_t	handle () const
	Gets GS5 object handle.

Detailed Description

GS5 Action Object.

Member Function Documentation

TGSVariable * gs::TGSAction::getParamByIndex ( int index )

Gets action parameter by its index.

Parameters

index the index of parameter, range [0, paramCount()-1 ]

TGSVariable * gs::TGSAction::getParamByName ( const char * name )

Gets action parameter by its name.

Parameters

name	the string name of a action parameter.