A trappable game object/entity. More...

Inheritance diagram for Anvil.API.NwTrappable:

Collaboration diagram for Anvil.API.NwTrappable:

Public Member Functions

void DisableTrap ()

Disables this trap as if a creature disarmed it (calling the OnDisarm event respectively).

async Task< NwCreature?> GetLastDisarmedBy ()

Gets the creature who last disarmed the trap on this object.

bool IsTrapDetectedBy (NwCreature creature)

Gets if the specified creature can see this trap.

void SetTrapDetectedBy (bool detected, params NwCreature[] creatures)

Sets the detected state for this trap for the given creatures.

Public Member Functions inherited from Anvil.API.NwGameObject

async Task ActionCastSpellAt (NwSpell spell, Location target, MetaMagic metaMagic=MetaMagic.Any, bool cheat=false, ProjectilePathType projectilePathType=ProjectilePathType.Default, bool instant=false, NwClass? spellClass=null, bool spontaneousCast=false, int domainLevel=0)

Casts a spell at an location.

async Task ActionCastSpellAt (NwSpell spell, NwGameObject target, MetaMagic metaMagic=MetaMagic.Any, bool cheat=false, int domainLevel=0, ProjectilePathType projectilePathType=ProjectilePathType.Default, bool instant=false, NwClass? spellClass=null, bool spontaneousCast=false)

Casts a spell at an object.

async Task ActionJumpToLocation (Location location)

Jumps this object to the specified location.
Unlike the Location setter, this method will compute a safe location when teleporting, and may not equal the location specified.

async Task ActionWait (TimeSpan duration)

Instructs this object to do nothing for the specified duration, before continuing with the next item in the action queue.

void ApplyEffect (EffectDuration durationType, Effect effect, TimeSpan duration=default)

Applies the specified effect to this game object.

void ClearObjectAnimationOverride (string anim)

Clears the specified animation override, restoring the original.

NwGameObject Clone (Location location, string? newTag=null, bool copyLocalState=true)

Creates a copy of this game object.

virtual void Destroy ()

Destroys this object (irrevocably).

float Distance (NwGameObject target)

Returns the distance to the target.
If you only need to compare the distance, you can compare the squared distance using DistanceSquared to avoid a costly sqrt operation.

float DistanceSquared (NwGameObject target)

Returns the squared distance to the target.

async Task EndConversation ()

Immediately ends this GameObject's current conversation.

void FaceToObject (NwGameObject target)

Rotates this object to face towards target.

virtual void FaceToPoint (Vector3 point)

Rotates this object to face a position.

int GetColor (ColorChannel colorChannel)

Gets the color for the specified color channel.

IEnumerable< NwCreature > GetNearestCreatures ()

Returns the creatures closest to this object.

IEnumerable< NwCreature > GetNearestCreatures (CreatureTypeFilter filter1)

Returns the creatures closest to this object, matching the specified criteria.

IEnumerable< NwCreature > GetNearestCreatures (CreatureTypeFilter filter1, CreatureTypeFilter filter2)

Returns the creatures closest to this object, matching all of the specified criteria.

IEnumerable< NwCreature > GetNearestCreatures (CreatureTypeFilter filter1, CreatureTypeFilter filter2, CreatureTypeFilter filter3)

Returns the creatures closest to this object, matching all of the specified criteria.

IEnumerable< T > GetNearestObjectsByType< T > ()

Gets the nearest object that is of the specified type.

VisualTransform GetVisualTransform (ObjectVisualTransformDataScope scope)

Gets the visual transform of this object for the specified scope.

bool HasLineOfSight (NwGameObject target)

Gets whether this object has a direct line of sight to the specified object (not blocked by any geometry).

override? Guid PeekUUID ()

async Task PlayAnimation (Animation animation, float animSpeed, bool queueAsAction=false, TimeSpan duration=default)

Plays the specified animation.

async Task PlaySound (string soundName)

Plays the specified sound as mono audio from the location of this object.

async Task PlaySoundByStrRef (StrRef strRef, bool runAsAction=true)

Plays a sound associated with a string reference (strRef).
The sound comes out as a mono sound sourcing from the location of the object running the command.
If runAsAction is False, then the sound is played instantly.

void RemoveEffect (Effect effect)

