Difference between revisions of "ClearAllCommands"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) m (looks good to me, removing tag) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=ClearAllCommands | |name=ClearAllCommands | ||
| Line 6: | Line 5: | ||
|param1name=oObject | |param1name=oObject | ||
|param1desc=the object on which to clear the command list | |param1desc=the object on which to clear the command list | ||
| + | |param1default= | ||
|param2type=int | |param2type=int | ||
|param2name=nHardClear | |param2name=nHardClear | ||
|param2desc=specifies if the object can finish the action in progress or not (Hard = don't wait) | |param2desc=specifies if the object can finish the action in progress or not (Hard = don't wait) | ||
| + | |param2default=TRUE | ||
|returntype=int | |returntype=int | ||
|returndesc=TRUE on success, FALSE on failure | |returndesc=TRUE on success, FALSE on failure | ||
| Line 17: | Line 18: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | This function clears the command list for a given object. Note that this also | + | 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. |
| − | the currently executed command which is outside of the queue. | + | |
== Remarks == | == Remarks == | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | Designers should NOT use this function, but use the WR_ClearAllCommands wrapper function instead, defined in wrappers_h | + | Designers should NOT use this function, but use the [[WR_ClearAllCommands]] wrapper function instead, defined in [[wrappers_h]] |
<!-- == Examples == --> | <!-- == Examples == --> | ||
Latest revision as of 22:17, 9 February 2010
This function clears the command list for a given object
- 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
