nwnx_area.nss File Reference

#include "nwnx"

Go to the source code of this file.

Classes
struct	NWNX_Area_TileInfo
	A tile info struct. More...
struct	NWNX_Area_AreaWind
	Area wind info struct. More...

Functions
int	NWNX_Area_GetNumberOfPlayersInArea (object area)
	Gets the number of players in area. More...
object	NWNX_Area_GetLastEntered (object area)
	Gets the creature that last entered area. More...
object	NWNX_Area_GetLastLeft (object area)
	Gets the creature that last left area. More...
int	NWNX_Area_GetPVPSetting (object area)
	Get the PVP setting of area. More...
void	NWNX_Area_SetPVPSetting (object area, int pvpSetting)
	Set the PVP setting of area. More...
int	NWNX_Area_GetAreaSpotModifier (object area)
	Get the spot modifier of area. More...
void	NWNX_Area_SetAreaSpotModifier (object area, int spotModifier)
	Set the spot modifier of area. More...
int	NWNX_Area_GetAreaListenModifier (object area)
	Get the listen modifer of area. More...
void	NWNX_Area_SetAreaListenModifier (object area, int listenModifier)
	Set the listen modifier of area. More...
int	NWNX_Area_GetNoRestingAllowed (object area)
	Checks the No Resting area flag. More...
void	NWNX_Area_SetNoRestingAllowed (object area, int bNoRestingAllowed)
	Set whether to disable resting in the area. More...
int	NWNX_Area_GetWindPower (object area)
	Get the wind power in area. More...
void	NWNX_Area_SetWindPower (object area, int windPower)
	Set the wind power in area. More...
int	NWNX_Area_GetWeatherChance (object area, int type)
	Get the weather chance of type in area. More...
void	NWNX_Area_SetWeatherChance (object area, int type, int chance)
	Set the weather chance of type in area. More...
float	NWNX_Area_GetFogClipDistance (object area)
	Get the fog clip distance in area. More...
void	NWNX_Area_SetFogClipDistance (object area, float distance)
	Set the fog clip distance in area. More...
int	NWNX_Area_GetShadowOpacity (object area)
	Get the shadow opacity of area. More...
void	NWNX_Area_SetShadowOpacity (object area, int shadowOpacity)
	Set the shadow opacity of area. More...
int	NWNX_Area_GetDayNightCycle (object area)
	Get the day/night cycle of area. More...
void	NWNX_Area_SetDayNightCycle (object area, int type)
	Set the day/night cycle of area. More...
int	NWNX_Area_GetSunMoonColors (object area, int type)
	Get the Sun/Moon Ambient/Diffuse colors of area. More...
void	NWNX_Area_SetSunMoonColors (object area, int type, int color)
	Set the Sun/Moon Ambient/Diffuse colors of area. More...
object	NWNX_Area_CreateTransition (object area, object target, float x, float y, float z, float size=2.0f, string tag="")
	Create and returns a transition (square shaped of specified size) at a location. More...
int	NWNX_Area_GetTileAnimationLoop (object oArea, float fTileX, float fTileY, int nAnimLoop)
	Get the state of a tile animation loop. More...
void	NWNX_Area_SetTileAnimationLoop (object oArea, float fTileX, float fTileY, int nAnimLoop, int bEnabled)
	Set the state of a tile animation loop. More...
string	NWNX_Area_GetTileModelResRef (object oArea, float fTileX, float fTileY)
	Get the name of the tile model from any location. More...
int	NWNX_Area_TestDirectLine (object oArea, float fStartX, float fStartY, float fEndX, float fEndY, float fPerSpace, float fHeight, int bIgnoreDoors=FALSE)
	Test to see if there's a direct, walkable line between two points in the area. More...
int	NWNX_Area_GetMusicIsPlaying (object oArea, int bBattleMusic=FALSE)
	Get if the area music is playing. More...
object	NWNX_Area_CreateGenericTrigger (object oArea, float fX, float fY, float fZ, string sTag="", float fSize=1.0f)
	Create and return a generic trigger (square shaped of specified size) at a location. More...
