Xordac: 1 revision imported

2017-10-23T23:23:13Z

1 revision imported

← Older revision		Revision as of 23:23, 23 October 2017
(No difference)

Xordac: Created page with "=Area Function Category= Functions used to deal with areas.

====Functions==== {| border="1" cellpadding="5" ! Name ! Brief Description |- | ActivatePortal |..."

2017-05-23T11:51:02Z

Created page with "=Area Function Category= Functions used to deal with areas. <br /><br /> ====Functions==== {| border="1" cellpadding="5" ! Name ! Brief Description |- | ActivatePortal |..."

New page

=Area Function Category=

Functions used to deal with areas.

<br /><br />

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[ActivatePortal | ActivatePortal ]]
| Send a player's client to a new server, where the player's character will log in.
|-
|
[[AmbientSoundChangeDay | AmbientSoundChangeDay ]]
| Changes the ambient daytime soundtrack of an area.
|-
|
[[AmbientSoundChangeNight | AmbientSoundChangeNight ]]
| Modify an Area's nighttime soundtrack.
|-
|
[[AmbientSoundPlay | AmbientSoundPlay ]]
| Starts the ambient soundtrack of an area playing.
|-
|
[[AmbientSoundSetDayVolume | AmbientSoundSetDayVolume ]]
| Change the volume of the ambient daytime soundtrack in an area.
|-
|
[[AmbientSoundSetNightVolume | AmbientSoundSetNightVolume ]]
| Change the volume of an area's ambient nighttime soundtrack
|-
|
[[AmbientSoundStop | AmbientSoundStop ]]
| Stops ambient sounds playing in an area.
|-
|
[[CountAllObjectsInAreaByTag | CountAllObjectsInAreaByTag ]]
| Counts all objects in the area with a matching tag.
|-
|
[[DestroyNearestObjectByTag | DestroyNearestObjectByTag ]]
| Destroys the nearest object in the source's area by tag.
|-
|
[[DestroyObjectsInAreaByTag | DestroyObjectsInAreaByTag ]]
| Destroys all the objects in the area with a given tag.
|-
|
[[ExploreAreaForPlayer | ExploreAreaForPlayer ]]
| Reveals the entire map of an area to a player.
|-
|
[[GenerateNewLocationFromLocation | GenerateNewLocationFromLocation ]]
| Creates a new location from a given location
|-
|
[[GetAheadLocation | GetAheadLocation ]]
| This function returns a location directly in front of the target
|-
|
[[GetAngleBetweenLocations | GetAngleBetweenLocations ]]
| Returns a float representing the angle between Location One and Location Two
|-
|
[[GetArea | GetArea ]]
| Returns the area oTarget is currently in.
|-
|
[[GetAreaFromLocation | GetAreaFromLocation ]]
| Returns the area that a particular location is in.
|-
|
[[GetAreaSize | GetAreaSize ]]
| Gets the size of the area.
|-
|
[[GetBehindLocation | GetBehindLocation ]]
| Returns location directly behind the target and facing same direction as the target
|-
|
[[GetCenterPointOfArea | GetCenterPointOfArea ]]
| Approximates the central location of an area.
|-
|
[[GetEnteringObject | GetEnteringObject ]]
| Gets the object that last opened or entered the calling object.
|-
|
[[GetExitingObject | GetExitingObject ]]
| Get the object that last left the calling object.
|-
|
[[GetFirstObjectInArea | GetFirstObjectInArea ]]
| Determines the first object in an area.
|-
|
[[GetFlankingLeftLocation | GetFlankingLeftLocation ]]
| Returns a location on the left flank of the target
|-
|
[[GetFlankingRightLocation | GetFlankingRightLocation ]]
| Returns a location that is the right flank (to the right and slightly behind) the Target
|-
|
[[GetFogAmount | GetFogAmount ]]
| Gets the fog amount in the area.
|-
|
[[GetFogColor | GetFogColor ]]
| Gets the fog color in the area.
|-
|
[[GetForwardFlankingLeftLocation | GetForwardFlankingLeftLocation ]]
| Returns location to the forward left flank of the target
|-
|
[[GetForwardFlankingRightLocation | GetForwardFlankingRightLocation ]]
| Returns location to the forward right flank of the target
|-
|
[[GetIsAreaAboveGround | GetIsAreaAboveGround ]]
| Determines whether an area is above ground or not.
|-
|
[[GetIsAreaInterior | GetIsAreaInterior ]]
| Determines whether an area is interior or underground.
|-
|
[[GetIsAreaNatural | GetIsAreaNatural ]]
| Returns whether an area is natural or not
|-
|
[[GetMyArea | GetMyArea ]]
| Retrieves the tag for the area of an object.
|-
|
[[GetNextObjectInArea | GetNextObjectInArea ]]
| Determines the next object in an area.
|-
|
[[GetOppositeLocation | GetOppositeLocation ]]
| Returns a location that is directly behind the target
|-
|
[[GetSkyBox | GetSkyBox ]]
| Gets the skybox being used in the calling area.
|-
|
[[GetTileMainLight1Color | GetTileMainLight1Color ]]
| Determines the color of the first main light of a tile.
|-
|
[[GetTileMainLight2Color | GetTileMainLight2Color ]]
| Determines the second main light color for a tile.
|-
|
[[GetTilesetResRef | GetTilesetResRef ]]
|
Returns the resref ([[ tileset_resref | TILESET_RESREF_* ]]) constant of the tileset used to create the area.
|-
|
[[GetWeather | GetWeather ]]
| Gets the current weather conditions for a given area
|-
|
[[Location | Location ]]
| Set the value of a Location data structure
|-
|
[[LocationToString | LocationToString ]]
| Turn a location into a string.
|-
|
[[MusicBackgroundChangeDay | MusicBackgroundChangeDay ]]
| Changes the background daytime music for the area specified.
|-
|
[[MusicBackgroundChangeNight | MusicBackgroundChangeNight ]]
| Changes the background nighttime music for the area specified.
|-
|
[[MusicBackgroundGetBattleTrack | MusicBackgroundGetBattleTrack ]]
| Gets the background battle track for an area.
|-
|
[[MusicBackgroundGetDayTrack | MusicBackgroundGetDayTrack ]]
| Gets the daytime background track for an area.
|-
|
[[MusicBackgroundGetNightTrack | MusicBackgroundGetNightTrack ]]
| Gets the nighttime background track for an area.
|-
|
[[MusicBackgroundSetDelay | MusicBackgroundSetDelay ]]
| This function changes the delay (in milliseconds) of the background music.
|-
|
[[MusicBackgroundStop | MusicBackgroundStop ]]
| Stops playing the currently selected background track.
|-
|
[[MusicBattleChange | MusicBattleChange ]]
| Changes the battle music for the area specified.
|-
|
[[MusicBattlePlay | MusicBattlePlay ]]
| Starts the currently selected battle track playing
|-
|
[[MusicBattleStop | MusicBattleStop ]]
| Stops the currently playing battle track.
|-
|
[[SetFogAmount | SetFogAmount ]]
| Sets the fog amount in the area.
|-
|
[[SetFogColor | SetFogColor ]]
| Sets the fog color in the area.
|-
|
[[SetSkyBox | SetSkyBox ]]
| Changes the sky that is displayed in the area.
|-
|
[[SetWeather | SetWeather ]]
| Allows you to set the weather for an area or the entire module.
|-
|
[[TLChangeAreaGroundTiles | TLChangeAreaGroundTiles ]]
| Changes the tiles of an entire area.
|-
|
[[TLChangeAreaGroundTilesEx | TLChangeAreaGroundTilesEx ]]
|
Similar to [[TLChangeAreaGroundTiles | TLChangeAreaGroundTiles ]], but it auto determines height and width of the area.
|-
|
[[TLResetAreaGroundTiles | TLResetAreaGroundTiles ]]
| Removes tile magic visual effects from an area.
|-
|
[[TLResetAreaGroundTilesEx | TLResetAreaGroundTilesEx ]]
|
Similar to [[TLResetAreaGroundTiles | TLResetAreaGroundTiles ]], but it auto determines height and width of the area.
|}

----
[[Category:Functions]]
[[Category:Function_Categories]]

Category:Area Functions - Revision history

Xordac: 1 revision imported

Xordac: Created page with "=Area Function Category= Functions used to deal with areas. ====Functions==== {| border="1" cellpadding="5" ! Name ! Brief Description |- | ActivatePortal |..."

Xordac: Created page with "=Area Function Category= Functions used to deal with areas.

====Functions==== {| border="1" cellpadding="5" ! Name ! Brief Description |- | ActivatePortal |..."