class Area¶
-
class
Area
¶ -
ClearLineOfSight
(loc1, loc2)¶ Determines if there is a clear line of sight between two objects
Parameters:
-
GetType
()¶ Get area type.
-
GetPlayerCount
()¶ Get area player count.
-
GetSkyBox
()¶ Gets the sky that is displayed in the specified area.
-
GetTilesetResRef
()¶ Gets the Tileset Resref for the specified area.
-
RecomputeStaticLighting
()¶ Recomputes the lighting in an area based on current static lighting conditions.
-
GetObjectIndex
(object)¶ Gets the position of specified object in the areas object list.
Parameters: - object (
Object
) – Object to search.
- object (
-
GetObjectAtIndex
(idx)¶ Returns the object at specifed index of the area’s object array.
Parameters: - idx (int) – Index of the object desired.
-
Objects
()¶ Iterator returning all objects in a specified area.
-
AmbientSoundChange
([day[, night])¶ Changes the ambient soundtracks of an area.
Parameters: - day (int) – Day track number to change to. If nil the track is unchanged
- night (int) – Night track number to change to. If nil the track is unchanged
-
AmbientSoundPlay
()¶ Starts ambient sounds playing in an area.
-
AmbientSoundStop
()¶ Stops ambient sounds playing in an area.
-
AmbientSoundSetVolume
(day, night)¶ Changes the ambient sound volumes of an area.
Parameters: - day (int) – Day track number to change to. If nil the track is unchanged
- night (int) – Night track number to change to. If nil the track is unchanged
-
MusicBackgroundChange
(day, night)¶ Changes the background music for the area specified.
Parameters: - day (int) – Day track number to change to. If nil the track is unchanged
- night (int) – Night track number to change to. If nil the track is unchanged
-
MusicBackgroundGetBattleTrack
()¶ Gets the background battle track for an area.
-
MusicBackgroundGetTrack
([is_night])¶ Gets the background track for an area.
Parameters: - is_night (boolean) – If true returns the night track. (Default: False)
-
MusicBackgroundPlay
()¶ Starts the currently selected background track playing.
-
MusicBackgroundSetDelay
(delay)¶ Changes the delay (in milliseconds) of the background music.
Parameters: - delay (float) – Time in milliseconds.
-
MusicBackgroundStop
()¶ Stops the currently selected background track playing.
-
MusicBattleChange
(track)¶ Stops the currently selected background track playing.
Parameters: - track (int) – Music track number.
-
MusicBattlePlay
()¶ Starts the currently selected battle track playing
-
MusicBattleStop
()¶ Stops the currently selected battle track playing
-
SetAreaTransitionBMP
(predef[, custom])¶ Sets the graphic shown when a PC moves between two different areas in a module.
Parameters: - predef (int) – A predifined AREA_TRANSITION_* constant.
- custom (string) – File name of an area transition bitmap. (Default: “”)
-
SetSkyBox
(skybox)¶ Sets the sky that is displayed in the specified area.
Parameters: - skybox (int) – A SKYBOX_* constant (associated with skyboxes.2da)
-
SetWeather
(weather)¶ Sets the weather in the specified area.
Parameters: - weather (int) – AREA_WEATHER_*
-