| Singleton: | world | Added with: 1.2.0 | |
| Description: | The world singleton contains functions centered around two different but extremely useful functions.
1. Events and event handlers are all governed within world. 2. A number of functions to get information about the game world. | ||
| Functions: | addEventHandler, removeEventHandler, getPlayer, getAirbases, searchObjects, getMarkPanels, removeJunk | ||
| Enumerators and Other Data: | The event enumerator defines all of the types of events that can occur.
world.event = {
S_EVENT_INVALID = 0,
S_EVENT_SHOT = 1,
S_EVENT_HIT = 2,
S_EVENT_TAKEOFF = 3,
S_EVENT_LAND = 4,
S_EVENT_CRASH = 5,
S_EVENT_EJECTION = 6,
S_EVENT_REFUELING = 7,
S_EVENT_DEAD = 8,
S_EVENT_PILOT_DEAD = 9,
S_EVENT_BASE_CAPTURED = 10,
S_EVENT_MISSION_START = 11,
S_EVENT_MISSION_END = 12,
S_EVENT_TOOK_CONTROL = 13,
S_EVENT_REFUELING_STOP = 14,
S_EVENT_BIRTH = 15,
S_EVENT_HUMAN_FAILURE = 16,
S_EVENT_DETAILED_FAILURE = 17,
S_EVENT_ENGINE_STARTUP = 18,
S_EVENT_ENGINE_SHUTDOWN = 19,
S_EVENT_PLAYER_ENTER_UNIT = 20,
S_EVENT_PLAYER_LEAVE_UNIT = 21,
S_EVENT_PLAYER_COMMENT = 22,
S_EVENT_SHOOTING_START = 23,
S_EVENT_SHOOTING_END = 24,
S_EVENT_MARK_ADDED = 25,
S_EVENT_MARK_CHANGE = 26,
S_EVENT_MARK_REMOVED = 27,
S_EVENT_KILL = 28,
S_EVENT_SCORE = 29,
S_EVENT_UNIT_LOST = 30,
S_EVENT_LANDING_AFTER_EJECTION = 31,
-- Redacted for now.
S_EVENT_MAX = 33,
}
The birthplace enumerator is used to define where an aircraft or helicopter has spawned in association with birth world.BirthPlace = {
wsBirthPlace_Air,
wsBirthPlace_RunWay,
wsBirthPlace_Park,
wsBirthPlace_Heliport_Hot,
wsBirthPlace_Heliport_Cold,
}
The volumeType enumerator defines the types of 3d geometery used within the world.searchObjects function world.VolumeType = {
SEGMENT,
BOX,
SPHERE,
PYRAMID
}
| ||
| Notes: | 2.5.5 Inserted S_EVENT_DETAILED_FAILURE into id 17.
2.5.6 Added S_EVENT_KILL, S_EVENT_SCORE , S_EVENT_UNIT_LOST , S_EVENT_LANDING_AFTER_EJECTION , -- Redacted for now. And changed S_EVENT_MAX to 33, | ||
