Category:Area Functions

From NWN Lexicon
Jump to: navigation, search

Area Function Category

Functions used to deal with areas.



Functions

Name Brief Description

ActivatePortal

Send a player's client to a new server, where the player's character will log in.

AmbientSoundChangeDay

Changes the ambient daytime soundtrack of an area.

AmbientSoundChangeNight

Modify an Area's nighttime soundtrack.

AmbientSoundPlay

Starts the ambient soundtrack of an area playing.

AmbientSoundSetDayVolume

Change the volume of the ambient daytime soundtrack in an area.

AmbientSoundSetNightVolume

Change the volume of an area's ambient nighttime soundtrack

AmbientSoundStop

Stops ambient sounds playing in an area.

CountAllObjectsInAreaByTag

Counts all objects in the area with a matching tag.

DestroyNearestObjectByTag

Destroys the nearest object in the source's area by tag.

DestroyObjectsInAreaByTag

Destroys all the objects in the area with a given tag.

ExploreAreaForPlayer

Reveals the entire map of an area to a player.

GenerateNewLocationFromLocation

Creates a new location from a given location

GetAheadLocation

This function returns a location directly in front of the target

GetAngleBetweenLocations

Returns a float representing the angle between Location One and Location Two

GetArea

Returns the area oTarget is currently in.

GetAreaFromLocation

Returns the area that a particular location is in.

GetAreaSize

Gets the size of the area.

GetBehindLocation

Returns location directly behind the target and facing same direction as the target

GetCenterPointOfArea

Approximates the central location of an area.

GetEnteringObject

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

GetExitingObject

Get the object that last left the calling object.

GetFirstObjectInArea

Determines the first object in an area.

GetFlankingLeftLocation

Returns a location on the left flank of the target

GetFlankingRightLocation

Returns a location that is the right flank (to the right and slightly behind) the Target

GetFogAmount

Gets the fog amount in the area.

GetFogColor

Gets the fog color in the area.

GetForwardFlankingLeftLocation

Returns location to the forward left flank of the target

GetForwardFlankingRightLocation

Returns location to the forward right flank of the target

GetIsAreaAboveGround

Determines whether an area is above ground or not.

GetIsAreaInterior

Determines whether an area is interior or underground.

GetIsAreaNatural

Returns whether an area is natural or not

GetMyArea

Retrieves the tag for the area of an object.

GetNextObjectInArea

Determines the next object in an area.

GetOppositeLocation

Returns a location that is directly behind the target

GetSkyBox

Gets the skybox being used in the calling area.

GetTileMainLight1Color

Determines the color of the first main light of a tile.

GetTileMainLight2Color

Determines the second main light color for a tile.

GetTilesetResRef

Returns the resref ( TILESET_RESREF_* ) constant of the tileset used to create the area.

GetWeather

Gets the current weather conditions for a given area

Location

Set the value of a Location data structure

LocationToString

Turn a location into a string.

MusicBackgroundChangeDay

Changes the background daytime music for the area specified.

MusicBackgroundChangeNight

Changes the background nighttime music for the area specified.

MusicBackgroundGetBattleTrack

Gets the background battle track for an area.

MusicBackgroundGetDayTrack

Gets the daytime background track for an area.

MusicBackgroundGetNightTrack

Gets the nighttime background track for an area.

MusicBackgroundSetDelay

This function changes the delay (in milliseconds) of the background music.

MusicBackgroundStop

Stops playing the currently selected background track.

MusicBattleChange

Changes the battle music for the area specified.

MusicBattlePlay

Starts the currently selected battle track playing

MusicBattleStop

Stops the currently playing battle track.

SetFogAmount

Sets the fog amount in the area.

SetFogColor

Sets the fog color in the area.

SetSkyBox

Changes the sky that is displayed in the area.

SetWeather

Allows you to set the weather for an area or the entire module.

TLChangeAreaGroundTiles

Changes the tiles of an entire area.

TLChangeAreaGroundTilesEx

Similar to TLChangeAreaGroundTiles , but it auto determines height and width of the area.

TLResetAreaGroundTiles

Removes tile magic visual effects from an area.

TLResetAreaGroundTilesEx

Similar to TLResetAreaGroundTiles , but it auto determines height and width of the area.