Removes the specified effect from this game object.

void ReplaceObjectAnimation (string anim, string newAnim)

Replaces the specified animation with an override.
Use ClearObjectAnimationOverride to clear the override.

void ReplaceObjectTexture (string texture, string newTexture)

Replaces the specified texture with a new texture on this object only.

void ResetMaterialShaderUniforms ()

Resets all material shader parameter overrides on this object.

void ResetMaterialShaderUniforms (string material)

Resets all material shader parameter overrides for the specified material on this object.

Parameters

material The material on the object to be reset.

void ResetMaterialShaderUniforms (string material, string param)

Resets the specified material shader parameter override for the specified material.

Parameters

material	The material on the object to be reset.
param	The parameter override to reset.

SavingThrowResult RollSavingThrow (SavingThrow savingThrow, int dc, SavingThrowType saveType, NwGameObject? saveVs=null)

Performs a saving throw against the given dc.

byte?[] Serialize ()

void SetColor (ColorChannel colorChannel, int newColor)

Sets the color for the specified color channel.

void SetFacing (float facing)

Rotates this object to face the specified facing angle.

void SetIsDestroyable (bool destroyable, bool raiseable=true, bool selectableWhenDead=false)

void SetListenPattern (string pattern, int patternNumber)

Sets a listen pattern for this object, assigning a pattern number that is accessible from the related object's OnConversation event.

void SetMaterialShaderUniform (string material, string param, float value)

Sets a material shader uniform override.

void SetMaterialShaderUniform (string material, string param, int value)

Sets a material shader uniform override.

void SetMaterialShaderUniform (string material, string param, Vector4 value)

Sets a material shader uniform override.

void SetTextBubbleOverride (ObjectUiTextBubbleOverride mode, string text)

Sets a text override for the hover/tab-highlight text of this object.

Properties
bool	IsTrapFlagged `[get]`
	Gets a value indicating whether this trap has been flagged as visible to all creatures in the game.

bool	IsTrapped `[get]`
	Gets a value indicating whether this object is trapped.

