A location in the module, represented by area, position and orientation. More...

Inheritance diagram for Anvil.API.Location:

Collaboration diagram for Anvil.API.Location:

Public Member Functions
void	ApplyEffect (EffectDuration durationType, Effect effect, TimeSpan duration=default)
	Applies the specified effect at this location.

void	CreateTrap (TrapBaseType trap, float size=2.0f, string tag="", string disarm="", string triggered="")
	Creates the specified trap.

float	Distance (Location 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 (Location target)
	Returns the squared distance to the target.

IEnumerable< NwCreature >	GetNearestCreatures ()
	Gets all creatures near this location, ordered by distance.

IEnumerable< NwCreature >	GetNearestCreatures (CreatureTypeFilter filter1)
	Gets all creatures near this location, ordered by distance.

IEnumerable< NwCreature >	GetNearestCreatures (CreatureTypeFilter filter1, CreatureTypeFilter filter2)
	Gets all creatures near this location, ordered by distance.

IEnumerable< NwCreature >	GetNearestCreatures (CreatureTypeFilter filter1, CreatureTypeFilter filter2, CreatureTypeFilter filter3)
	Gets all creatures near this location, ordered by distance.

IEnumerable< T >	GetNearestObjectsByType< T > ()
	Gets all objects near this location, ordered by distance.

IEnumerable< NwGameObject >	GetObjectsInShape (Shape shape, float size, bool losCheck, ObjectTypes objTypes=ObjectTypes.Creature, Vector3 origin=default)
	Gets all objects in a shape at this location.

IEnumerable< T >	GetObjectsInShapeByType< T > (Shape shape, float size, bool losCheck, Vector3 origin=default)
	Gets all objects in a shape at this location of the specified type.

void	SetTile (int tileId, TileRotation rotation, int height=0, SettleFlags flags=SettleFlags.RecomputeLighting)
	Changes the tile at this location to a new tile.

void	SetTileAnimationLoops (bool animLoop1, bool animLoop2, bool animLoop3)
	Sets the state of the animation loops of the tile at this location.

Public Member Functions inherited from Anvil.API.EngineStructure
void	Dispose ()

Static Public Member Functions
static ? Location	Create (NwArea area, Vector3 position, float orientation)
	Create a new location from the specified area, position and orientation.

static implicit	operator Location? (IntPtr intPtr)

Static Public Member Functions inherited from Anvil.API.EngineStructure
static implicit	operator IntPtr (EngineStructure engineStructure)

Properties
NwArea	Area `[get]`
	Gets the associated Area of this location.

float	FlippedRotation `[get]`
	Gets the inverted rotation value of this location (placeables).

float	GroundHeight `[get]`
	Gets the z-offset for the walkmesh at this location.

bool	IsWalkable `[get]`
	Gets a value indicating whether the location is walkable.

Vector3	Position `[get]`
	Gets the position Vector of this location.

float	Rotation `[get]`
	Gets the rotation value of this location.

override int	StructureId `[get]`

int	SurfaceMaterial `[get]`
	Gets the surface material index at this location. Returns 0 if the location is invalid or has no surface type.

int	TileHeight `[get]`
	Gets the height of the tile set at this location.

int	TileId `[get]`
	Gets the id of the tile set at this location.

TileInfo?	TileInfo `[get]`
	Gets the tile information at this location.

TileMainLightColor	TileMainLightColorOne `[get]`
	Gets the color of the first main light in the tile containing this location.

TileMainLightColor	TileMainLightColorTwo `[get]`
	Gets the color of the second main light in the tile containing this location.

TileRotation	TileRotation `[get]`
	Gets the rotation of the tile set at this location.

TileSourceLightColor	TileSourceLightColorOne `[get]`
	Gets the color of the first light source in the tile containing this location.

TileSourceLightColor	TileSourceLightColorTwo `[get]`
	Gets the color of the second light source in the tile containing this location.

Properties inherited from Anvil.API.EngineStructure
bool	IsValid `[get]`
	Gets if this object is valid.

int	StructureId `[get]`

Additional Inherited Members
Protected Member Functions inherited from Anvil.API.EngineStructure
	EngineStructure (IntPtr handle, bool memoryOwn)

Detailed Description

A location in the module, represented by area, position and orientation.

Member Function Documentation

◆ ApplyEffect()

void Anvil.API.Location.ApplyEffect	(	EffectDuration	durationType,
		Effect	effect,
		TimeSpan	duration = default )

inline

Applies the specified effect at this location.

Parameters

durationType	The duration type to apply with this effect.
effect	The effect to apply.
duration	If duration type is EffectDuration.Temporary, the duration of this effect.

◆ Create()

static ? Location Anvil.API.Location.Create	(	NwArea	area,
		Vector3	position,
		float	orientation )

inlinestatic

Create a new location from the specified area, position and orientation.

Parameters

area	The area of the location.
position	The position of the location.
orientation	The rotation of the location.

Returns: The created location.

◆ CreateTrap()

void Anvil.API.Location.CreateTrap	(	TrapBaseType	trap,
		float	size = 2::0f,
		string	tag = "",
		string	disarm = "",
		string	triggered = "" )

inline

Creates the specified trap.

Parameters

trap	The base type of trap.
size	The size of the trap. Minimum size allowed is 1.0f. If no value set, defaults to 2.0f.
tag	The tag of the trap being created. If no value set, defaults to an empty string.
disarm	The script that will fire when the trap is disarmed. If no value set, defaults to an empty string and no script will fire.
triggered	The 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).

