Difference between revisions of "Safe Destroy Object"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (Created page with '{{dafunction |name=DestroyObject |brief= Safe Wrapper for DestroyObject |param1type=object |param1name=oObject |param1desc=Object to destroy |param1default= |param2type=int |para...') |
m (Fixing name, adding description) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name= | + | |name = Safe_Destroy_Object |
| − | |brief= Safe | + | |brief = Safe wrapper for [[DestroyObject]]. |
| − | |param1type=object | + | |param1type = object |
| − | |param1name=oObject | + | |param1name = oObject |
| − | |param1desc= | + | |param1desc = object to destroy |
| − | |param1default= | + | |param1default = |
| − | |param2type=int | + | |param2type = int |
| − | |param2name=nDelayMs | + | |param2name = nDelayMs |
| − | |param2desc= | + | |param2desc = time in milliseconds to delay the destruction of the object, default is for immediate destruction |
| − | |param2default=0 | + | |param2default = 0 |
| − | |returntype=void | + | |returntype = void |
| − | |returndesc= | + | |returndesc = |
| − | |sourcefile=core_h | + | |sourcefile = core_h |
| − | |sourcemodule= | + | |sourcemodule = Core Game Resources |
}} | }} | ||
| − | + | == 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. --> | ||
| − | + | Destroys the specified object unless it is a party member; is plot or is immortal. | |
== Remarks == | == Remarks == | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | + | The reason for this function: there were accidents where creatures would deplete themselves as Ammo because people were not paying attention. | |
| − | The reason for this function: | + | |
| − | + | ||
<!-- == 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. --> | ||
[[CreateObject]], [[DestroyObject]] | [[CreateObject]], [[DestroyObject]] | ||
| − | [[Category: Object functions]] | + | [[Category:Object functions]] |
Latest revision as of 19:40, 8 August 2011
Safe wrapper for DestroyObject.
- Parameters:
- oObject
- object to destroy
- nDelayMs
- time in milliseconds to delay the destruction of the object, default is for immediate destruction
- Returns:
- Nothing.
- Source:
- Core Game Resources.core_h
Description
Destroys the specified object unless it is a party member; is plot or is immortal.
Remarks
The reason for this function: there were accidents where creatures would deplete themselves as Ammo because people were not paying attention.
