Difference between revisions of "ClearAllCommands"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (spelling)
m (looks good to me, removing tag)
 
Line 1: Line 1:
{{Generated with joins}}
 
 
{{dafunction
 
{{dafunction
 
|name=ClearAllCommands
 
|name=ClearAllCommands

Latest revision as of 22:17, 9 February 2010

This function clears the command list for a given object

int ClearAllCommands(
object oObject,
int nHardClear = TRUE
);
Parameters:
oObject
the object on which to clear the command list
nHardClear
specifies if the object can finish the action in progress or not (Hard = don't wait)
Returns:

TRUE on success, FALSE on failure

Source:

script.ldf

Description

This function clears the command list for a given object. Note that this also clears the currently executed command which is outside of the queue.

Remarks

Designers should NOT use this function, but use the WR_ClearAllCommands wrapper function instead, defined in wrappers_h