global Game

Game specific information

[source]

---

fields

---

Game.maxUnits

---

Game.maxUnits : number

Game.maxTeams

---

Game.maxTeams : number

Game.maxPlayers

---

Game.maxPlayers : number

Game.squareSize

---

Game.squareSize : number

Divide Game.mapSizeX or Game.mapSizeZ by this to get engine’s “mapDims” coordinates. The resolution of height, yard and type maps.

Game.metalMapSquareSize

---

Game.metalMapSquareSize : number

The resolution of metalmap (for use in API such as Spring.GetMetalAmount etc.)

Game.gameSpeed

---

Game.gameSpeed : number

Number of simulation gameframes per second

Game.startPosType

---

Game.startPosType : number

Game.ghostedBuildings

---

Game.ghostedBuildings : boolean

Game.mapChecksum

---

Game.mapChecksum : string

Game.modChecksum

---

Game.modChecksum : string

Game.mapDamage

---

Game.mapDamage : boolean

Game.mapName

---

Game.mapName : string

Game.mapDescription

---

Game.mapDescription : string

= string Game.mapHumanName

Game.mapHardness

---

Game.mapHardness : number

Game.mapX

---

Game.mapX : number

Game.mapY

---

Game.mapY : number

Game.mapSizeX

---

Game.mapSizeX : number

in worldspace/opengl coords. Divide by Game.squareSize to get engine’s “mapDims” coordinates

Game.mapSizeZ

---

Game.mapSizeZ : number

in worldspace/opengl coords. Divide by Game.squareSize to get engine’s “mapDims” coordinates

Game.gravity

---

Game.gravity : number

Game.tidal

---

Game.tidal : number

Game.windMin

---

Game.windMin : number

Game.windMax

---

Game.windMax : number

Game.extractorRadius

---

Game.extractorRadius : number

Game.waterDamage

---

Game.waterDamage : number

Game.envDamageTypes

---

Game.envDamageTypes: table

Containing {def}IDs of environmental-damage sources

Game.gameName

---

Game.gameName : string

Game.gameShortName

---

Game.gameShortName : string

Game.gameVersion

---

Game.gameVersion : string

Game.gameMutator

---

Game.gameMutator : string

Game.gameDesc

---

Game.gameDesc : string

Game.requireSonarUnderWater

---

Game.requireSonarUnderWater : boolean

Game.transportAir

---

Game.transportAir : number

Game.transportShip

---

Game.transportShip : number

Game.transportHover

---

Game.transportHover : number

Game.transportGround

---

Game.transportGround : number

Game.fireAtKilled

---

Game.fireAtKilled : number

Game.fireAtCrashing

---

Game.fireAtCrashing : number

Game.constructionDecay

---

Game.constructionDecay : boolean

Game.reclaimAllowEnemies

---

Game.reclaimAllowEnemies : boolean

Game.reclaimAllowAllies

---

Game.reclaimAllowAllies : boolean

Game.constructionDecayTime

---

Game.constructionDecayTime : number

Game.constructionDecaySpeed

---

Game.constructionDecaySpeed : number

Game.multiReclaim

---

Game.multiReclaim : number

Game.reclaimMethod

---

Game.reclaimMethod : number

Game.reclaimUnitMethod

---

Game.reclaimUnitMethod : number

Game.reclaimUnitEnergyCostFactor

---

Game.reclaimUnitEnergyCostFactor : number

Game.reclaimUnitEfficiency

---

Game.reclaimUnitEfficiency : number

Game.reclaimFeatureEnergyCostFactor

---

Game.reclaimFeatureEnergyCostFactor : number

Game.repairEnergyCostFactor

---

Game.repairEnergyCostFactor : number

Game.resurrectEnergyCostFactor

---

Game.resurrectEnergyCostFactor : number

Game.captureEnergyCostFactor

---

Game.captureEnergyCostFactor : number

Game.springCategories

---

Game.springCategories : table<string,integer>

    example: {
      ["vtol"]         = 0,  ["special"]      = 1,  ["noweapon"]     = 2,
      ["notair"]       = 3,  ["notsub"]       = 4,  ["all"]          = 5,
      ["weapon"]       = 6,  ["notship"]      = 7,  ["notland"]      = 8,
      ["mobile"]       = 9,  ["kbot"]         = 10, ["antigator"]    = 11,
      ["tank"]         = 12, ["plant"]        = 13, ["ship"]         = 14,
      ["antiemg"]      = 15, ["antilaser"]    = 16, ["antiflame"]    = 17,
      ["underwater"]   = 18, ["hover"]        = 19, ["phib"]         = 20,
      ["constr"]       = 21, ["strategic"]    = 22, ["commander"]    = 23,
      ["paral"]        = 24, ["jam"]          = 25, ["mine"]         = 26,
      ["kamikaze"]     = 27, ["minelayer"]    = 28, ["notstructure"] = 29,
      ["air"]          = 30
    }

Game.armorTypes

---

Game.armorTypes : table<(string|integer),(integer|string)>

(bidirectional)

    example: {
      [1]  = amphibious,   [2] = anniddm,     [3] = antibomber,
      [4]  = antifighter,  [5] = antiraider,  [6] = atl,
      [7]  = blackhydra,   [8] = bombers,     [9] = commanders,
      [10] = crawlingbombs, ...

      ["amphibious"]   = 1, ["anniddm"]    = 2, ["antibomber"] = 3
      ["antifighter"]  = 4, ["antiraider"] = 5, ["atl"]        = 6
      ["blackhydra"]   = 7, ["bombers"]    = 8, ["commanders"] = 9
      ["crawlingbombs"]= 10, ...
    }

Game.textColorCodes

---

Game.textColorCodes : TextColorCode {
    Color: string,
    ColorAndOutline: string,
    Reset: string,
}

Table containing keys that represent the color code operations during font rendering