Home > Reference > Functions > Traps > CreateTrapAtLocation

CreateTrapAtLocation(int, location, float, string, int, string, string)

Creates a square Trap object.

object CreateTrapAtLocation(
    int nTrapType,
    location lLocation,
    float fSize = 2.0f,
    string sTag = "",
    int nFaction = STANDARD_FACTION_HOSTILE,
    string sOnDisarmScript = "",
    string sOnTrapTriggeredScript = ""
);

Parameters

nTrapType

The base type of trap. TRAP_BASE_TYPE_*

lLocation

The location and orientation that the trap will be created at.

fSize

The size of the trap. Minimum size allowed is 1.0f. If no value set, defaults to 2.0f.

sTag

The tag of the trap being created. If no value set, defaults to an empty string.

nFaction

The faction of the trap. STANDARD_FACTION_*

sOnDisarmScript

The OnDisarm script that will fire when the trap is disarmed. If no value set, defaults to an empty string and no script will fire.

sOnTrapTriggeredScript

The OnTrapTriggered script that will fire when the trap is triggered. If no value set, defaults to an empty string and the default OnTrapTriggered script for the trap type specified will fire instead (as specified in the traps.2da).

Description

Creates a square Trap object.

Version

1.67

See Also

functions:	CreateTrapOnObject
categories:	Traps Functions
events:	OnDisarm Event | OnTrapTriggered Event

---

author: Mistress