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, placeable, or creature considerably. It is meant to protect the item, placeable, or creature from death or destruction. It also has an affect on the AI of a creature. A creature that is plot will not turn hostile against others, for instance. It will still attack those that it was hostile against at the time of becoming plot, though. Also, attacking a plot creature can actually cause it to strike back at you, and then your only solution is to run away and wait for the plot creature to exit combat mode. A plot object does not take any damage and plot items cannot be sold.

Version

1.61

See Also

functions:	GetImmortal | SetPlotFlag
categories:	Get Data from Object Functions

---

 author: Tom Cassiotis, editor: Lilac Soul