Difference between revisions of "ClearAmbientDialogs"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
BryanDerksen (Talk | contribs) m (looks okay, removing tag) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=ClearAmbientDialogs | |name=ClearAmbientDialogs | ||
| Line 6: | Line 5: | ||
|param1name=oObject | |param1name=oObject | ||
|param1desc=the object on which to clear ambient dialogs or OBJECT_INVALID to clear all | |param1desc=the object on which to clear ambient dialogs or OBJECT_INVALID to clear all | ||
| + | |param1default=OBJECT_INVALID | ||
|returntype=int | |returntype=int | ||
|returndesc=TRUE on success, FALSE on failure | |returndesc=TRUE on success, FALSE on failure | ||
| Line 14: | Line 14: | ||
== 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 all ambient dialogs for a given object or for all objects | + | |
| − | if OBJECT_INVALID is passed in | + | This function clears all ambient dialogs for a given object or for all objects if OBJECT_INVALID is passed in. |
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Latest revision as of 18:44, 19 February 2010
This function clears all ambient dialogs for a given object or for all objects
- Parameters:
- oObject
- the object on which to clear ambient dialogs or OBJECT_INVALID to clear all
- Returns:
- TRUE on success, FALSE on failure
- Source:
- script.ldf
Description
This function clears all ambient dialogs for a given object or for all objects if OBJECT_INVALID is passed in.
