Difference between revisions of "ClearAllCommands"
(Generated by Sunjammer's Dragon Age Script Paser) |
Axe Murderer (Talk | contribs) m (spelling) |
||
| Line 19: | Line 19: | ||
== 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 == --> | ||
Revision as of 01:41, 25 October 2009
This page was generated by Sunjammer's Dragon Age Script Parser.
The parser was able to extract and/or match all the information required, however it has flagged this page as containing one or more joins. A join occurs when the parser encounters a single line entry (such as parameter descriptions or remarks) which has been split over multiple lines. The parser joins these lines together to prevent the information being omitted, however any original formatting will have been lost.
This page must be reviewed by a knowledgeable scripter as it will probably require updating. If the join occurred in a parameter description it will probably be necessary to move the additional information to the Description section below. Once identified, the issue in the source file should be reported to BioWare.
Please remove the {{Generated with joins}} tag once the page has been corrected.
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
