Category:Traps Functions

From NWN Lexicon
Jump to: navigation, search

Traps Function Category

Functions that deal with traps.



Functions

Name Brief Description

CreateTrapAtLocation

Creates a square Trap object.

CreateTrapOnObject

Creates a Trap on the object specified. Works on doors and placeables only.

EffectAreaOfEffect

Returns a new effect object.

GetEnteringObject

Gets the object that last opened or entered the calling object.

GetExitingObject

Get the object that last left the calling object.

GetLastDisarmed

Determine who last disarmed a trapped trigger, door or placeable object.

GetLastTrapDetected

Determines the trap last detected by the PC.

GetNearestTrapToObject

Determines the closest trap from a creature or object.

GetProjectileTrapOrigin

Gets the origin for a projectile trap.

GetTrapActive

Determines if a trap is active.

GetTrapBaseType

Determines the type (i.e. frost, spike, etc.) of a trap.

GetTrapCreator

Returns the name of the creature that set the specific trap.

GetTrapDetectable

Determines if the specific trap has been set as detectable or not by the toolset.

GetTrapDetectDC

Determines the DC required to detect the specific trap.

GetTrapDetectedBy

Determines whether a creature has detected a specific trap.

GetTrapDisarmable

Determines if the specific trap is capable of being disarmed.

GetTrapDisarmDC

Determines the DC for the trap to be disarmed.

GetTrapFlagged

Determine if a specific trap has been set as visible to all creatures.

GetTrapKeyTag

Determines the identifier of the key required to disarm the specific trap.

GetTrapOneShot

Determines if the trap was designated as only going off once.

GetTrapRecoverable

Determines if a trap is recoverable.

SetTrapActive

Sets whether or not the trap is an active trap.

SetTrapDetectable

Sets whether or not the trap on an object can be detected.

SetTrapDetectDC

Set the DC for detecting the trap.

SetTrapDetectedBy

Makes a trap detected by a creature.

SetTrapDisabled

Disables the trap on the specified object.

SetTrapDisarmable

Sets whether or not the trap on an object can be disarmed.

SetTrapDisarmDC

Set the DC for disarming object.

SetTrapKeyTag

Set the tag of the key that will disarm the trap.

SetTrapOneShot

Sets whether or not the trap is a one-shot trap. Meaning whether or not the trap resets itself after firing.

SetTrapRecoverable

Sets whether or not the trap on an object can be recovered.

TrapDoElectricalDamage

Function for doing electrical traps.

TriggerProjectileTrap

Causes an origin object to fire a specified spell at a target.

VersusTrapEffect

Modifies an effect so that it only works against traps.