AddCommand

From Dragon Age Toolset Wiki
Jump to: navigation, search

This function adds the specified command to the object.

int AddCommand(
object oObject,
command cCommand,
int bAddToFront = FALSE,
int bStatic = FALSE,
int nOverrideAddBehavior = -1
);
Parameters:
oObject
the object to add the specified command
cCommand
the command to add to the object
bAddToFront
specifies if the command should be added to the front of the queue or not
bStatic
whether or not the command will be added as a static command. Static commands are flagged in a special manner and cannot be removed via regular clearing functionality. An override must specifically be specified to remove static commands. As such, commands should only be specified as static if they absolutely must finish
nOverrideAddBehavior
replace the default add behavior by specifying a new behavior here
Returns:

TRUE on success, FALSE on failure

Source:

script.ldf

Description

This function adds the specified command to the object command queue. The command can be added to the back of the queue or to the front, and can also be flagged as static (must-finish command).

Remarks

Any duplicate commands in the queue that are adjacent to one another are deleted.