GetFirstObjectInArea(object)

Determines the first object in an area.

object GetFirstObjectInArea(
    object oArea = OBJECT_INVALID
);

Parameters

oArea

The area that contains the objects. (Default: OBJECT_INVALID)


Description

Returns the first object in oArea and OBJECT_INVALID if no objects exists or on any error.

If no valid area is specified, it will use the caller's area.



Remarks

Does not locate objects that are encounters. Encounters must be located directly by their tag.


Known Bugs

Creatures possessed by a DM are skipped.


Version

1.29

See Also

functions: GetNextObjectInArea
categories: Area Functions


 author: Tom Cassiotis, editor: Charles Feduke, additional contributor(s): Enigmatic, Jazael
 Send comments on this topic.