Difference between revisions of "WR ClearAllCommands"
From Dragon Age Toolset Wiki
m (Removed redundant category) |
m (Fixing source) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name = WR_ClearAllCommands | + | |name = WR_ClearAllCommands |
| − | |brief = This function clears the command list for a given object | + | |brief = This function clears the command list for a given object |
| − | |param1type = object | + | |param1type = object |
| − | |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 = | |param1default = | ||
| − | |param2type = int | + | |param2type = int |
| − | |param2name = bHardClear | + | |param2name = bHardClear |
| − | |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 = FALSE | |param2default = FALSE | ||
| − | + | |returntype = int | |
| − | |returntype = int | + | |returndesc = TRUE on success, FALSE on failure |
| − | |returndesc = TRUE on success, FALSE on failure | + | |sourcefile = wrappers_h |
| − | |sourcefile = wrappers_h | + | |sourcemodule = Core Game Resources |
| − | |sourcemodule = Core Resources | + | |
}} | }} | ||
| − | |||
<!-- == 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. --> | ||
| − | |||
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | |||
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| − | |||
<!-- == See also == --> | <!-- == See also == --> | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
[[Category:Commands functions]] | [[Category:Commands functions]] | ||
Latest revision as of 14:06, 27 March 2012
This function clears the command list for a given object
- Parameters:
- oObject
- the object on which to clear the command list
- bHardClear
- specifies if the object can finish the action in progress or not (Hard = don't wait)
- Returns:
- TRUE on success, FALSE on failure
- Source:
- Core Game Resources.wrappers_h