◆ Distance()

float Anvil.API.Location.Distance ( Location target )

inline

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.

Parameters

target The other location to calculate distance between.

Returns: The distance in game units, or -1 if the target is in a different area.

◆ DistanceSquared()

float Anvil.API.Location.DistanceSquared ( Location target )

inline

Returns the squared distance to the target.

Parameters

target The other location to calculate distance between.

Returns: The squared distance in game units, or -1 if the target is in a different area.

◆ GetNearestCreatures() [1/3]

IEnumerable< NwCreature > Anvil.API.Location.GetNearestCreatures ( CreatureTypeFilter filter1 )

inline

Gets all creatures near this location, ordered by distance.

Parameters

filter1 A filter for the returned creatures.

◆ GetNearestCreatures() [2/3]

IEnumerable< NwCreature > Anvil.API.Location.GetNearestCreatures	(	CreatureTypeFilter	filter1,
		CreatureTypeFilter	filter2 )

inline

Gets all creatures near this location, ordered by distance.

Parameters

filter1	A filter for the returned creatures.
filter2	A 2nd filter for the returned creatures.

◆ GetNearestCreatures() [3/3]

IEnumerable< NwCreature > Anvil.API.Location.GetNearestCreatures	(	CreatureTypeFilter	filter1,
		CreatureTypeFilter	filter2,
		CreatureTypeFilter	filter3 )

inline

Gets all creatures near this location, ordered by distance.

Parameters

filter1	A filter for the returned creatures.
filter2	A 2nd filter for the returned creatures.
filter3	A 3rd filter for the returned creatures.

◆ GetNearestObjectsByType< T >()

IEnumerable< T > Anvil.API.Location.GetNearestObjectsByType< T > ( )

inline

Gets all objects near this location, ordered by distance.

Type Constraints

T

:

NwGameObject

◆ GetObjectsInShapeByType< T >()

IEnumerable< T > Anvil.API.Location.GetObjectsInShapeByType< T >	(	Shape	shape,
		float	size,
		bool	losCheck,
		Vector3	origin = default )

inline

Gets all objects in a shape at this location of the specified type.

Type Constraints

T

:

NwGameObject

◆ SetTile()

void Anvil.API.Location.SetTile	(	int	tileId,
		TileRotation	rotation,
		int	height = 0,
		SettleFlags	flags = SettleFlags::RecomputeLighting )

inline

Changes the tile at this location to a new tile.

Parameters

tileId	The new tile to apply.
rotation	How the tile should be rotated.
height	The height of the tile.
flags	Additional flags/behaviours to run after the tile is updated.

Property Documentation

◆ TileMainLightColorOne

TileMainLightColor Anvil.API.Location.TileMainLightColorOne

get

Gets the color of the first main light in the tile containing this location.

Returns: A TileMainLightColor value representing the main light color of the specified tile.

◆ TileMainLightColorTwo

TileMainLightColor Anvil.API.Location.TileMainLightColorTwo

get

Gets the color of the second main light in the tile containing this location.

Returns: A TileMainLightColor value representing the second main light color of the specified tile.

◆ TileSourceLightColorOne

TileSourceLightColor Anvil.API.Location.TileSourceLightColorOne

get

Gets the color of the first light source in the tile containing this location.

Returns: A TileSourceLightColor value representing the first light source color of the specified tile.

◆ TileSourceLightColorTwo

TileSourceLightColor Anvil.API.Location.TileSourceLightColorTwo

get

Gets the color of the second light source in the tile containing this location.

Returns: A TileSourceLightColor value representing the second light source color of the specified tile.

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

NWN.Anvil/src/main/API/EngineStructures/Location.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ApplyEffect()

◆ Create()

◆ CreateTrap()

◆ Distance()

◆ DistanceSquared()

◆ GetNearestCreatures() [1/3]

◆ GetNearestCreatures() [2/3]

◆ GetNearestCreatures() [3/3]

◆ GetNearestObjectsByType< T >()

◆ GetObjectsInShapeByType< T >()

◆ SetTile()

Property Documentation

◆ TileMainLightColorOne

◆ TileMainLightColorTwo

◆ TileSourceLightColorOne

◆ TileSourceLightColorTwo