bool	OneShotTrap `[get, set]`
	Gets or sets a value indicating whether this trap should not reset after firing (true = don't reset).

bool	TrapActive `[get, set]`
	Gets or sets a value indicating whether this trap is an active trap. An inactive trap will not trigger when a creature steps on it.

TrapBaseType	TrapBaseType `[get]`
	Gets the base type of this trap.

NwPlayer?	TrapCreator `[get]`
	Gets the player that created this trap. If the trap was placed in the toolset, this returns null.

bool	TrapDetectable `[get, set]`
	Gets or sets a value indicating whether this trap can be detected.

int	TrapDetectDC `[get, set]`
	Gets or sets the skill DC required to detect this trap.

bool	TrapDisarmable `[get, set]`
	Gets or sets a value indicating whether this trap can be disarmed.

int	TrapDisarmDC `[get, set]`
	Gets or sets the skill DC required to disarm this trap.

string	TrapKeyTag `[get, set]`
	Gets or sets the tag of the key that will disarm this trap.

bool	TrapRecoverable `[get, set]`
	Gets or sets a value indicating whether this trap can be recovered.

Properties inherited from Anvil.API.NwGameObject
IEnumerable< Effect >	ActiveEffects `[get]`
	Gets all effects (permanent and temporary) that are active on this game object.

AnimationState	AnimationState `[get]`
	Gets the current animation state of this object.

NwArea?	Area `[get]`
	Gets the area this object is currently in.

int	CasterLevel `[get]`
	Gets the caster level of this object.

Color	HighlightColor `[get, set]`
	Gets or sets the highlight color of this object.

int	HP `[get, set]`
	Gets or sets the current HP for this object.

bool	IsDestroyable `[get, set]`
	Gets or sets if this object is destroyable.

bool	IsInConversation `[get]`
	Gets a value indicating whether this object is in a conversation.

bool	IsListening `[get, set]`
	Gets or sets if this object should be listening for chat patterns, via the listen pattern system.

bool	IsRaiseable `[get, set]`
	Gets or sets if this object is raiseable.

bool	IsSelectableWhenDead `[get, set]`
	Gets or sets if this object is selectable when dead.

virtual ? Location	Location `[get, set]`
	Gets or sets the location of this object.

int	MaxHP `[get, set]`
	Gets or sets the maximum HP for this object. Returns 0 if this object has no defined HP.

MouseCursor	MouseCursor `[get, set]`
	Gets or sets the mouse cursor for this object.

bool	PlotFlag `[get, set]`
	Gets or sets a value indicating whether the plot flag is enabled.

PortraitTableEntry?	PortraitId `[get, set]`
	Gets or sets the PortraitId of this (game object).

string	PortraitResRef `[get, set]`
	Gets or sets the Portrait ResRef for this object.

virtual Vector3	Position `[get, set]`
	Gets or sets the local area position of this GameObject.

virtual float	Rotation `[get, set]`
	Gets or sets the world rotation for this object.

NwGameObject?	TransitionTarget `[get, set]`
	Gets or sets the transition target for this object.

ObjectUiDiscovery	UiDiscoveryFlags `[get, set]`
	Gets or sets flags for controlling Ui discovery of this object.

bool	Useable `[get, set]`
	Gets or sets a value indicating whether this object should be useable (clickable).

VisibilityMode	VisibilityOverride `[get, set]`
	Gets or sets the global visiblity override for this object.

float	VisibleDistance `[get, set]`
	Gets or sets the distance that this object will become visible to clients (default 45.0). This is still subject to other limitations, such as perception ranges for creatures.

VisualTransform	VisualTransform `[get]`
	Gets the base visual transform for this object. Use GetVisualTransform to get the visual transform for other scopes for this object.

Additional Inherited Members
Static Public Member Functions inherited from Anvil.API.NwObject
static IEnumerable< T >	FindObjectsOfType< T > ()
	Locates all objects of the specified type.

static IEnumerable< NwObject >	FindObjectsWithTag (params string[] tags)
	Locates all objects of that have the specified tag.

static IEnumerable< T >	FindObjectsWithTag< T > (params string[] tags)
	Locates all objects of the specified type that have the specified tag.

Protected Member Functions inherited from Anvil.API.NwGameObject
void	AddToArea (CNWSArea area, float x, float y, float z)

T	CloneInternal< T > (Location location, string? newTag, bool copyLocalState)

Events inherited from Anvil.API.NwGameObject
Action< ModuleEvents.OnAcquireItem >	OnAcquireItem `[add, remove]`

Action< OnChatMessageSend >	OnChatMessageSend `[add, remove]`

Action< OnDisarmWeapon >	OnDisarmWeapon `[add, remove]`

Action< OnDispelMagicApply >	OnDispelMagicApply `[add, remove]`

Action< OnEffectApply >	OnEffectApply `[add, remove]`

Action< OnEffectRemove >	OnEffectRemove `[add, remove]`

Action< OnHeal >	OnHeal `[add, remove]`

Action< OnSpellBroadcast >	OnSpellBroadcast `[add, remove]`

Action< OnSpellCast >	OnSpellCast `[add, remove]`

Action< OnSpellInterrupt >	OnSpellInterrupt `[add, remove]`

Action< ModuleEvents.OnUnacquireItem >	OnUnacquireItem `[add, remove]`

Detailed Description

A trappable game object/entity.

Member Function Documentation

◆ IsTrapDetectedBy()

bool Anvil.API.NwTrappable.IsTrapDetectedBy ( NwCreature creature )

inline

Gets if the specified creature can see this trap.

Parameters

creature The creature to check.

Returns: true if the creature can detect this trap, otherwise false.

◆ SetTrapDetectedBy()

void Anvil.API.NwTrappable.SetTrapDetectedBy	(	bool	detected,
		params NwCreature[]	creatures )

inline

Sets the detected state for this trap for the given creatures.

Parameters

detected	The new detected state.
creatures	The creatures to update.

Property Documentation

◆ TrapActive

bool Anvil.API.NwTrappable.TrapActive

getset

Gets or sets a value indicating whether this trap is an active trap. An inactive trap will not trigger when a creature steps on it.

Setting a trap as inactive will not make the trap disappear if it has already been detected. Use TrapDetectable.

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

NWN.Anvil/src/main/API/Objects/NwTrappable.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ IsTrapDetectedBy()

◆ SetTrapDetectedBy()

Property Documentation

◆ TrapActive