void	NWNX_Area_AddObjectToExclusionList (object oObject)
	Add oObject to the ExportGIT exclusion list, objects on this list won't be exported when NWNX_Area_ExportGIT() is called. More...
void	NWNX_Area_RemoveObjectFromExclusionList (object oObject)
	Remove oObject from the ExportGIT exclusion list. More...
int	NWNX_Area_ExportGIT (object oArea, string sFileName="", int bExportVarTable=TRUE, int bExportUUID=TRUE, int nObjectFilter=0, string sAlias="NWNX")
	Export the .git file of oArea to the UserDirectory/nwnx folder, or to the location of sAlias. More...
struct NWNX_Area_TileInfo	NWNX_Area_GetTileInfo (object oArea, float fTileX, float fTileY)
	Get the tile info of the tile at [fTileX, fTileY] in oArea. More...
int	NWNX_Area_ExportARE (object oArea, string sFileName, string sNewName="", string sNewTag="", string sAlias="NWNX")
	Export the .are file of oArea to the UserDirectory/nwnx folder, or to the location of sAlias. More...
int	NWNX_Area_GetAmbientSoundDay (object oArea)
	Get the ambient sound playing in an area during the day. More...
int	NWNX_Area_GetAmbientSoundNight (object oArea)
	Get the ambient sound playing in an area during the night. More...
int	NWNX_Area_GetAmbientSoundDayVolume (object oArea)
	Get the volume of the ambient sound playing in an area during the day. More...
int	NWNX_Area_GetAmbientSoundNightVolume (object oArea)
	Get the volume of the ambient sound playing in an area during the night. More...
object	NWNX_Area_CreateSoundObject (object oArea, vector vPosition, string sResRef)
	Create a sound object. More...
void	NWNX_Area_RotateArea (object oArea, int nRotation)
	Rotates an existing area, including all objects within (excluding PCs). More...
struct NWNX_Area_TileInfo	NWNX_Area_GetTileInfoByTileIndex (object oArea, int nIndex)
	Get the tile info of the tile at nIndex in the tile array. More...
int	NWNX_Area_GetPathExists (object oArea, vector vStartPosition, vector vEndPosition, int nMaxDepth)
	Check if there is a path between two positions in an area. More...
int	NWNX_Area_GetAreaFlags (object oArea)
	Get oArea's flags, interior/underground etc. More...
void	NWNX_Area_SetAreaFlags (object oArea, int nFlags)
	Set oArea's raw flags bitmask. More...
struct NWNX_Area_AreaWind	NWNX_Area_GetAreaWind (object oArea)
	Get oArea's detailed win data. More...
void	NWNX_Area_SetDefaultObjectUiDiscoveryMask (object oArea, int nObjectTypes, int nMask, int bForceUpdate=FALSE)
	Set the default discoverability mask for objects in an area. More...

Variables
Area PVP Settings
const int	NWNX_AREA_PVP_SETTING_NO_PVP = 0
const int	NWNX_AREA_PVP_SETTING_PARTY_PVP = 1
const int	NWNX_AREA_PVP_SETTING_FULL_PVP = 2
const int	NWNX_AREA_PVP_SETTING_SERVER_DEFAULT = 3
Area Weather Settings
const int	NWNX_AREA_WEATHER_CHANCE_RAIN = 0
const int	NWNX_AREA_WEATHER_CHANCE_SNOW = 1
const int	NWNX_AREA_WEATHER_CHANCE_LIGHTNING = 2
Area Day Night Cycle Settings
const int	NWNX_AREA_DAYNIGHTCYCLE_CYCLE_DAY_NIGHT = 0
const int	NWNX_AREA_DAYNIGHTCYCLE_ALWAYS_BRIGHT = 1
const int	NWNX_AREA_DAYNIGHTCYCLE_ALWAYS_DARK = 2
Area Sun/Moon Color Settings
const int	NWNX_AREA_COLOR_TYPE_MOON_AMBIENT = 0
const int	NWNX_AREA_COLOR_TYPE_MOON_DIFFUSE = 1
const int	NWNX_AREA_COLOR_TYPE_SUN_AMBIENT = 2
const int	NWNX_AREA_COLOR_TYPE_SUN_DIFFUSE = 3