GetIsTrapped(object)

Check whether an object is trapped.

int GetIsTrapped(
    object oObject
);

Parameters

oObject

Placeable, door, or trigger to be checked.


Description

Returns TRUE if oObject is trapped and the trap is active (i.e., it has not been triggered already or disabled).



Remarks

Note: Only placeables, doors and triggers can be trapped.
Function will return FALSE if oObject is not a placeable, door or trigger.


Version

1.22

See Also

functions: GetTrapBaseType | GetTrapCreator | GetTrapDetectable | GetTrapDetectDC | GetTrapDetectedBy | GetTrapDisarmable | GetTrapDisarmDC | GetTrapFlagged | GetTrapKeyTag | GetTrapOneShot
categories: Get Data from Object Functions


 author: Jason Harris, editor: Kristian Markon
 Send comments on this topic.