Development < Lua Scripting < Lua ConstGame

Engine

string Game.version Returns the same as `spring --sync-version`, e.g. "92.0" or "91.0.1-1283-gf3805a7"

string Game.buildFlags (unsynced only) Gets additional engine buildflags, e.g. "OMP" or "MT-Sim DEBUG"

number Game.gameID Replaced in 89.0 with GameID(string gameID) synced callin

number Game.maxUnits
number Game.maxTeams
number Game.maxPlayers
number Game.squareSize
number Game.gameSpeed

Host

number Game.gameMode Removed from version 83.x
number Game.startPosType

boolean Game.commEnds Removed from version 83.x
boolean Game.limitDGun Removed from version 83.x
boolean Game.ghostedBuildings

Checksums

string Game.mapChecksum
string Game.modChecksum

Map

bool Game.mapDamage
string Game.mapName
string Game.mapDescription = string Game.mapHumanName
number Game.mapHardness
number Game.mapX
number Game.mapY
number Game.mapSizeX in worldspace/opengl coords
number Game.mapSizeZ in worldspace/opengl coords
number Game.gravity
number Game.tidal
number Game.windMin
number Game.windMax
number Game.extractorRadius
number Game.waterDamage

Mod

string Game.modName
string Game.modShortName
string Game.modVersion
string Game.modMutator
string Game.modDesc

boolean Game.allowTeamColors
number Game.transportAir
number Game.transportShip
number Game.transportHover
number Game.transportGround
number Game.fireAtKilled
number Game.fireAtCrashing
boolean Game.requireSonarUnderWater

Constructor

boolean Game.constructionDecay
number Game.constructionDecayTime
number Game.constructionDecaySpeed

number Game.multiReclaim
number Game.reclaimMethod
number Game.reclaimUnitMethod
number Game.reclaimUnitEnergyCostFactor
number Game.reclaimUnitEfficiency
number Game.reclaimFeatureEnergyCostFactor
boolean Game.reclaimAllowEnemies
boolean Game.reclaimAllowAllies
number Game.repairEnergyCostFactor
number Game.resurrectEnergyCostFactor
number Game.captureEnergyCostFactor

Categories

table Game.springCategories

 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
 }

table Game.armorTypes (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, ...
 }

Water Visuals

boolean Game.waterVoid
boolean Game.waterPlane
string Game.waterTexture
number Game.waterRepeatX
number Game.waterRepeatY
string Game.waterFoamTexture
string Game.waterNormalTexture
table Game.waterCausticTextures = {"tex1","tex2",..}
color Game.waterAbsorb = { number r, number g, number b}
color Game.waterBaseColor
color Game.waterMinColor
color Game.waterSurfaceColor
number Game.waterSurfaceAlpha
color Game.waterSpecularColor
number Game.waterSpecularFactor
color Game.waterPlaneColor
number Game.waterFresnelMin
number Game.waterFresnelMax
number Game.waterFresnelPower
color Game.fogColor
color Game.groundAmbientColor
color Game.groundSpecularColor
color Game.groundSunColor