Anvil
Loading...
Searching...
No Matches
Anvil.API.Events.OnTrapSet Class Referencesealed

Called when a creature attempts to set a trap. More...

+ Inheritance diagram for Anvil.API.Events.OnTrapSet:
+ Collaboration diagram for Anvil.API.Events.OnTrapSet:

Classes

class  Factory
 

Properties

NwCreature Creature = null! [get]
 Gets the creature performing the trap action.
 
bool InRange [get]
 Gets if the creature is in range of the trap.
 
ActionState Result [get]
 Gets the result of this trap event. This value is only valid in the after event.
 
ActionState? ResultOverride [get, set]
 Gets or sets a value to override the trap action result, skipping the default game behaviour.
Supported values: ActionState.Complete, ActionState.Failed.
 
Location TargetLocation = null! [get]
 Gets the location where the trap will be set.
 
NwGameObjectTargetObject [get]
 Gets the target object for the trap if the trap is set on a door/placeable.
 
- Properties inherited from Anvil.API.Events.IEvent

Detailed Description

Called when a creature attempts to set a trap.

Property Documentation

◆ TargetObject

NwGameObject? Anvil.API.Events.OnTrapSet.TargetObject
get

Gets the target object for the trap if the trap is set on a door/placeable.

This property is null if the trap is set on the ground as a new trigger.


The documentation for this class was generated from the following file: