Difference between revisions of "IsObjectValid"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) (looks good to me) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=IsObjectValid | |name=IsObjectValid | ||
| Line 5: | Line 4: | ||
|param1type=object | |param1type=object | ||
|param1name=oObject | |param1name=oObject | ||
| − | |param1desc=The object which | + | |param1desc=The object which is to be tested for validity. |
|returntype=int | |returntype=int | ||
|returndesc=Returns TRUE if the object exists and is valid, FALSE otherwise. | |returndesc=Returns TRUE if the object exists and is valid, FALSE otherwise. | ||
Latest revision as of 22:44, 30 July 2009
Determines if an object exists and is valid.
- Parameters:
- oObject
- The object which is to be tested for validity.
- Returns:
- Returns TRUE if the object exists and is valid, FALSE otherwise.
- Source:
- script.ldf
Description
Returns TRUE if the object oObject exists and is a valid object, FALSE otherwise.
Remarks
This function is very similiar to checking whether an object is not equal to the OBJECT_INVALID constant, but this is a more robust check. An object that has been passed as a paramater in a delayed function call or has been stored as a local object will not equal the OBJECT_INVALID constant if the object has been destroyed since it was stored or passed. This function however will return FALSE in those circumstances. There is no instance where an object is equal to the OBJECT_INVALID constant and this function will return TRUE.
