GetPlotFlag(object)

Determines whether an object is flagged as plot item.

int GetPlotFlag(
    object oTarget = OBJECT_SELF
);

Parameters

oTarget

The object to determine whether it is a plot. (Default: OBJECT_SELF)


Description

Returns TRUE if oTarget is a plot object, otherwise FALSE.



Remarks

A plot flag affects an item or creature considerably. It is meant to protect the item or creature from death or destruction. It also has an affect on the AI of a creature. A creature with the plot flag for example will not attack another creature even if the plot creature considers another creature an enemy. A plot object does not take any damage and cannot be sold or lost.


Version

1.22

See Also

functions: SetPlotFlag
categories: Get Data from Object Functions


 author: Tom Cassiotis
 Send comments on this topic.