Lua SyncedRead

From Spring
Revision as of 05:58, 28 September 2007 by JK (talk | contribs) (New page: '''Spring.ALL_UNITS''' -> number '''Spring.MY_UNITS''' -> number '''Spring.ALLY_UNITS''' -> number '''Spring.ENEMY_UNITS''' -> number '''Spring.IsCheatingEnabled''' ( ) -> boolean '''Sp...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Spring.ALL_UNITS -> number Spring.MY_UNITS -> number Spring.ALLY_UNITS -> number Spring.ENEMY_UNITS -> number

Spring.IsCheatingEnabled

 ( ) -> boolean

Spring.IsDevLuaEnabled

 ( ) -> boolean

Spring.IsEditDefsEnabled

 ( ) -> boolean

Spring.AreHelperAIsEnabled

 ( ) -> boolean

Spring.IsGameOver

 ( ) -> boolean

Spring.GetGaiaTeamID

 ( ) -> number teamID

Spring.GetRulesInfoMap

 ( string key ) -> string
 ( ) -> { [key1] = string value1, [key2] = string value2, ... }

Spring.GetGameSpeed

 ( ) -> number userSpeedFactor, number speedFactor, boolean paused

Spring.GetGameFrame

 ( ) -> number frameNum%dayFrames, number frameNum/dayFrames

Spring.GetGameSeconds

 ( ) -> number seconds

Spring.GetGameRulesParam

 ( number index | string ruleName ) -> number value

Spring.GetGameRulesParams

 ( ) -> { [rule1] = number value1, [rule2] = number value2, ... }

Spring.GetWind

 ( ) -> number dirX, number dirY, number dirZ, 
        number strength,  number normDirX, number normDirY, number normDirZ

Spring.GetHeadingFromVector

 ( number x, number z ) -> number heading

Spring.GetVectorFromHeading

 ( number heading ) -> number x, number z

Spring.GetAllyTeamStartBox

 ( number allyID ) -> number xmin, number zmin, number xmax, number zmax

Spring.GetTeamStartPosition

 ( number teamID ) -> number x, number y, number z

Spring.GetPlayerList

 ( [number teamID, boolean onlyActive] ) -> nil | { [1] = number playerID, etc... }

Spring.GetTeamList

 ( [number allyTeamID] ) -> nil | { [1] = number teamID, etc... }

Spring.GetAllyTeamList

 ( ) -> { [1] = number allyTeamID, etc... }

Spring.GetPlayerInfo

 ( number playerID ) -> 
   nil | string  "name",
         boolean active,
         boolean spectator,
         number  teamID,
         number  allyTeamID,
         number  pingTime,
         number  cpuUsage,
         string  country,
         number  rank

Spring.GetPlayerControlledUnit

 ( number playerID ) -> nil | number unitID

Spring.GetTeamInfo

 ( number teamID ) ->
   nil | number  teamNum,
         number  leader,
         boolean active,
         boolean isDead,
         boolean isAiTeam,
         string  "side",
         number  allyTeam

Spring.GetTeamResources

 ( number teamID, string "metal" | "energy" ) ->
   nil | number currentLevel,
         number storage,
         number pull,
         number income,
         number expense,
         number share,
         number sent,
         number received

Spring.GetTeamUnitStats

 ( number teamID ) ->
   nil | number killed,
         number died,
         number capturedBy,
         number capturedFrom,
         number received,
         number sent

Spring.GetTeamRulesParam

 ( number teamID, number index | string ruleName ) -> nil | number value

Spring.GetTeamRulesParams

 ( number teamID ) -> nil | { [rule1] = number value1, [rule2] = number value2, ... }

Spring.GetTeamStatsHistory

 ( number teamID, number startTime, number endTime ) ->
   {
     [1] = {
       "frame"            = number,
       "metalUsed"        = number,
       "metalProduced"    = number,
       "metalExcess"      = number,
       "metalReceived"    = number,
       "metalSent"        = number,
       "energyUsed"       = number,
       "energyProduced"   = number,
       "energyExcess"     = number,
       "energyReceived"   = number,
       "energySent"       = number,
       "damageDealt"      = number,
       "damageReceived"   = number,
       "unitsProduced"    = number,
       "unitsDied"        = number,
       "unitsReceived"    = number,
       "unitsSent"        = number,
       "unitsCaptured"    = number,
       "unitsOutCaptured" = number,
       "unitsKilled"      = number
     },
     [2] = {...}, ...
  }


Spring.AreTeamsAllied

 ( number teamID1, number teamID2 ) -> nil | boolean

Spring.ArePlayersAllied

 ( number playerID1, number playerID2 ) -> nil | boolean

Spring.GetAllUnits Spring.GetTeamUnits Spring.GetTeamUnitsSorted Spring.GetTeamUnitsCounts Spring.GetTeamUnitsByDefs Spring.GetTeamUnitDefCount Spring.GetTeamUnitCount

Spring.GetUnitsInRectangle Spring.GetUnitsInBox Spring.GetUnitsInPlanes Spring.GetUnitsInSphere Spring.GetUnitsInCylinder

Spring.GetFeaturesInRectangle

Spring.GetUnitNearestAlly Spring.GetUnitNearestEnemy

Spring.GetUnitTooltip Spring.GetUnitDefID Spring.GetUnitTeam Spring.GetUnitAllyTeam Spring.GetUnitLineage Spring.GetUnitNeutral Spring.GetUnitHealth Spring.GetUnitIsStunned Spring.GetUnitResources Spring.GetUnitExperience Spring.GetUnitStates Spring.GetUnitIsActive Spring.GetUnitIsCloaked Spring.GetUnitSelfDTime Spring.GetUnitStockpile Spring.GetUnitHeight Spring.GetUnitRadius Spring.GetUnitPosition Spring.GetUnitBasePosition Spring.GetUnitDirection Spring.GetUnitHeading Spring.GetUnitVelocity Spring.GetUnitBuildFacing Spring.GetUnitIsBuilding Spring.GetUnitTransporter Spring.GetUnitIsTransporting Spring.GetUnitShieldState Spring.GetUnitWeaponState Spring.GetUnitTravel Spring.GetUnitLosState Spring.GetUnitSeparation Spring.GetUnitDefDimensions

Spring.GetUnitCommands Spring.GetFactoryCounts Spring.GetFactoryCommands

Spring.GetCommandQueue Spring.GetFullBuildQueue Spring.GetRealBuildQueue

Spring.GetUnitCmdDescs Spring.FindUnitCmdDesc

Spring.GetUnitRulesParam Spring.GetUnitRulesParams

Spring.GetAllFeatures Spring.GetFeatureList Spring.GetFeatureDefID Spring.GetFeatureTeam Spring.GetFeatureAllyTeam Spring.GetFeatureHealth Spring.GetFeatureHeight Spring.GetFeatureRadius Spring.GetFeaturePosition Spring.GetFeatureDirection Spring.GetFeatureHeading Spring.GetFeatureResources Spring.GetFeatureNoSelect Spring.GetFeatureResurrect

Spring.GetGroundHeight Spring.GetGroundNormal Spring.GetGroundInfo Spring.GetGroundBlocked Spring.GetGroundExtremes

Spring.TestBuildOrder Spring.Pos2BuildPos Spring.GetPositionLosState Spring.GetClosestValidPosition

Spring.GetUnitPiecePosition Spring.GetUnitPieceDirection Spring.GetUnitPieceMatrix