Clone
1
world
Bruno Carneiro edited this page 2026-02-13 18:25:50 -03:00
Table of Contents
World API (maddox.game.world)
Types in maddox.game.world represent actors (air, ground), triggers, spawn points, airports, targets, time, and user labels. Mission scripts get these from IGamePlay (e.g. gpActorByName, gpBirthPlaces, gpGetTrigger) or receive them in AMission event arguments.
Documentation index
| Document | Description |
|---|---|
| Actor Hierarchy | AiActor, AiPerson, AiCart, AiGroup, AiBridge, AiWayPoint; damage types (AiDamageInitiator, AiDamageTool, DamagerScore, AiLimbDamage); CrewFunction |
| Air | AiAircraft, AiAirGroup, AiAirWayPoint, AiAirEnemyElement; enums IDState, AircraftType, DangerType, AiAirWayPointType, AiAirWayPointGAttackType, AiAirWayPointGAttackPasses, AiAirGroupTask; EnemyAirInterf |
| Ground | AiGroundActor, AiGroundGroup, AiGroundWayPoint, AiAIChief; GroundStationary, GroundBuilding, GroundBombExplosion; AiGroundGroupType, AiGroundActorType; AiAIChiefType |
| Triggers Spawns And Targets | AiTrigger, AiAction; AiBirthPlace; AiAirport, AiAirportType, AiAirportStripState; AiTarget, AiTargetType, AiTargetGoal; Regiment |
| Time And User Labels | ITime (cross-link), GPUserLabel, GPUserIconType |
When to use which
- Actors — Resolve by name with
GamePlay.gpActorByName(); checkgpActorIsValid(). Use AiActor for position, army, group; AiCart for vehicles/aircraft (places, crew, destroy); AiAircraft for fuel, rearm, damage; AiGroundActor for ground units. - Triggers / actions —
GamePlay.gpGetTrigger(name),gpGetAction(name). In OnTrigger, get the action and callDo()to run it. - Spawns / airports —
GamePlay.gpBirthPlaces(),gpAirports()for spawn and airfield data. - User labels — Create with
GamePlay.gpMakeUserLabel(); draw/delete withgpDrawUserLabel/gpDeleteUserLabel. Use GPUserLabel and GPUserIconType for properties and icon type. - Time — Use ITime from
Mission.TimeorGamePlay.gpTime()(see also Time And Difficulty).