Area Function Category

Functions used to deal with areas.



Functions

NameBrief Description
ActivatePortalSend a player's client to a new server, where the player's character will log in.
AmbientSoundChangeDayChanges the ambient daytime soundtrack of an area.
AmbientSoundChangeNightModify an Area's nighttime soundtrack.
AmbientSoundPlayStarts the ambient soundtrack of an area playing.
AmbientSoundSetDayVolumeChange the volume of the ambient daytime soundtrack in an area.
AmbientSoundSetNightVolumeChange the volume of an area's ambient nighttime soundtrack
AmbientSoundStopStops ambient sounds playing in an area.
CountAllObjectsInAreaByTagCounts all objects in the area with a matching tag.
DestroyNearestObjectByTagDestroys the nearest object in the source's area by tag.
DestroyObjectsInAreaByTagDestroys all the objects in the area with a given tag.
ExploreAreaForPlayerReveals the entire map of an area to a player.
GenerateNewLocationFromLocationCreates a new location from a given location
GetAheadLocationThis function returns a location directly in front of the target
GetAngleBetweenLocationsReturns a float representing the angle between Location One and Location Two
GetAreaReturns the area oTarget is currently in.
GetAreaFromLocationReturns the area that a particular location is in.
GetAreaSizeGets the size of the area.
GetBehindLocationReturns location directly behind the target and facing same direction as the target
GetCenterPointOfAreaApproximates the central location of an area.
GetEnteringObjectGets the object that last opened or entered the calling object.
GetExitingObjectGet the object that last left the calling object.
GetFirstObjectInAreaDetermines the first object in an area.
GetFlankingLeftLocationReturns a location on the left flank of the target
GetFlankingRightLocationReturns a location that is the right flank (to the right and slightly behind) the Target
GetFogAmountGets the fog amount in the area.
GetFogColorGets the fog color in the area.
GetForwardFlankingLeftLocationReturns location to the forward left flank of the target
GetForwardFlankingRightLocationReturns location to the forward right flank of the target
GetIsAreaAboveGroundDetermines whether an area is above ground or not.
GetIsAreaInteriorDetermines whether an area is interior or underground.
GetIsAreaNaturalReturns whether an area is natural or not
GetMyAreaRetrieves the tag for the area of an object.
GetNextObjectInAreaDetermines the next object in an area.
GetOppositeLocationReturns a location that is directly behind the target
GetSkyBoxGets the skybox being used in the calling area.
GetTileMainLight1ColorDetermines the color of the first main light of a tile.
GetTileMainLight2ColorDetermines the second main light color for a tile.
GetTilesetResRefReturns the resref (TILESET_RESREF_*) constant of the tileset used to create the area.
GetWeatherGets the current weather conditions for a given area
LocationSet the value of a Location data structure
LocationToStringTurn a location into a string.
MusicBackgroundChangeDayChanges the background daytime music for the area specified.
MusicBackgroundChangeNightChanges the background nighttime music for the area specified.
MusicBackgroundGetBattleTrackGets the background battle track for an area.
MusicBackgroundGetDayTrackGets the daytime background track for an area.
MusicBackgroundGetNightTrackGets the nighttime background track for an area.
MusicBackgroundSetDelayThis function changes the delay (in milliseconds) of the background music.
MusicBackgroundStopStops playing the currently selected background track.
MusicBattleChangeChanges the battle music for the area specified.
MusicBattlePlayStarts the currently selected battle track playing
MusicBattleStopStops the currently playing battle track.
SetFogAmountSets the fog amount in the area.
SetFogColorSets the fog color in the area.
SetSkyBoxChanges the sky that is displayed in the area.
SetWeatherAllows you to set the weather for an area or the entire module.
TLChangeAreaGroundTilesChanges the tiles of an entire area.
TLChangeAreaGroundTilesExSimilar to TLChangeAreaGroundTiles, but it auto determines height and width of the area.
TLResetAreaGroundTilesRemoves tile magic visual effects from an area.
TLResetAreaGroundTilesExSimilar to TLResetAreaGroundTiles, but it auto determines height and width of the area.

See Also

Function Categories