IsObjectValid

From Dragon Age Toolset Wiki
Revision as of 02:40, 29 July 2009 by Sunjammer (Talk | contribs) (Generated by Sunjammer's Dragon Age Script Paser)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.

Determines if an object exists and is valid.

int IsObjectValid(
object oObject
);
Parameters:
oObject
The object which may be valid
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.