From b17e53c40cb3d4c845a94b277762ce36539feb27 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 17 Oct 2024 00:41:42 +0000 Subject: [PATCH] Update doc/site --- _data/configs.json | 561 +- _data/latest_release.json | 143 +- _data/synced_commands.json | 10 +- _data/unsynced_commands.json | 34 +- _data/weapondefs.json | 264 +- ldoc/classes/VAO.html | 558 ++ ldoc/classes/VBO.html | 910 +++ ldoc/index.html | 135 + ldoc/ldoc.css | 303 + ldoc/modules/BitOps.html | 330 + ldoc/modules/CMD.html | 305 + ldoc/modules/CMDTYPE.html | 136 + ldoc/modules/COB.html | 784 ++ ldoc/modules/Engine.html | 89 + ldoc/modules/FBO.html | 598 ++ ldoc/modules/GL.html | 3185 ++++++++ ldoc/modules/Game.html | 440 ++ ldoc/modules/LuaHandle.html | 4982 ++++++++++++ ldoc/modules/LuaHandleSynced.html | 2274 ++++++ ldoc/modules/LuaRules.html | 24 + ldoc/modules/LuaVAO.html | 69 + ldoc/modules/LuaVBO.html | 93 + ldoc/modules/LuaZip.html | 24 + ldoc/modules/MathExtra.html | 439 ++ ldoc/modules/MetalMap.html | 80 + ldoc/modules/MoveCtrl.html | 24 + ldoc/modules/OpenGL.html | 207 + ldoc/modules/Platform.html | 212 + ldoc/modules/RBO.html | 196 + ldoc/modules/Shaders.html | 806 ++ ldoc/modules/SyncedCtrl.html | 11699 ++++++++++++++++++++++++++++ ldoc/modules/SyncedRead.html | 11348 +++++++++++++++++++++++++++ ldoc/modules/UnsyncedCtrl.html | 8660 ++++++++++++++++++++ ldoc/modules/UnsyncedRead.html | 7120 +++++++++++++++++ ldoc/modules/VFS.html | 24 + 35 files changed, 56714 insertions(+), 352 deletions(-) create mode 100644 ldoc/classes/VAO.html create mode 100644 ldoc/classes/VBO.html create mode 100644 ldoc/index.html create mode 100644 ldoc/ldoc.css create mode 100644 ldoc/modules/BitOps.html create mode 100644 ldoc/modules/CMD.html create mode 100644 ldoc/modules/CMDTYPE.html create mode 100644 ldoc/modules/COB.html create mode 100644 ldoc/modules/Engine.html create mode 100644 ldoc/modules/FBO.html create mode 100644 ldoc/modules/GL.html create mode 100644 ldoc/modules/Game.html create mode 100644 ldoc/modules/LuaHandle.html create mode 100644 ldoc/modules/LuaHandleSynced.html create mode 100644 ldoc/modules/LuaRules.html create mode 100644 ldoc/modules/LuaVAO.html create mode 100644 ldoc/modules/LuaVBO.html create mode 100644 ldoc/modules/LuaZip.html create mode 100644 ldoc/modules/MathExtra.html create mode 100644 ldoc/modules/MetalMap.html create mode 100644 ldoc/modules/MoveCtrl.html create mode 100644 ldoc/modules/OpenGL.html create mode 100644 ldoc/modules/Platform.html create mode 100644 ldoc/modules/RBO.html create mode 100644 ldoc/modules/Shaders.html create mode 100644 ldoc/modules/SyncedCtrl.html create mode 100644 ldoc/modules/SyncedRead.html create mode 100644 ldoc/modules/UnsyncedCtrl.html create mode 100644 ldoc/modules/UnsyncedRead.html create mode 100644 ldoc/modules/VFS.html diff --git a/_data/configs.json b/_data/configs.json index 3b8dc3bac7..bd26a00c14 100644 --- a/_data/configs.json +++ b/_data/configs.json @@ -1,7 +1,7 @@ { "AdvMapShading": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 43, + "declarationLine": 47, "description": "Enable shaders for terrain rendering.", "defaultValue": 1, "safemodeValue": 0, @@ -9,13 +9,13 @@ }, "AdvSky": { "declarationFile": "/spring/rts/Rendering/Env/ISky.cpp", - "declarationLine": 19, + "declarationLine": 21, "deprecated": 1, "type": "bool" }, "AdvUnitShading": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 67, + "declarationLine": 69, "description": "Determines whether specular highlights and other lighting effects are rendered for units.", "defaultValue": 1, "safemodeValue": 0, @@ -24,7 +24,8 @@ }, "AllowDeferredMapRendering": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 44, + "declarationLine": 48, + "description": "Enable rendering the map to the map deferred buffers.", "defaultValue": 0, "safemodeValue": 0, "type": "bool" @@ -39,31 +40,36 @@ "AllowDeferredModelRendering": { "declarationFile": "/spring/rts/Rendering/LuaObjectDrawer.cpp", "declarationLine": 31, + "description": "Allows the rendering of model deferred buffers.", "defaultValue": 0, "safemodeValue": 0, "type": "bool" }, "AllowDrawMapDeferredEvents": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 46, + "declarationLine": 50, + "description": "Enable DrawGroundDeferred Lua callin.", "defaultValue": 0, "type": "bool" }, "AllowDrawMapPostDeferredEvents": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 45, + "declarationLine": 49, + "description": "Enable DrawGroundPostDeferred Lua callin.", "defaultValue": 0, "type": "bool" }, "AllowDrawModelPostDeferredEvents": { "declarationFile": "/spring/rts/Rendering/LuaObjectDrawer.cpp", "declarationLine": 33, + "description": "Enable Draw{Units,Features}PostDeferred Lua callins.", "defaultValue": 1, "type": "bool" }, "AllowMultiSampledFrameBuffers": { "declarationFile": "/spring/rts/Rendering/LuaObjectDrawer.cpp", "declarationLine": 34, + "description": "Enable FBOs that can have multisampled anti-aliasing.", "defaultValue": 0, "type": "bool" }, @@ -77,14 +83,23 @@ }, "AlwaysSendDrawGroundEvents": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 55, + "declarationLine": 59, "description": "Always send DrawGround{Pre,Post}{Forward,Deferred} events", "defaultValue": 0, "type": "bool" }, + "AnimationMT": { + "declarationFile": "/spring/rts/Sim/Units/Scripts/UnitScriptEngine.cpp", + "declarationLine": 20, + "description": "Enable multithreaded execution of animation ticks", + "defaultValue": 1, + "minimumValue": 0, + "safemodeValue": 0, + "type": "bool" + }, "AtiHacks": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 57, + "declarationLine": 58, "description": "Enables graphics drivers workarounds for users with AMD proprietary drivers.\n -1:=runtime detect, 0:=off, 1:=on", "defaultValue": -1, "minimumValue": -1, @@ -94,20 +109,20 @@ }, "AtiSwapRBFix": { "declarationFile": "/spring/rts/Rendering/GL/FBO.cpp", - "declarationLine": 16, + "declarationLine": 18, "defaultValue": 0, "type": "bool" }, "AutoAddBuiltUnitsToFactoryGroup": { "declarationFile": "/spring/rts/Game/SelectedUnitsHandler.cpp", - "declarationLine": 49, + "declarationLine": 51, "description": "Controls whether or not units built by factories will inherit that factory's unit group.", "defaultValue": 0, "type": "bool" }, "AutoAddBuiltUnitsToSelectedGroup": { "declarationFile": "/spring/rts/Game/SelectedUnitsHandler.cpp", - "declarationLine": 50, + "declarationLine": 52, "defaultValue": 0, "type": "bool" }, @@ -120,12 +135,13 @@ "AutohostPort": { "declarationFile": "/spring/rts/Net/GameServer.cpp", "declarationLine": 69, + "description": "Which port should the engine listen on for Autohost interfact connections.", "defaultValue": 0, "type": "int" }, "BlockCompositing": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 69, + "declarationLine": 70, "description": "Disables kwin compositing to fix tearing, possible fixes low FPS in windowed mode, too.", "defaultValue": 0, "safemodeValue": 1, @@ -133,26 +149,26 @@ }, "BuildIconsFirst": { "declarationFile": "/spring/rts/Game/SelectedUnitsHandler.cpp", - "declarationLine": 48, + "declarationLine": 50, "defaultValue": 0, "type": "bool" }, "BumpWaterAnisotropy": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 45, + "declarationLine": 47, "defaultValue": 0, "minimumValue": 0, "type": "float" }, "BumpWaterBlurReflection": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 48, + "declarationLine": 50, "defaultValue": 0, "type": "bool" }, "BumpWaterDepthBits": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 47, + "declarationLine": 49, "defaultValue": 24, "minimumValue": 16, "maximumValue": 32, @@ -160,26 +176,26 @@ }, "BumpWaterDynamicWaves": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 51, + "declarationLine": 53, "defaultValue": 1, "type": "bool" }, "BumpWaterEndlessOcean": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 50, + "declarationLine": 52, "description": "Sets whether Bumpmapped water will be drawn beyond the map edge.", "defaultValue": 1, "type": "bool" }, "BumpWaterOcclusionQuery": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 53, + "declarationLine": 55, "deprecated": 1, "type": "bool" }, "BumpWaterReflection": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 43, + "declarationLine": 45, "description": "Determines the amount of objects reflected in Bumpmapped water.\n0:=off, 1:=fast (skip terrain), 2:=full", "defaultValue": 1, "minimumValue": 0, @@ -189,7 +205,7 @@ }, "BumpWaterRefraction": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 44, + "declarationLine": 46, "description": "Determines the method of refraction with Bumpmapped water.\n0:=off, 1:=screencopy, 2:=own rendering cycle (disabled)", "defaultValue": 1, "minimumValue": 0, @@ -199,7 +215,7 @@ }, "BumpWaterShoreWaves": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 49, + "declarationLine": 51, "description": "Enables rendering of shorewaves.", "defaultValue": 1, "safemodeValue": 0, @@ -208,7 +224,7 @@ }, "BumpWaterTexSizeReflection": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 42, + "declarationLine": 44, "description": "Sets the size of the framebuffer texture used to store the reflection in Bumpmapped water.", "defaultValue": 512, "minimumValue": 32, @@ -217,20 +233,20 @@ }, "BumpWaterUseDepthTexture": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 46, + "declarationLine": 48, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "BumpWaterUseUniforms": { "declarationFile": "/spring/rts/Rendering/Env/BumpWater.cpp", - "declarationLine": 52, + "declarationLine": 54, "deprecated": 1, "type": "bool" }, "CamFrameTimeCorrection": { "declarationFile": "/spring/rts/Game/Camera.cpp", - "declarationLine": 33, + "declarationLine": 35, "description": "Sets wether the camera interpolation factor should be the inverse of fps or last draw frame time (0 = lastdrawframetime, 1 = fpsinv)", "defaultValue": 0, "minimumValue": 0, @@ -238,82 +254,82 @@ }, "CamFreeAngVelTime": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 29, + "declarationLine": 31, "defaultValue": 1, "type": "float" }, "CamFreeAutoTilt": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 27, + "declarationLine": 29, "description": "When free camera is locked, AutoTilt will point the camera in the direction of the ground's slope", "defaultValue": 150, "type": "float" }, "CamFreeEnabled": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 18, + "declarationLine": 20, "defaultValue": 0, "type": "bool" }, "CamFreeFOV": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 21, + "declarationLine": 23, "defaultValue": 45, "type": "float" }, "CamFreeGoForward": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 20, + "declarationLine": 22, "defaultValue": 0, "type": "bool" }, "CamFreeGravity": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 23, + "declarationLine": 25, "description": "When free camera is locked, Gravity will be used if you jump off of a ground ramp.", "defaultValue": -500, "type": "float" }, "CamFreeGroundOffset": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 25, + "declarationLine": 27, "description": "Determines ground handling for the free camera.\n0 - the camera can move anywhere,\n< 0 - the camera is always offset from the ground height by -CamFreeGroundOffset\n> 0 - the camera can be \"locked\" to the ground by using SHIFT UP_ARROW. (and will use CamFreeGroundOffset as the offset). To release the lock, simply press SHIFT DOWN_ARROW.", "defaultValue": 16, "type": "float" }, "CamFreeInvertAlt": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 19, + "declarationLine": 21, "defaultValue": 0, "type": "bool" }, "CamFreeScrollSpeed": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 22, + "declarationLine": 24, "defaultValue": 500, "type": "float" }, "CamFreeSlide": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 24, + "declarationLine": 26, "defaultValue": 0.5, "type": "float" }, "CamFreeTiltSpeed": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 26, + "declarationLine": 28, "defaultValue": 150, "type": "float" }, "CamFreeVelTime": { "declarationFile": "/spring/rts/Game/Camera/FreeController.cpp", - "declarationLine": 28, + "declarationLine": 30, "defaultValue": 1.5, "type": "float" }, "CamMode": { "declarationFile": "/spring/rts/Game/CameraHandler.cpp", - "declarationLine": 41, + "declarationLine": 43, "description": "Defines the used camera. Options are:\n0 = FPS\n1 = Overhead\n2 = Spring\n3 = RotOverhead\n4 = Free\n5 = Overview", "defaultValue": 2, "minimumValue": 0, @@ -322,79 +338,93 @@ }, "CamModeName": { "declarationFile": "/spring/rts/Game/CameraHandler.cpp", - "declarationLine": 39, + "declarationLine": 41, "defaultValue": "", "type": "std::string" }, "CamOverheadFastScale": { "declarationFile": "/spring/rts/Game/Camera/OverheadController.cpp", - "declarationLine": 24, + "declarationLine": 26, "description": "Scaling for CameraMoveFastMult.", "defaultValue": 0.3, "type": "float" }, + "CamOverviewDynamicRotation": { + "declarationFile": "/spring/rts/Game/Camera/OverviewController.cpp", + "declarationLine": 15, + "description": "Transition from different camera preserves rotation", + "defaultValue": 0, + "type": "bool" + }, "CamSpringEdgeRotate": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 24, + "declarationLine": 35, "description": "Rotate camera when cursor touches screen borders.", "defaultValue": 0, "type": "bool" }, "CamSpringEnabled": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 18, + "declarationLine": 29, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "CamSpringFOV": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 20, + "declarationLine": 31, "defaultValue": 45, "type": "float" }, "CamSpringFastScaleMouseMove": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 25, + "declarationLine": 36, "description": "Scaling for CameraMoveFastMult in spring camera mode while moving mouse.", "defaultValue": 0.3, "type": "float" }, "CamSpringFastScaleMousewheelMove": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 26, + "declarationLine": 37, "description": "Scaling for CameraMoveFastMult in spring camera mode while scrolling with mouse.", "defaultValue": 0.2, "type": "float" }, "CamSpringLockCardinalDirections": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 21, + "declarationLine": 32, "description": "Whether cardinal directions should be `locked` for a short time when rotating.", "defaultValue": 1, "type": "bool" }, "CamSpringScrollSpeed": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 19, + "declarationLine": 30, "defaultValue": 10, "type": "int" }, + "CamSpringTrackMapHeightMode": { + "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", + "declarationLine": 38, + "description": "Camera height is influenced by terrain height. 0=Static 1=Terrain 2=Smoothmesh", + "defaultValue": 1, + "type": "int" + }, "CamSpringZoomInToMousePos": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 22, + "declarationLine": 33, "defaultValue": 1, "type": "bool" }, "CamSpringZoomOutFromMousePos": { "declarationFile": "/spring/rts/Game/Camera/SpringController.cpp", - "declarationLine": 23, + "declarationLine": 34, "defaultValue": 0, "type": "bool" }, "CamTimeExponent": { "declarationFile": "/spring/rts/Game/CameraHandler.cpp", - "declarationLine": 59, + "declarationLine": 61, "description": "Camera transitions happen at lerp(old, new, timeNorm ^ CamTimeExponent).", "defaultValue": 4, "minimumValue": 0, @@ -402,7 +432,7 @@ }, "CamTimeFactor": { "declarationFile": "/spring/rts/Game/CameraHandler.cpp", - "declarationLine": 54, + "declarationLine": 56, "description": "Scales the speed of camera transitions, e.g. zooming or position change.", "defaultValue": 1, "minimumValue": 0, @@ -410,7 +440,7 @@ }, "CameraMoveFastMult": { "declarationFile": "/spring/rts/Game/Camera.cpp", - "declarationLine": 25, + "declarationLine": 27, "description": "The multiplier applied to speed when camera is in movefast state.", "defaultValue": 10, "minimumValue": 1, @@ -418,7 +448,7 @@ }, "CameraMoveSlowMult": { "declarationFile": "/spring/rts/Game/Camera.cpp", - "declarationLine": 29, + "declarationLine": 31, "description": "The multiplier applied to speed when camera is in moveslow state.", "defaultValue": 0.1, "maximumValue": 1, @@ -433,7 +463,7 @@ }, "CompressTextures": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 60, + "declarationLine": 61, "description": "Runtime compress most textures to save VideoRAM.", "defaultValue": 0, "safemodeValue": 1, @@ -441,52 +471,55 @@ }, "CrossAlpha": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 56, + "declarationLine": 62, "defaultValue": 0.5, "type": "float" }, "CrossMoveScale": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 57, + "declarationLine": 63, "defaultValue": 1, "type": "float" }, "CrossSize": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 55, + "declarationLine": 61, "defaultValue": 12, "type": "float" }, "CubeTexGenerateMipMaps": { "declarationFile": "/spring/rts/Rendering/Env/CubeMapHandler.cpp", - "declarationLine": 21, + "declarationLine": 23, + "description": "Generate mipmaps for the reflection and specular cubemap textures, useful for efficient subsampling and blurring.", "defaultValue": 0, "type": "bool" }, "CubeTexSizeReflection": { "declarationFile": "/spring/rts/Rendering/Env/CubeMapHandler.cpp", - "declarationLine": 20, + "declarationLine": 22, + "description": "The square resolution of each face of the environment reflection cubemap.", "defaultValue": 128, "minimumValue": 1, "type": "int" }, "CubeTexSizeSpecular": { "declarationFile": "/spring/rts/Rendering/Env/CubeMapHandler.cpp", - "declarationLine": 19, + "declarationLine": 21, + "description": "The square resolution of each face of the specular cubemap.", "defaultValue": 128, "minimumValue": 1, "type": "int" }, "DebugGL": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 42, + "declarationLine": 43, "description": "Enables GL debug-context and output. (see GL_ARB_debug_output)", "defaultValue": 0, "type": "bool" }, "DebugGLStacktraces": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 43, + "declarationLine": 44, "description": "Create a stacktrace when an OpenGL error occurs", "defaultValue": 0, "type": "bool" @@ -500,7 +533,7 @@ }, "DefaultStartScript": { "declarationFile": "/spring/rts/System/SpringApp.cpp", - "declarationLine": 112, + "declarationLine": 115, "description": "filename of script.txt to use when no command line parameters are specified.", "defaultValue": "", "type": "std::string" @@ -508,6 +541,7 @@ "DemoFromDemo": { "declarationFile": "/spring/rts/Game/PreGame.cpp", "declarationLine": 60, + "description": "Enable recording a demo while playing back a demo.", "defaultValue": 0, "type": "bool" }, @@ -528,28 +562,28 @@ }, "DoubleClickTime": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 59, + "declarationLine": 65, "description": "Double click time in milliseconds.", "defaultValue": 200, "type": "float" }, "DualScreenMiniMapAspectRatio": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 71, + "declarationLine": 79, "description": "Whether minimap preserves aspect ratio on dual screen mode.", "defaultValue": 1, "type": "bool" }, "DualScreenMiniMapOnLeft": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 62, + "declarationLine": 63, "description": "When set, will make the left half of the screen the minimap when DualScreenMode is set.", "defaultValue": 0, "type": "bool" }, "DualScreenMode": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 61, + "declarationLine": 62, "description": "Sets whether to split the screen in half, with one half for minimap and one for main screen. Right side is for minimap unless DualScreenMiniMapOnLeft is set.", "defaultValue": 0, "type": "bool" @@ -557,19 +591,20 @@ "DumpGameStateOnDesync": { "declarationFile": "/spring/rts/System/GlobalConfig.cpp", "declarationLine": 63, - "defaultValue": 0, + "description": "Enable writing clientgamestate and servergamestate dumps when a desync is detected", + "defaultValue": 1, "type": "bool" }, "EdgeMoveDynamic": { "declarationFile": "/spring/rts/Game/Camera.cpp", - "declarationLine": 22, + "declarationLine": 24, "description": "If EdgeMove scrolling speed should fade with edge distance.", "defaultValue": 1, "type": "bool" }, "EdgeMoveWidth": { "declarationFile": "/spring/rts/Game/Camera.cpp", - "declarationLine": 18, + "declarationLine": 20, "description": "The width (in percent of screen size) of the EdgeMove scrolling area.", "defaultValue": 0.02, "minimumValue": 0, @@ -584,49 +619,49 @@ }, "FPSClampPos": { "declarationFile": "/spring/rts/Game/Camera/FPSController.cpp", - "declarationLine": 18, + "declarationLine": 20, "defaultValue": 1, "type": "bool" }, "FPSEnabled": { "declarationFile": "/spring/rts/Game/Camera/FPSController.cpp", - "declarationLine": 16, + "declarationLine": 18, "defaultValue": 1, "type": "bool" }, "FPSFOV": { "declarationFile": "/spring/rts/Game/Camera/FPSController.cpp", - "declarationLine": 17, + "declarationLine": 19, "defaultValue": 45, "type": "float" }, "FPSMouseScale": { "declarationFile": "/spring/rts/Game/Camera/FPSController.cpp", - "declarationLine": 15, + "declarationLine": 17, "defaultValue": 0.01, "type": "float" }, "FPSScrollSpeed": { "declarationFile": "/spring/rts/Game/Camera/FPSController.cpp", - "declarationLine": 14, + "declarationLine": 16, "defaultValue": 10, "type": "int" }, "FSAA": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 80, + "declarationLine": 81, "deprecated": 1, "type": "bool" }, "FSAALevel": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 81, + "declarationLine": 82, "deprecated": 1, "type": "int" }, "FeatureDrawDistance": { "declarationFile": "/spring/rts/Rendering/Features/FeatureDrawerData.cpp", - "declarationLine": 14, + "declarationLine": 16, "description": "Maximum distance at which features will be drawn.", "defaultValue": 6000, "minimumValue": 0, @@ -634,7 +669,7 @@ }, "FeatureFadeDistance": { "declarationFile": "/spring/rts/Rendering/Features/FeatureDrawerData.cpp", - "declarationLine": 19, + "declarationLine": 21, "description": "Distance at which features will begin to fade from view.", "defaultValue": 4500, "minimumValue": 0, @@ -642,35 +677,35 @@ }, "FontFile": { "declarationFile": "/spring/rts/Rendering/Fonts/glFont.cpp", - "declarationLine": 22, + "declarationLine": 24, "description": "Sets the font of Spring engine text.", "defaultValue": "fonts/FreeSansBold.otf", "type": "std::string" }, "FontOutlineWeight": { "declarationFile": "/spring/rts/Rendering/Fonts/glFont.cpp", - "declarationLine": 29, + "declarationLine": 31, "description": "Sets the opacity of Spring engine text, such as the title screen version number, clock, and basic UI. Does not affect LuaUI elements.", "defaultValue": 25, "type": "float" }, "FontOutlineWidth": { "declarationFile": "/spring/rts/Rendering/Fonts/glFont.cpp", - "declarationLine": 27, + "declarationLine": 29, "description": "Sets the width of the black outline around Spring engine text, such as the title screen version number, clock, and basic UI. Does not affect LuaUI elements.", "defaultValue": 3, "type": "int" }, "FontSize": { "declarationFile": "/spring/rts/Rendering/Fonts/glFont.cpp", - "declarationLine": 25, + "declarationLine": 27, "description": "Sets the font size (in pixels) of the MainMenu and more.", "defaultValue": 23, "type": "int" }, "ForceCoreContext": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 55, + "declarationLine": 56, "defaultValue": 0, "minimumValue": 0, "maximumValue": 1, @@ -678,7 +713,7 @@ }, "ForceDisableClipCtrl": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 51, + "declarationLine": 52, "defaultValue": 0, "minimumValue": 0, "maximumValue": 1, @@ -686,7 +721,7 @@ }, "ForceDisableExplicitAttribLocs": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 50, + "declarationLine": 51, "defaultValue": 0, "minimumValue": 0, "maximumValue": 1, @@ -694,7 +729,7 @@ }, "ForceDisableGL4": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 53, + "declarationLine": 54, "defaultValue": 0, "minimumValue": 0, "maximumValue": 1, @@ -703,7 +738,7 @@ }, "ForceDisablePersistentMapping": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 49, + "declarationLine": 50, "defaultValue": 0, "minimumValue": 0, "maximumValue": 1, @@ -711,13 +746,13 @@ }, "ForceDisableShaders": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 82, + "declarationLine": 83, "deprecated": 1, "type": "bool" }, "ForceSwapBuffers": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 56, + "declarationLine": 57, "defaultValue": 1, "minimumValue": 0, "maximumValue": 1, @@ -725,7 +760,7 @@ }, "Fullscreen": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 67, + "declarationLine": 68, "description": "Sets whether the game will run in fullscreen, as opposed to a window. For Windowed Fullscreen of Borderless Window, set this to 0, WindowBorderless to 1, and WindowPosX and WindowPosY to 0.", "defaultValue": 1, "headlessValue": 0, @@ -733,14 +768,14 @@ }, "FullscreenEdgeMove": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 136, + "declarationLine": 143, "description": "see WindowedEdgeMove, just for fullscreen mode", "defaultValue": 1, "type": "bool" }, "GLContextMajorVersion": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 45, + "declarationLine": 46, "defaultValue": 3, "minimumValue": 3, "maximumValue": 4, @@ -748,7 +783,7 @@ }, "GLContextMinorVersion": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 46, + "declarationLine": 47, "defaultValue": 0, "minimumValue": 0, "maximumValue": 5, @@ -756,13 +791,13 @@ }, "GameEndOnConnectionLoss": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 132, + "declarationLine": 139, "defaultValue": 1, "type": "bool" }, "GrassDetail": { "declarationFile": "/spring/rts/Rendering/Env/GrassDrawer.cpp", - "declarationLine": 35, + "declarationLine": 37, "description": "Sets how detailed the engine rendered grass will be on any given map.", "defaultValue": 7, "minimumValue": 0, @@ -771,21 +806,15 @@ }, "GroundDecals": { "declarationFile": "/spring/rts/Rendering/Env/IGroundDecalDrawer.cpp", - "declarationLine": 12, + "declarationLine": 14, "description": "Controls whether ground decals underneath buildings and ground scars from explosions will be rendered. Values >1 define how long such decals will stay.", "defaultValue": 3, "headlessValue": 0, "type": "int" }, - "GroundDecalsParallaxMapping": { - "declarationFile": "/spring/rts/Rendering/Env/Decals/DecalsDrawerGL4.cpp", - "declarationLine": 47, - "defaultValue": 1, - "type": "bool" - }, "GroundDetail": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 30, + "declarationLine": 34, "description": "Controls how detailed the map geometry will be. On lowered settings, cliffs may appear to be jagged or \"melting\".", "defaultValue": 60, "minimumValue": 4, @@ -815,19 +844,19 @@ }, "GroundNormalTextureHighPrecision": { "declarationFile": "/spring/rts/Map/SMF/SMFReadMap.cpp", - "declarationLine": 35, - "defaultValue": 0, + "declarationLine": 39, + "deprecated": 1, "type": "bool" }, "GroundScarAlphaFade": { "declarationFile": "/spring/rts/Rendering/Env/Decals/GroundDecalHandler.cpp", - "declarationLine": 55, - "defaultValue": 0, + "declarationLine": 61, + "deprecated": 1, "type": "int" }, "GuiOpacity": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 142, + "declarationLine": 149, "description": "Sets the opacity of the built-in Spring UI. Generally has no effect on LuaUI widgets. Can be set in-game using shift+, to decrease and shift+. to increase.", "defaultValue": 0.8, "minimumValue": 0, @@ -845,14 +874,22 @@ }, "HardwareCursor": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 50, + "declarationLine": 56, "description": "Sets hardware mouse cursor rendering. If you have a low framerate, your mouse cursor will seem \"laggy\". Setting hardware cursor will render the mouse cursor separately from spring and the mouse will behave normally. Note, not all GPU drivers support it in fullscreen mode!", "defaultValue": 0, "type": "bool" }, + "HighQualityDecals": { + "declarationFile": "/spring/rts/Rendering/Env/Decals/GroundDecalHandler.cpp", + "declarationLine": 62, + "description": "Forces MSAA processing of decals. Improves decals quality, but may ruin the performance.", + "defaultValue": 0, + "type": "bool" + }, "HighResInfoTexture": { "declarationFile": "/spring/rts/Rendering/Map/InfoTexture/Modern/Combiner.cpp", - "declarationLine": 14, + "declarationLine": 16, + "description": "Use full heightmap resolution info texture (true), or half resolution (false)", "defaultValue": 1, "type": "bool" }, @@ -865,7 +902,7 @@ }, "HostIPDefault": { "declarationFile": "/spring/rts/Game/ClientSetup.cpp", - "declarationLine": 16, + "declarationLine": 18, "description": "Default IP to use for hosting if not specified in script.txt", "defaultValue": "localhost", "dedicatedValue": "", @@ -873,7 +910,7 @@ }, "HostPortDefault": { "declarationFile": "/spring/rts/Game/ClientSetup.cpp", - "declarationLine": 17, + "declarationLine": 19, "description": "Default Port to use for hosting if not specified in script.txt", "defaultValue": 8452, "minimumValue": 0, @@ -882,13 +919,13 @@ }, "InfoConsoleGeometry": { "declarationFile": "/spring/rts/Game/UI/InfoConsole.cpp", - "declarationLine": 14, + "declarationLine": 16, "defaultValue": "0.26 0.96 0.41 0.205", "type": "std::string" }, "InfoMessageTime": { "declarationFile": "/spring/rts/Game/UI/InfoConsole.cpp", - "declarationLine": 13, + "declarationLine": 15, "description": "Time until old messages disappear from the ingame console.", "defaultValue": 10, "type": "int" @@ -896,31 +933,32 @@ "InitialNetworkTimeout": { "declarationFile": "/spring/rts/System/GlobalConfig.cpp", "declarationLine": 15, + "description": "Time to wait for the initial connection to the game server.", "defaultValue": 30, "minimumValue": 10, "type": "int" }, "InputTextGeo": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 143, + "declarationLine": 150, "defaultValue": "", "type": "std::string" }, "InvertMouse": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 51, + "declarationLine": 57, "defaultValue": 0, "type": "bool" }, "InvertQueueKey": { "declarationFile": "/spring/rts/Game/UI/GuiHandler.cpp", - "declarationLine": 60, + "declarationLine": 63, "defaultValue": 0, "type": "bool" }, "KeyChainTimeout": { "declarationFile": "/spring/rts/Game/UI/KeyBindings.cpp", - "declarationLine": 29, + "declarationLine": 31, "description": "Timeout in milliseconds waiting for a key chain shortcut.", "defaultValue": 750, "minimumValue": 0, @@ -1056,7 +1094,8 @@ }, "LuaGarbageCollectionMemLoadMult": { "declarationFile": "/spring/rts/Lua/LuaHandle.cpp", - "declarationLine": 59, + "declarationLine": 61, + "description": "How much the amount of Lua memory in use increases the rate of garbage collection.", "defaultValue": 1.33, "minimumValue": 1, "maximumValue": 100, @@ -1064,8 +1103,8 @@ }, "LuaGarbageCollectionRunTimeMult": { "declarationFile": "/spring/rts/Lua/LuaHandle.cpp", - "declarationLine": 60, - "description": "in milliseconds", + "declarationLine": 62, + "description": "How many milliseconds the garbage collected can run for in each GC cycle", "defaultValue": 5, "minimumValue": 1, "type": "float" @@ -1094,7 +1133,7 @@ }, "MSAALevel": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 47, + "declarationLine": 48, "description": "Enables multisample anti-aliasing; 'level' is the number of samples used.", "defaultValue": 0, "minimumValue": 0, @@ -1103,28 +1142,36 @@ }, "MapBorder": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 36, + "declarationLine": 40, "description": "Draws a solid border at the edges of the map.", "defaultValue": 1, "type": "bool" }, "MaxDynamicMapLights": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 39, + "declarationLine": 43, + "description": "Maximum number of map-global dynamic lights that will be rendered at once. High numbers of lights cost performance, as they affect every map fragment.", "defaultValue": 1, "minimumValue": 0, "type": "int" }, "MaxDynamicModelLights": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 63, + "declarationLine": 65, "defaultValue": 1, "minimumValue": 0, "type": "int" }, + "MaxFontTries": { + "declarationFile": "/spring/rts/System/SpringApp.cpp", + "declarationLine": 112, + "description": "Represents the maximum number of attempts to search for a glyph replacement using the FontConfig library (lower = foreign glyphs may fail to render, higher = searching for foreign glyphs can lag the game).", + "defaultValue": 5, + "type": "int" + }, "MaxNanoParticles": { "declarationFile": "/spring/rts/Sim/Projectiles/ProjectileHandler.cpp", - "declarationLine": 42, + "declarationLine": 44, "defaultValue": 2000, "minimumValue": 0, "headlessValue": 0, @@ -1132,7 +1179,7 @@ }, "MaxParticles": { "declarationFile": "/spring/rts/Sim/Projectiles/ProjectileHandler.cpp", - "declarationLine": 41, + "declarationLine": 43, "defaultValue": 10000, "minimumValue": 0, "headlessValue": 0, @@ -1149,16 +1196,18 @@ }, "MaxTextureAtlasSizeX": { "declarationFile": "/spring/rts/Rendering/Textures/TextureAtlas.cpp", - "declarationLine": 22, - "defaultValue": 2048, + "declarationLine": 24, + "description": "The max X size of the projectile and Lua texture atlasses", + "defaultValue": 4096, "minimumValue": 512, "maximumValue": 32768, "type": "int" }, "MaxTextureAtlasSizeY": { "declarationFile": "/spring/rts/Rendering/Textures/TextureAtlas.cpp", - "declarationLine": 23, - "defaultValue": 2048, + "declarationLine": 25, + "description": "The max Y size of the projectile and Lua texture atlasses", + "defaultValue": 4096, "minimumValue": 512, "maximumValue": 32768, "type": "int" @@ -1179,39 +1228,53 @@ }, "MiddleClickScrollSpeed": { "declarationFile": "/spring/rts/Game/Camera/OverheadController.cpp", - "declarationLine": 18, + "declarationLine": 20, "defaultValue": 0.01, "type": "float" }, + "MinDrawFPS": { + "declarationFile": "/spring/rts/System/GlobalConfig.cpp", + "declarationLine": 66, + "description": "Defines how many frames per second should minimally be rendered. To reach this number we will delay simframes.", + "defaultValue": 2, + "type": "int" + }, + "MinSimDrawBalance": { + "declarationFile": "/spring/rts/System/GlobalConfig.cpp", + "declarationLine": 65, + "description": "Percent of the time for simulation is minimum spend for drawing. E.g. if set to 0.15 then 15% of the total cpu time is exclusively reserved for drawing.", + "defaultValue": 0.15, + "type": "float" + }, "MiniMapButtonSize": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 53, + "declarationLine": 61, "defaultValue": 16, "type": "int" }, "MiniMapCanDraw": { "declarationFile": "/spring/rts/Game/InMapDraw.cpp", - "declarationLine": 28, + "declarationLine": 30, "description": "Enables drawing with cursor over MiniMap.", "defaultValue": 0, "type": "bool" }, "MiniMapCanFlip": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 73, + "declarationLine": 81, "description": "Whether minimap inverts coordinates when camera Y rotation is between 90 and 270 degrees.", "defaultValue": 0, "type": "bool" }, "MiniMapCursorScale": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 60, + "declarationLine": 68, "defaultValue": -0.5, "type": "float" }, "MiniMapDrawCommands": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 63, + "declarationLine": 71, "defaultValue": 1, "minimumValue": 0, "headlessValue": 0, @@ -1219,47 +1282,47 @@ }, "MiniMapDrawProjectiles": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 65, + "declarationLine": 73, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "MiniMapFullProxy": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 52, + "declarationLine": 60, "defaultValue": 1, "type": "bool" }, "MiniMapGeometry": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 51, + "declarationLine": 59, "defaultValue": "2 2 200 200", "type": "std::string" }, "MiniMapIcons": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 61, + "declarationLine": 69, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "MiniMapMarker": { "declarationFile": "/spring/rts/Game/UI/GuiHandler.cpp", - "declarationLine": 59, + "declarationLine": 62, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "MiniMapMouseWheel": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 53, + "declarationLine": 59, "description": "Whether MiniMap responds to MouseWheel events", "defaultValue": 0, "type": "bool" }, "MiniMapRefreshRate": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 69, + "declarationLine": 77, "description": "The refresh rate of the async MiniMap texture. Needs MiniMapRenderToTexture to be true. Value of \"0\" autoselects between 10-60FPS.", "defaultValue": 0, "minimumValue": 0, @@ -1267,7 +1330,7 @@ }, "MiniMapRenderToTexture": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 68, + "declarationLine": 76, "description": "Asynchronous render MiniMap to a texture independent of screen FPS.", "defaultValue": 1, "safemodeValue": 0, @@ -1275,20 +1338,20 @@ }, "MiniMapUnitExp": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 59, + "declarationLine": 67, "defaultValue": 0.25, "type": "float" }, "MiniMapUnitSize": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 55, + "declarationLine": 63, "defaultValue": 2.5, "minimumValue": 0, "type": "float" }, "MinimizeOnFocusLoss": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 65, + "declarationLine": 66, "description": "When set to 1 minimize Window if it loses key focus when in fullscreen mode.", "defaultValue": 0, "minimumValue": 0, @@ -1297,41 +1360,41 @@ }, "MouseDragBoxCommandThreshold": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 65, + "declarationLine": 71, "description": "Distance in pixels which the mouse must be dragged to trigger a rectangular area command.", "defaultValue": 16, "type": "int" }, "MouseDragCircleCommandThreshold": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 64, + "declarationLine": 70, "description": "Distance in pixels which the mouse must be dragged to trigger a circular area command.", "defaultValue": 4, "type": "int" }, "MouseDragFrontCommandThreshold": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 66, + "declarationLine": 72, "description": "Distance in pixels which the mouse must be dragged to trigger a formation front command.", "defaultValue": 30, "type": "int" }, "MouseDragScrollThreshold": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 62, + "declarationLine": 68, "defaultValue": 0.3, "type": "float" }, "MouseDragSelectionThreshold": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 63, + "declarationLine": 69, "description": "Distance in pixels which the mouse must be dragged to trigger a selection box.", "defaultValue": 4, "type": "int" }, "MouseRelativeModeWarp": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 52, + "declarationLine": 58, "defaultValue": 1, "type": "bool" }, @@ -1346,6 +1409,7 @@ "NetworkTimeout": { "declarationFile": "/spring/rts/System/GlobalConfig.cpp", "declarationLine": 19, + "description": "Number of seconds before connection to game server is considered lost.", "defaultValue": 120, "minimumValue": 0, "type": "int" @@ -1358,39 +1422,39 @@ }, "OverheadEnabled": { "declarationFile": "/spring/rts/Game/Camera/OverheadController.cpp", - "declarationLine": 21, + "declarationLine": 23, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "OverheadFOV": { "declarationFile": "/spring/rts/Game/Camera/OverheadController.cpp", - "declarationLine": 22, + "declarationLine": 24, "defaultValue": 45, "type": "float" }, "OverheadMaxHeightFactor": { "declarationFile": "/spring/rts/Game/Camera/OverheadController.cpp", - "declarationLine": 23, + "declarationLine": 25, "description": "float multiplier for maximum overhead camera height", "defaultValue": 1, "type": "float" }, "OverheadScrollSpeed": { "declarationFile": "/spring/rts/Game/Camera/OverheadController.cpp", - "declarationLine": 19, + "declarationLine": 21, "defaultValue": 10, "type": "int" }, "OverheadTiltSpeed": { "declarationFile": "/spring/rts/Game/Camera/OverheadController.cpp", - "declarationLine": 20, + "declarationLine": 22, "defaultValue": 1, "type": "float" }, "PathingThreadCount": { "declarationFile": "/spring/rts/Sim/Path/QTPFS/PathManager.cpp", - "declarationLine": 38, + "declarationLine": 59, "defaultValue": 0, "minimumValue": 0, "safemodeValue": 1, @@ -1405,14 +1469,14 @@ }, "PreloadModels": { "declarationFile": "/spring/rts/Rendering/WorldDrawer.cpp", - "declarationLine": 53, + "declarationLine": 55, "description": "The engine will preload all models", "defaultValue": 1, "type": "bool" }, "ROAM": { "declarationFile": "/spring/rts/Map/SMF/SMFGroundDrawer.cpp", - "declarationLine": 49, + "declarationLine": 53, "description": "Use ROAM for terrain mesh rendering: 0 to disable, 1=VBO mode to enable.", "defaultValue": 1, "minimumValue": 0, @@ -1435,39 +1499,39 @@ }, "RendererHash": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 79, + "declarationLine": 80, "deprecated": 1, "type": "int" }, "RotOverheadClampMap": { "declarationFile": "/spring/rts/Game/Camera/RotOverheadController.cpp", - "declarationLine": 19, + "declarationLine": 21, "defaultValue": 1, "headlessValue": 1, "type": "bool" }, "RotOverheadEnabled": { "declarationFile": "/spring/rts/Game/Camera/RotOverheadController.cpp", - "declarationLine": 17, + "declarationLine": 19, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "RotOverheadFOV": { "declarationFile": "/spring/rts/Game/Camera/RotOverheadController.cpp", - "declarationLine": 18, + "declarationLine": 20, "defaultValue": 45, "type": "float" }, "RotOverheadMouseScale": { "declarationFile": "/spring/rts/Game/Camera/RotOverheadController.cpp", - "declarationLine": 15, + "declarationLine": 17, "defaultValue": 0.01, "type": "float" }, "RotOverheadScrollSpeed": { "declarationFile": "/spring/rts/Game/Camera/RotOverheadController.cpp", - "declarationLine": 16, + "declarationLine": 18, "defaultValue": 10, "type": "int" }, @@ -1480,27 +1544,44 @@ }, "SMFTexAniso": { "declarationFile": "/spring/rts/Map/SMF/SMFReadMap.cpp", - "declarationLine": 36, + "declarationLine": 40, "defaultValue": 4, "minimumValue": 0, "type": "float" }, + "SMFTextureLodBias": { + "declarationFile": "/spring/rts/Map/SMF/SMFGroundTextures.cpp", + "declarationLine": 50, + "description": "In case SMFTextureStreaming = false, this parameter controls the sampling lod bias applied to diffuse texture", + "defaultValue": 0, + "safemodeValue": 0, + "type": "float" + }, + "SMFTextureStreaming": { + "declarationFile": "/spring/rts/Map/SMF/SMFGroundTextures.cpp", + "declarationLine": 49, + "description": "Dynamically load and unload SMF Diffuse textures. Saves VRAM, worse performance and image quality.", + "defaultValue": 0, + "safemodeValue": 1, + "type": "bool" + }, "SSMFTexAniso": { "declarationFile": "/spring/rts/Map/SMF/SMFReadMap.cpp", - "declarationLine": 37, + "declarationLine": 41, "defaultValue": 4, "minimumValue": 0, "type": "float" }, "ScreenshotCounter": { "declarationFile": "/spring/rts/Rendering/Screenshot.cpp", - "declarationLine": 19, + "declarationLine": 20, + "description": "Deprecated, does nothing, but not marked as such to keep compatibility with older engine versions", "defaultValue": 0, "type": "int" }, "ScrollWheelSpeed": { "declarationFile": "/spring/rts/Game/UI/MouseHandler.cpp", - "declarationLine": 60, + "declarationLine": 66, "defaultValue": -25, "minimumValue": -255, "maximumValue": 255, @@ -1528,13 +1609,13 @@ "ServerSleepTime": { "declarationFile": "/spring/rts/Net/GameServer.cpp", "declarationLine": 70, - "description": "number of milliseconds to sleep per tick", + "description": "Number of milliseconds to sleep per tick for the server thread. Lower values have marginally higher CPU load, while high values can introduce additional latency.", "defaultValue": 5, "type": "int" }, "SetCoreAffinity": { "declarationFile": "/spring/rts/System/SpringApp.cpp", - "declarationLine": 105, + "declarationLine": 107, "description": "Defines a bitmask indicating which CPU cores the main-thread should use.", "defaultValue": "0", "safemodeValue": "1", @@ -1542,14 +1623,14 @@ }, "ShadowColorMode": { "declarationFile": "/spring/rts/Rendering/ShadowHandler.cpp", - "declarationLine": 34, + "declarationLine": 35, "description": "Whether the colorbuffer of shadowmap FBO is RGB vs greyscale(to conserve some VRAM)", "defaultValue": 1, "type": "bool" }, "ShadowMapSize": { "declarationFile": "/spring/rts/Rendering/ShadowHandler.cpp", - "declarationLine": 32, + "declarationLine": 33, "description": "Sets the resolution of shadows. Higher numbers increase quality at the cost of performance.", "defaultValue": 2048, "minimumValue": 32, @@ -1557,13 +1638,13 @@ }, "ShadowProjectionMode": { "declarationFile": "/spring/rts/Rendering/ShadowHandler.cpp", - "declarationLine": 33, + "declarationLine": 34, "defaultValue": 1, "type": "int" }, "Shadows": { "declarationFile": "/spring/rts/Rendering/ShadowHandler.cpp", - "declarationLine": 31, + "declarationLine": 32, "description": "Sets whether shadows are rendered.\n-1:=forceoff, 0:=off, 1:=full, 2:=fast (skip terrain)", "defaultValue": 2, "minimumValue": -1, @@ -1573,7 +1654,7 @@ }, "ShowClock": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 139, + "declarationLine": 146, "description": "Displays a clock on the top-right corner of the screen showing the elapsed time of the current game.", "defaultValue": 1, "headlessValue": 0, @@ -1581,62 +1662,62 @@ }, "ShowFPS": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 138, + "declarationLine": 145, "description": "Displays current framerate.", "defaultValue": 0, "type": "bool" }, "ShowPlayerInfo": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 141, + "declarationLine": 148, "defaultValue": 1, "headlessValue": 0, "type": "int" }, "ShowSpeed": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 140, + "declarationLine": 147, "description": "Displays current game speed.", "defaultValue": 0, "type": "bool" }, "SimpleMiniMapColors": { "declarationFile": "/spring/rts/Game/UI/MiniMap.cpp", - "declarationLine": 66, + "declarationLine": 74, "defaultValue": 0, "type": "bool" }, "SmallFontFile": { "declarationFile": "/spring/rts/Rendering/Fonts/glFont.cpp", - "declarationLine": 23, + "declarationLine": 25, "description": "Sets the font of Spring engine small text.", "defaultValue": "fonts/FreeSansBold.otf", "type": "std::string" }, "SmallFontOutlineWeight": { "declarationFile": "/spring/rts/Rendering/Fonts/glFont.cpp", - "declarationLine": 30, + "declarationLine": 32, "description": "see FontOutlineWeight", "defaultValue": 10, "type": "float" }, "SmallFontOutlineWidth": { "declarationFile": "/spring/rts/Rendering/Fonts/glFont.cpp", - "declarationLine": 28, + "declarationLine": 30, "description": "see FontOutlineWidth", "defaultValue": 2, "type": "int" }, "SmallFontSize": { "declarationFile": "/spring/rts/Rendering/Fonts/glFont.cpp", - "declarationLine": 26, + "declarationLine": 28, "description": "Sets the font size (in pixels) of the engine GUIs and more.", "defaultValue": 14, "type": "int" }, "SmoothTimeOffset": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 145, + "declarationLine": 152, "description": "Enables frametimeoffset smoothing, 0 = off (old version), -1 = forced 0.5, 1-20 smooth, recommended = 2-3", "defaultValue": 0, "headlessValue": 0, @@ -1644,7 +1725,7 @@ }, "SoftParticles": { "declarationFile": "/spring/rts/Rendering/Env/Particles/ProjectileDrawer.cpp", - "declarationLine": 44, + "declarationLine": 46, "description": "Soften up CEG particles on clipping edges", "defaultValue": 1, "safemodeValue": 0, @@ -1674,7 +1755,7 @@ }, "SplashScreenDir": { "declarationFile": "/spring/rts/System/SpringApp.cpp", - "declarationLine": 113, + "declarationLine": 116, "defaultValue": ".", "type": "std::string" }, @@ -1694,16 +1775,23 @@ "defaultValue": "", "type": "std::string" }, + "StoreDefaultSettings": { + "declarationFile": "/spring/rts/System/Config/ConfigHandler.cpp", + "declarationLine": 18, + "description": "springsettings.cfg will save the settings values, if they match the implicit defaults and were set by a user explicitly", + "defaultValue": 0, + "type": "bool" + }, "TCPAllowConnect": { "declarationFile": "/spring/rts/lib/luasocket/src/restrictions.cpp", - "declarationLine": 24, + "declarationLine": 25, "readOnly": 1, "defaultValue": "*", "type": "std::string" }, "TCPAllowListen": { "declarationFile": "/spring/rts/lib/luasocket/src/restrictions.cpp", - "declarationLine": 25, + "declarationLine": 26, "readOnly": 1, "defaultValue": "*", "type": "std::string" @@ -1718,14 +1806,14 @@ }, "TeamNanoSpray": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 63, + "declarationLine": 64, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "TextureMemPoolSize": { "declarationFile": "/spring/rts/System/SpringApp.cpp", - "declarationLine": 106, + "declarationLine": 108, "description": "Set to 0 to disable, otherwise specify a predefined memory to serve Bitmap allocation requests", "defaultValue": "512", "minimumValue": "0", @@ -1733,27 +1821,27 @@ }, "TooltipGeometry": { "declarationFile": "/spring/rts/Game/UI/TooltipConsole.cpp", - "declarationLine": 28, + "declarationLine": 30, "defaultValue": "0.0 0.0 0.41 0.1", "type": "std::string" }, "TooltipOutlineFont": { "declarationFile": "/spring/rts/Game/UI/TooltipConsole.cpp", - "declarationLine": 29, + "declarationLine": 31, "defaultValue": 1, "headlessValue": 0, "type": "bool" }, "UDPAllowConnect": { "declarationFile": "/spring/rts/lib/luasocket/src/restrictions.cpp", - "declarationLine": 26, + "declarationLine": 27, "readOnly": 1, "defaultValue": "", "type": "std::string" }, "UDPAllowListen": { "declarationFile": "/spring/rts/lib/luasocket/src/restrictions.cpp", - "declarationLine": 27, + "declarationLine": 28, "readOnly": 1, "defaultValue": "*", "type": "std::string" @@ -1766,14 +1854,14 @@ }, "UnitIconDist": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 55, + "declarationLine": 57, "defaultValue": 200, "headlessValue": 0, "type": "int" }, "UnitIconFadeStart": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 57, + "declarationLine": 59, "defaultValue": 3000, "minimumValue": 1, "maximumValue": 10000, @@ -1781,7 +1869,7 @@ }, "UnitIconFadeVanish": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 58, + "declarationLine": 60, "defaultValue": 1000, "minimumValue": 1, "maximumValue": 10000, @@ -1789,7 +1877,7 @@ }, "UnitIconScaleUI": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 56, + "declarationLine": 58, "defaultValue": 1, "minimumValue": 0.1, "maximumValue": 10, @@ -1797,14 +1885,14 @@ }, "UnitIconsAsUI": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 60, + "declarationLine": 62, "description": "Draw unit icons like it is an UI element and not like unit's LOD.", "defaultValue": 0, "type": "bool" }, "UnitIconsHideWithUI": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 61, + "declarationLine": 63, "description": "Hide unit icons when UI is hidden.", "defaultValue": 0, "type": "bool" @@ -1819,13 +1907,31 @@ }, "UnitTransparency": { "declarationFile": "/spring/rts/Rendering/Units/UnitDrawer.cpp", - "declarationLine": 59, + "declarationLine": 61, "defaultValue": 0.7, "type": "float" }, + "UpdateBoundingVolumeMT": { + "declarationFile": "/spring/rts/Sim/Units/UnitHandler.cpp", + "declarationLine": 38, + "description": "Enable multithreaded update of unit bounding volumes", + "defaultValue": 1, + "minimumValue": 0, + "safemodeValue": 0, + "type": "bool" + }, + "UpdateWeaponVectorsMT": { + "declarationFile": "/spring/rts/Sim/Units/UnitHandler.cpp", + "declarationLine": 37, + "description": "Enable multithreaded update of weapon vectors", + "defaultValue": 1, + "minimumValue": 0, + "safemodeValue": 0, + "type": "bool" + }, "UseDistToGroundForIcons": { "declarationFile": "/spring/rts/Game/Camera/CameraController.cpp", - "declarationLine": 11, + "declarationLine": 13, "defaultValue": 0.95, "type": "float" }, @@ -1838,21 +1944,21 @@ }, "UseFontConfigLib": { "declarationFile": "/spring/rts/System/SpringApp.cpp", - "declarationLine": 109, + "declarationLine": 111, "description": "Whether the system fontconfig library (if present and enabled at compile-time) should be used for handling fonts.", "defaultValue": 1, "type": "bool" }, "UseHighResTimer": { "declarationFile": "/spring/rts/System/SpringApp.cpp", - "declarationLine": 108, + "declarationLine": 110, "description": "On Windows, sets whether Spring will use low- or high-resolution timer functions for tasks like graphical interpolation between game frames.", "defaultValue": 0, "type": "bool" }, "UseLuaMemPools": { "declarationFile": "/spring/rts/System/SpringApp.cpp", - "declarationLine": 107, + "declarationLine": 109, "description": "Whether Lua VM memory allocations are made from pools.", "defaultValue": 1, "type": "bool" @@ -1860,15 +1966,14 @@ "UseNetMessageSmoothingBuffer": { "declarationFile": "/spring/rts/System/GlobalConfig.cpp", "declarationLine": 58, + "description": "Buffer network packets for a few frames in an attempt to reduce lag from packet time variance. Introduces a fixed lag.", "defaultValue": 1, "type": "bool" }, "UsePBO": { "declarationFile": "/spring/rts/Rendering/GL/VBO.cpp", - "declarationLine": 21, - "defaultValue": 1, - "safemodeValue": 0, - "headlessValue": 0, + "declarationLine": 23, + "deprecated": 1, "type": "bool" }, "UseSDLAudio": { @@ -1882,14 +1987,14 @@ }, "UseShaderCache": { "declarationFile": "/spring/rts/Rendering/Shaders/Shader.cpp", - "declarationLine": 37, + "declarationLine": 40, "description": "If already compiled shaders should be shared via a cache, reducing compiles of already compiled shaders.", "defaultValue": 1, "type": "bool" }, "UseVBO": { "declarationFile": "/spring/rts/Rendering/GL/VBO.cpp", - "declarationLine": 20, + "declarationLine": 22, "deprecated": 1, "type": "bool" }, @@ -1910,7 +2015,7 @@ }, "Water": { "declarationFile": "/spring/rts/Rendering/Env/IWater.cpp", - "declarationLine": 24, + "declarationLine": 26, "description": "Defines the type of water rendering. Can be set in game. Options are: 0 = Basic water, 1 = Reflective water, 2 = Reflective and Refractive water, 3 = Dynamic water, 4 = Bumpmapped water", "defaultValue": 1, "minimumValue": 0, @@ -1927,35 +2032,35 @@ }, "WindowBorderless": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 68, + "declarationLine": 69, "description": "When set and Fullscreen is 0, will put the game in Borderless Window mode, also known as Windowed Fullscreen. When using this, it is generally best to also set WindowPosX and WindowPosY to 0", "defaultValue": 0, "type": "bool" }, "WindowPosX": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 75, + "declarationLine": 76, "description": "Sets the horizontal position of the game window, if Fullscreen is 0. When WindowBorderless is set, this should usually be 0.", "defaultValue": 0, "type": "int" }, "WindowPosY": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 76, + "declarationLine": 77, "description": "Sets the vertical position of the game window, if Fullscreen is 0. When WindowBorderless is set, this should usually be 0.", "defaultValue": 32, "type": "int" }, "WindowedEdgeMove": { "declarationFile": "/spring/rts/Game/Game.cpp", - "declarationLine": 135, + "declarationLine": 142, "description": "Sets whether moving the mouse cursor to the screen edge will move the camera across the map.", "defaultValue": 1, "type": "bool" }, "WorkerThreadCount": { "declarationFile": "/spring/rts/System/Threading/ThreadPool.cpp", - "declarationLine": 43, + "declarationLine": 44, "description": "Number of workers (including the main thread!) used by ThreadPool.", "defaultValue": -1, "minimumValue": -1, @@ -1964,7 +2069,7 @@ }, "XResolution": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 71, + "declarationLine": 72, "description": "Sets the width of the game screen. If set to 0 Spring will autodetect the current resolution of your desktop.", "defaultValue": 0, "minimumValue": 0, @@ -1973,7 +2078,7 @@ }, "XResolutionWindowed": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 73, + "declarationLine": 74, "description": "See XResolution, just for windowed.", "defaultValue": 0, "minimumValue": 0, @@ -1982,7 +2087,7 @@ }, "YResolution": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 72, + "declarationLine": 73, "description": "Sets the height of the game screen. If set to 0 Spring will autodetect the current resolution of your desktop.", "defaultValue": 0, "minimumValue": 0, @@ -1991,7 +2096,7 @@ }, "YResolutionWindowed": { "declarationFile": "/spring/rts/Rendering/GlobalRendering.cpp", - "declarationLine": 74, + "declarationLine": 75, "description": "See YResolution, just for windowed.", "defaultValue": 0, "minimumValue": 0, @@ -2007,7 +2112,7 @@ }, "name": { "declarationFile": "/spring/rts/System/SpringApp.cpp", - "declarationLine": 111, + "declarationLine": 114, "description": "Sets your name in the game. Since this is overridden by lobbies with your lobby username when playing, it usually only comes up when viewing replays or starting the engine directly for testing purposes.", "defaultValue": "UnnamedPlayer", "type": "std::string" diff --git a/_data/latest_release.json b/_data/latest_release.json index 53209deac8..0d43521e67 100644 --- a/_data/latest_release.json +++ b/_data/latest_release.json @@ -1,9 +1,9 @@ { - "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/92924750", - "assets_url": "https://api.github.com/repos/beyond-all-reason/spring/releases/92924750/assets", - "upload_url": "https://uploads.github.com/repos/beyond-all-reason/spring/releases/92924750/assets{?name,label}", - "html_url": "https://github.com/beyond-all-reason/spring/releases/tag/spring_bar_%7BBAR105%7D105.1.1-1544-g058c8ea", - "id": 92924750, + "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/177686875", + "assets_url": "https://api.github.com/repos/beyond-all-reason/spring/releases/177686875/assets", + "upload_url": "https://uploads.github.com/repos/beyond-all-reason/spring/releases/177686875/assets{?name,label}", + "html_url": "https://github.com/beyond-all-reason/spring/releases/tag/spring_bar_%7BBAR105%7D105.1.1-2590-gb9462a0", + "id": 177686875, "author": { "login": "github-actions[bot]", "id": 41898282, @@ -24,19 +24,19 @@ "type": "Bot", "site_admin": false }, - "node_id": "RE_kwDOEgT4Wc4FietO", - "tag_name": "spring_bar_{BAR105}105.1.1-1544-g058c8ea", + "node_id": "RE_kwDOEgT4Wc4Kl0lb", + "tag_name": "spring_bar_{BAR105}105.1.1-2590-gb9462a0", "target_commitish": "BAR105", - "name": "spring_bar_{BAR105}105.1.1-1544-g058c8ea", + "name": "spring_bar_{BAR105}105.1.1-2590-gb9462a0", "draft": false, "prerelease": false, - "created_at": "2023-02-18T18:40:26Z", - "published_at": "2023-02-18T20:36:43Z", + "created_at": "2024-09-27T19:47:33Z", + "published_at": "2024-09-30T21:27:58Z", "assets": [ { - "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/96209637", - "id": 96209637, - "node_id": "RA_kwDOEgT4Wc4FvArl", + "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/195971838", + "id": 195971838, + "node_id": "RA_kwDOEgT4Wc4Lrkr-", "name": "buildoptions_linux-64.txt", "label": "", "uploader": { @@ -59,18 +59,18 @@ "type": "Bot", "site_admin": false }, - "content_type": "binary/octet-stream", + "content_type": "text/plain", "state": "uploaded", - "size": 662, - "download_count": 3, - "created_at": "2023-02-18T20:36:44Z", - "updated_at": "2023-02-18T20:36:44Z", - "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-1544-g058c8ea/buildoptions_linux-64.txt" + "size": 645, + "download_count": 2, + "created_at": "2024-09-30T21:24:55Z", + "updated_at": "2024-09-30T21:24:56Z", + "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-2590-gb9462a0/buildoptions_linux-64.txt" }, { - "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/96209638", - "id": 96209638, - "node_id": "RA_kwDOEgT4Wc4FvArm", + "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/195971836", + "id": 195971836, + "node_id": "RA_kwDOEgT4Wc4Lrkr8", "name": "buildoptions_windows-64.txt", "label": "", "uploader": { @@ -93,19 +93,19 @@ "type": "Bot", "site_admin": false }, - "content_type": "binary/octet-stream", + "content_type": "text/plain", "state": "uploaded", - "size": 551, - "download_count": 3, - "created_at": "2023-02-18T20:36:44Z", - "updated_at": "2023-02-18T20:36:45Z", - "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-1544-g058c8ea/buildoptions_windows-64.txt" + "size": 534, + "download_count": 7, + "created_at": "2024-09-30T21:24:55Z", + "updated_at": "2024-09-30T21:24:55Z", + "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-2590-gb9462a0/buildoptions_windows-64.txt" }, { - "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/96209640", - "id": 96209640, - "node_id": "RA_kwDOEgT4Wc4FvAro", - "name": "spring_bar_.BAR105.105.1.1-1544-g058c8ea_linux-64-minimal-portable.7z", + "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/195971833", + "id": 195971833, + "node_id": "RA_kwDOEgT4Wc4Lrkr5", + "name": "spring_bar_.BAR105.105.1.1-2590-gb9462a0_linux-64-minimal-portable.7z", "label": "", "uploader": { "login": "github-actions[bot]", @@ -127,19 +127,19 @@ "type": "Bot", "site_admin": false }, - "content_type": "binary/octet-stream", + "content_type": "application/x-7z-compressed", "state": "uploaded", - "size": 16976427, - "download_count": 830, - "created_at": "2023-02-18T20:36:45Z", - "updated_at": "2023-02-18T20:36:46Z", - "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-1544-g058c8ea/spring_bar_.BAR105.105.1.1-1544-g058c8ea_linux-64-minimal-portable.7z" + "size": 56127947, + "download_count": 1889, + "created_at": "2024-09-30T21:24:54Z", + "updated_at": "2024-09-30T21:24:57Z", + "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-2590-gb9462a0/spring_bar_.BAR105.105.1.1-2590-gb9462a0_linux-64-minimal-portable.7z" }, { - "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/96209642", - "id": 96209642, - "node_id": "RA_kwDOEgT4Wc4FvArq", - "name": "spring_bar_.BAR105.105.1.1-1544-g058c8ea_linux-64-minimal-symbols.tgz", + "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/195971835", + "id": 195971835, + "node_id": "RA_kwDOEgT4Wc4Lrkr7", + "name": "spring_bar_.BAR105.105.1.1-2590-gb9462a0_linux-64-minimal-symbols.tgz", "label": "", "uploader": { "login": "github-actions[bot]", @@ -161,19 +161,19 @@ "type": "Bot", "site_admin": false }, - "content_type": "binary/octet-stream", + "content_type": "application/octet-stream", "state": "uploaded", - "size": 407813530, - "download_count": 3, - "created_at": "2023-02-18T20:36:46Z", - "updated_at": "2023-02-18T20:36:54Z", - "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-1544-g058c8ea/spring_bar_.BAR105.105.1.1-1544-g058c8ea_linux-64-minimal-symbols.tgz" + "size": 525814338, + "download_count": 1, + "created_at": "2024-09-30T21:24:55Z", + "updated_at": "2024-09-30T21:25:08Z", + "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-2590-gb9462a0/spring_bar_.BAR105.105.1.1-2590-gb9462a0_linux-64-minimal-symbols.tgz" }, { - "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/96209648", - "id": 96209648, - "node_id": "RA_kwDOEgT4Wc4FvArw", - "name": "spring_bar_.BAR105.105.1.1-1544-g058c8ea_windows-64-minimal-portable.7z", + "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/195971839", + "id": 195971839, + "node_id": "RA_kwDOEgT4Wc4Lrkr_", + "name": "spring_bar_.BAR105.105.1.1-2590-gb9462a0_windows-64-minimal-portable.7z", "label": "", "uploader": { "login": "github-actions[bot]", @@ -195,19 +195,19 @@ "type": "Bot", "site_admin": false }, - "content_type": "binary/octet-stream", + "content_type": "application/x-7z-compressed", "state": "uploaded", - "size": 16499276, - "download_count": 6563, - "created_at": "2023-02-18T20:36:54Z", - "updated_at": "2023-02-18T20:36:55Z", - "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-1544-g058c8ea/spring_bar_.BAR105.105.1.1-1544-g058c8ea_windows-64-minimal-portable.7z" + "size": 48420056, + "download_count": 29953, + "created_at": "2024-09-30T21:24:56Z", + "updated_at": "2024-09-30T21:24:57Z", + "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-2590-gb9462a0/spring_bar_.BAR105.105.1.1-2590-gb9462a0_windows-64-minimal-portable.7z" }, { - "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/96209651", - "id": 96209651, - "node_id": "RA_kwDOEgT4Wc4FvArz", - "name": "spring_bar_.BAR105.105.1.1-1544-g058c8ea_windows-64-minimal-symbols.tgz", + "url": "https://api.github.com/repos/beyond-all-reason/spring/releases/assets/195971837", + "id": 195971837, + "node_id": "RA_kwDOEgT4Wc4Lrkr9", + "name": "spring_bar_.BAR105.105.1.1-2590-gb9462a0_windows-64-minimal-symbols.tgz", "label": "", "uploader": { "login": "github-actions[bot]", @@ -229,16 +229,17 @@ "type": "Bot", "site_admin": false }, - "content_type": "binary/octet-stream", + "content_type": "application/octet-stream", "state": "uploaded", - "size": 435054551, - "download_count": 2, - "created_at": "2023-02-18T20:36:55Z", - "updated_at": "2023-02-18T20:37:04Z", - "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-1544-g058c8ea/spring_bar_.BAR105.105.1.1-1544-g058c8ea_windows-64-minimal-symbols.tgz" + "size": 572657803, + "download_count": 11, + "created_at": "2024-09-30T21:24:55Z", + "updated_at": "2024-09-30T21:25:12Z", + "browser_download_url": "https://github.com/beyond-all-reason/spring/releases/download/spring_bar_%7BBAR105%7D105.1.1-2590-gb9462a0/spring_bar_.BAR105.105.1.1-2590-gb9462a0_windows-64-minimal-symbols.tgz" } ], - "tarball_url": "https://api.github.com/repos/beyond-all-reason/spring/tarball/spring_bar_{BAR105}105.1.1-1544-g058c8ea", - "zipball_url": "https://api.github.com/repos/beyond-all-reason/spring/zipball/spring_bar_{BAR105}105.1.1-1544-g058c8ea", - "body": "Github Action Upload" + "tarball_url": "https://api.github.com/repos/beyond-all-reason/spring/tarball/spring_bar_{BAR105}105.1.1-2590-gb9462a0", + "zipball_url": "https://api.github.com/repos/beyond-all-reason/spring/zipball/spring_bar_{BAR105}105.1.1-2590-gb9462a0", + "body": "## What's Changed\r\n* Integrate RmlUi by @p2004a in https://github.com/beyond-all-reason/spring/pull/1415\r\n* Add `Engine.FeatureSupport` table by @sprunk in https://github.com/beyond-all-reason/spring/pull/1668\r\n* BAR105 changelog++ by @sprunk in https://github.com/beyond-all-reason/spring/pull/1676\r\n\r\n\r\n**Full Changelog**: https://github.com/beyond-all-reason/spring/compare/spring_bar_%7BBAR105%7D105.1.1-2577-g77272e9...spring_bar_%7BBAR105%7D105.1.1-2590-gb9462a0", + "mentions_count": 2 } diff --git a/_data/synced_commands.json b/_data/synced_commands.json index 7bb678e76e..3428899fa5 100644 --- a/_data/synced_commands.json +++ b/_data/synced_commands.json @@ -3,7 +3,7 @@ "arguments" : {}, "cheatRequired" : true, "command" : "Atm", - "description" : "Gives 1000 metal and 1000 energy to the issuing player's team" + "description" : "Gives the specified amount (default 1000) of each resource to the issuing player's team" }, "cheat" : { "arguments" : {}, @@ -15,7 +15,7 @@ "arguments" : {}, "cheatRequired" : true, "command" : "Destroy", - "description" : "Destroys one or multiple units by unit-ID, instantly" + "description" : "Destroys one or multiple units by unitID immediately" }, "desync" : { "arguments" : {}, @@ -101,6 +101,12 @@ "command" : "ReloadCOB", "description" : "Reloads COB scripts" }, + "remove" : { + "arguments" : {}, + "cheatRequired" : true, + "command" : "Remove", + "description" : "Removes one or multiple units by unitID immediately, bypassing death sequence" + }, "skip" : { "arguments" : {}, "cheatRequired" : false, diff --git a/_data/unsynced_commands.json b/_data/unsynced_commands.json index ae59b8b3ed..140d82fc15 100644 --- a/_data/unsynced_commands.json +++ b/_data/unsynced_commands.json @@ -43,7 +43,7 @@ }, "airmesh" : { "arguments" : {}, - "cheatRequired" : false, + "cheatRequired" : true, "command" : "airmesh", "description" : "Show/Hide the smooth air-mesh map overlay" }, @@ -209,12 +209,24 @@ "command" : "DebugPath", "description" : "Enable/Disable drawing of pathfinder debug-data" }, + "debugshadowfrustum" : { + "arguments" : {}, + "cheatRequired" : false, + "command" : "DebugShadowFrustum", + "description" : "Enable/Disable drawing of shadow frustum shape" + }, "debugtraceray" : { "arguments" : {}, "cheatRequired" : false, "command" : "DebugTraceRay", "description" : "Enable/Disable drawing of traceray debug-data" }, + "debugvisibility" : { + "arguments" : {}, + "cheatRequired" : false, + "command" : "DebugVisibility", + "description" : "Enable/Disable drawing of visible terrain" + }, "decguiopacity" : { "arguments" : {}, "cheatRequired" : false, @@ -237,13 +249,7 @@ "arguments" : {}, "cheatRequired" : true, "command" : "Destroy", - "description" : "Destroys one or multiple units by unit-ID, instantly" - }, - "desync" : { - "arguments" : {}, - "cheatRequired" : false, - "command" : "Desync", - "description" : "Redirects command /Desync to its synced processor" + "description" : "Destroys one or multiple units by unitID immediately" }, "disticon" : { "arguments" : {}, @@ -409,8 +415,10 @@ }, "group" : { "arguments" : { - "" : "Select group ", + "" : "Select group , also focuses on second call (deprecated)", "add " : "Add current selected units to group ", + "focus " : "Focus camera on group ", + "select " : "Select group ", "selectadd " : "Add members from group to currently selected units", "selectclear " : "Remove members from group from currently selected units", "selecttoggle " : "Toggle members from group from currently selected units", @@ -835,6 +843,12 @@ "command" : "ReloadTextures", "description" : "Reloads textures" }, + "remove" : { + "arguments" : {}, + "cheatRequired" : true, + "command" : "Remove", + "description" : "Removes one or multiple units by unitID immediately, bypassing death sequence" + }, "resbar" : { "arguments" : {}, "cheatRequired" : false, @@ -1071,7 +1085,7 @@ "track" : { "arguments" : { "" : "Toggles tracking", - "" : "Set tracking " + "" : "Set tracking " }, "cheatRequired" : false, "command" : "Track", diff --git a/_data/weapondefs.json b/_data/weapondefs.json index f9851ed553..8a903426f8 100644 --- a/_data/weapondefs.json +++ b/_data/weapondefs.json @@ -2,14 +2,15 @@ "WeaponDefs": { "name": { "internalName": "description", - "description": "The descriptive name of the weapon as listed in FPS mode.", - "defaultValue": Weapon, - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "The descriptive name of the weapon, for GUI purposes.", + "defaultValue": "Weapon", + "type": "std::string" }, "weaponType": { "internalName": "type", - "defaultValue": Cannon, - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "Sets weapon type, which is a bundle of behaviours and visuals (check other tags). Available types (sorted from the most general):\nCannon - ballistic projectile, defaults to 'plasma ball' visuals\nLaserCannon - non-ballistic projectile, defaults to 'slow laser' visuals (think stormtroopers)\nBeamLaser - hitscan weapon, laser visuals\nMissileLauncher - potentially homing projectile, leaves a smoke trail\nTorpedoLauncher - missile that can't exit water by default\nStarburstLauncher - missile with a vertical ascent phase at the beginning\nAircraftBomb - resolves into Torpedo or Cannon, but has support for being dropped by a bomber plane\nFlame - non-ballistic projectile, has a sprite which expands\nLightningCannon - hitscan weapon, lightning visuals\nMelee - just applies damage. No frontswing though\nDGun - deprecated, a fiery ball projectile. Has a lot of hardcoded visuals but does NOT convey 'dgun' mechanics. Prefer Cannon instead\nEmgCannon - deprecated, a version of Laser or Flame with crappy visuals\nRifle - deprecated, more or less equivalent to invisible Lightning\n", + "defaultValue": "Cannon", + "type": "std::string" }, "id": { "internalName": "tdfId", @@ -17,97 +18,131 @@ "type": "int" }, "customParams": { + "description": "A table of arbitrary string key-value pairs, for use by Lua gadgets (no engine meaning)", "type": "table" }, "avoidFriendly": { + "description": "Does the weapon avoid shooting if there's allies in the way? Note that an ally can run into the projectile and it will still explode - use `collideFriendly` to avoid that", "defaultValue": 1, "type": "bool" }, "avoidFeature": { + "description": "Does the weapon avoid shooting if there's features in the way? See remarks at `avoidFriendly`", "defaultValue": 1, "type": "bool" }, "avoidNeutral": { + "description": "Does the weapon avoid shooting if there's neutrals in the way? Note this does not mean Gaia! See also remarks at `avoidFriendly`", "defaultValue": 0, "type": "bool" }, "avoidGround": { + "description": "Does the weapon avoid shooting if terrain would block it? See remarks at `avoidFriendly`", "defaultValue": 1, "type": "bool" }, "avoidCloaked": { + "description": "Does the weapon avoid shooting if there's cloaked (incl. revealed, but not decloaked) units in the way? See remarks at `avoidFriendly`", "defaultValue": 0, "type": "bool" }, "collideEnemy": { + "description": "Does the projectile collide with enemies? Use to make sure it hits the ground, or for buffs targeting allies. Note that targeting will always target enemies anyway, and never allies. Also note there is no corresponding `avoidEnemy`", "defaultValue": 1, "type": "bool" }, "collideFriendly": { + "description": "Does the projectile collide with allies? Note that the unit will still shoot if there are allies in the way, which is controlled separately via `avoidFriendly`.", "defaultValue": 1, "type": "bool" }, "collideFeature": { + "description": "Does the projectile collide with features? See remarks at `collideFriendly`", "defaultValue": 1, "type": "bool" }, "collideNeutral": { + "description": "Does the projectile collide with neutrals? Note this does not mean Gaia! See also remarks at `collideFriendly`", + "defaultValue": 1, + "type": "bool" + }, + "collideFireBase": { + "description": "Does the projectile collide with its firebase, i.e. a transport holding the unit? Put it on marines' weapons to let them shoot out of a bunker while remaining in its colvol. There is no corresponding `avoidFirebase`.", + "defaultValue": 0, + "type": "bool" + }, + "collideNonTarget": { + "description": "Does the projectile ghost through everything that isn't its target (incl. other enemies)? Combine with `tracks` and `impactOnly` for 'starcraft' style weapons that are largely just graphics. There is no corresponding `avoidNonTarget`.", "defaultValue": 1, "type": "bool" }, "collideGround": { + "description": "Does the projectile collide with terrain? See remarks at `collideFriendly`", + "defaultValue": 1, + "type": "bool" + }, + "collideCloaked": { + "description": "Does the projectile collide with cloaked (includes revealed but not decloaked) units? See remarks at `collideFriendly`", "defaultValue": 1, "type": "bool" }, "damage": { + "description": "Damage table, indexed by armor class name", "type": "table" }, "damage.default": { + "description": "The default damage used in absence of explicit per-armorclass value", "defaultValue": 1, "type": "float" }, - "size": { - "type": "float" - }, "explosionSpeed": { + "description": "How fast does the shockwave propagate? Note that units cannot actually dodge the shockwave (they are tagged immediately and just damaged after a delay)", "type": "float" }, "impactOnly": { + "description": "Does the projectile only damage a single thing it hits? Mostly equivalent to having 0 AoE without the issues with 0. Also removes cratering.", "defaultValue": 0, "type": "bool" }, "noSelfDamage": { + "description": "Is the unit unable to damage itself with the weapon?", "defaultValue": 0, "type": "bool" }, "noExplode": { + "description": "The projectile will not be removed when exploding and instead continue on. It will keep exploding every sim frame while inside a collision volume, massively multiplying nominal damage.", "defaultValue": 0, "type": "bool" }, "burnblow": { "internalName": "selfExplode", + "description": "For LaserCannon, expire when reaching the target (at max range otherwise). For Cannon, explode when reaching the target (keep falling otherwise). For Missile/Starburst/TorpedoLauncher, explode when running out of fuel (fall down otherwise).", "defaultValue": 0, "type": "bool" }, "damageAreaOfEffect": { "fallbackName": "areaOfEffect", + "description": "The diameter (not radius!) for damage. Cratering controlled separately. Also the collision radius for projectile-based interceptors.", "defaultValue": 8, "scaleValue": 0.5, "scaleValueString": "0.5f", "type": "float" }, "edgeEffectiveness": { + "description": "Exponent for a magic formula describing splash damage falloff. The damage always drops down to 0, this tag just controls how large the 'core' is. Can be negative for a very core-centric explosion. 0 is linear falloff with radius. 1 is no falloff.", "defaultValue": 0, "maximumValue": 1, "type": "float" }, "collisionSize": { + "description": "Width for hitscan interceptors. Supposed to be collision radius for others but it's broken at the moment", "defaultValue": 0.05, "type": "float" }, "weaponVelocity": { "internalName": "projectilespeed", "fallbackName": "maxVelocity", + "description": "Maximum speed in elmo/s (won't accelerate further on its own)", "defaultValue": 0, "minimumValue": 0.01, "scaleValue": 0.0333333, @@ -115,6 +150,7 @@ "type": "float" }, "startvelocity": { + "description": "Initial projectile speed in elmo/s", "defaultValue": 0, "minimumValue": 0.01, "scaleValue": 0.0333333, @@ -123,6 +159,7 @@ }, "weaponacceleration": { "fallbackName": "acceleration", + "description": "Acceleration in elmo/s^2", "defaultValue": 0, "scaleValue": 0.00111111, "scaleValueString": "1.0f / (GAME_SPEED * GAME_SPEED)", @@ -130,95 +167,116 @@ }, "reloadTime": { "internalName": "reload", + "description": "Reload time between bursts, in seconds. Note that reloadTime starts to count down from the first round fired, not the last, so if (reloadTime < burst * burstRate) the weapon will fire continuously.", "defaultValue": 1, "type": "float" }, "burstRate": { "internalName": "salvodelay", + "description": "Delay between shots within a burst, in seconds", "defaultValue": 0.1, "type": "float" }, "burst": { "internalName": "salvosize", + "description": "Shots per burst. Cannot be used by #BeamLaser unless `beamburst` is used which comes with caveats.", "defaultValue": 1, "type": "int" }, "projectiles": { "internalName": "projectilespershot", + "description": "Projectiles per shot. Best used in conjunction with `sprayAngle` or changing the firing piece in script using ShotX as otherwise they'll all be clumped up in one blob.", "defaultValue": 1, "type": "int" }, "waterBounce": { + "description": "Bounces when hitting the water surface?", "defaultValue": 0, "type": "bool" }, "groundBounce": { + "description": "Bounces when hitting terrain?", "defaultValue": 0, "type": "bool" }, "bounceSlip": { + "description": "Horizontal velocity multiplier on bounce", "defaultValue": 1, "type": "float" }, "bounceRebound": { + "description": "Vertical velocity multiplier on bounce", "defaultValue": 1, "type": "float" }, "numBounce": { + "description": "How many bounces can the weapon do? Explodes on impact when cannot bounce anymore", "defaultValue": -1, "type": "int" }, "impulseFactor": { + "description": "A multiplier to base impulse (knockback). For most weapons, base impulse is equal to applied damage. For #Melee weapons the base impulse is the hitting unit's mass.", "defaultValue": 1, "type": "float" }, "impulseBoost": { + "description": "A flat bonus to impulse.", "defaultValue": 0, "type": "float" }, "craterMult": { "fallbackName": "impulseFactor", + "description": "A multiplier to cratering strength. Applies after all other modifiers.", "defaultValue": 1, "type": "float" }, "craterBoost": { + "description": "A flat modifier to cratering strength, applies second-last (after reduction due to altitude).", "defaultValue": 0, "type": "float" }, "craterAreaOfEffect": { "fallbackName": "areaOfEffect", + "description": "Diameter of terrain deformation. Damage to units controlled separately. Keep in mind about the inner half of this is the hole, and the outer half is the raised (!) rim", "defaultValue": 8, "scaleValue": 0.5, "scaleValueString": "0.5f", "type": "float" }, "waterweapon": { + "description": "Can the projectile travel underwater? Ability to fire underwater controlled separately via `fireSubmersed`", "defaultValue": 0, "type": "bool" }, "submissile": { + "description": "Torpedo only. Lets torpedoes exit the water and be a missile. Lets underwater launchers shoot out-of-water targets (out-of-water launchers still cannot - use Missile instead of Torpedo for that).", "defaultValue": 0, "type": "bool" }, "fireSubmersed": { "fallbackName": "waterweapon", + "description": "Can the weapon fire underwater? Requires `waterweapon`.", "defaultValue": 0, "type": "bool" }, "commandfire": { "internalName": "manualfire", + "description": "Does the weapon respond to the manual fire command instead of regular attack?", "defaultValue": 0, "type": "bool" }, "range": { + "description": "Maximum targeting range. Ballistic weapons can resolve lower due to physics. Some weapons can also fly past that range if they miss.", "defaultValue": 10, "type": "float" }, "heightmod": { + "description": "Multiplies height difference to target, for targeting purposes. When lower than 1, the targeting volume becomes elongated vertically and the unit can target further high than normal (useful to make terrain and aircraft less punishing). At 0, the height difference component becomes completely ignored.", "defaultValue": 0.2, "type": "float" }, "targetBorder": { + "description": "1/-1 will target the close/far edge of the colvol (instead of center). Matters for huge colvols and/or small ranges", "defaultValue": 0, "minimumValue": -1, "maximumValue": 1, @@ -226,6 +284,7 @@ }, "cylinderTargeting": { "fallbackName": "cylinderTargetting", + "description": "Makes targeting happen in a cylinder. The height is range times this value. Zero means use the usual range (spherical or ballistic)", "defaultValue": 0, "minimumValue": 0, "maximumValue": 128, @@ -237,11 +296,13 @@ "type": "bool" }, "fixedLauncher": { + "description": "Missile/Torpedo/Starburst only. The projectile will start aimed at the direction of the aiming piece, which is not necessarily towards the target", "defaultValue": 0, "type": "bool" }, "tolerance": { "internalName": "maxAngle", + "description": "For `turret = false` only. Firing cone width, in the 16-bit legacy angular unit.", "defaultValue": 3000, "scaleValue": 9.58738e-05, "scaleValueString": "TAANG2RAD", @@ -249,70 +310,83 @@ }, "firetolerance": { "internalName": "maxFireAngle", + "description": "Angle above which reaim (script `AimWeapon`) is forced outside the usual time-based reaim. In the legacy 16-bit angular units.", "defaultValue": 3640, "scaleValue": 9.58738e-05, "scaleValueString": "TAANG2RAD", "type": "float" }, "highTrajectory": { + "description": "0: low trajectory, 1: high trajectory, 2: the unit will have a state toggle for the player to pick", "defaultValue": 2, "type": "int" }, "trajectoryHeight": { + "description": "Missile/Torpedo only. Causes the missile to fly in an arc. The value is the fraction of target distance as extra arc height (e.g. at 1.0 the arc is as tall as it is long).", "defaultValue": 0, "type": "float" }, "tracks": { + "description": "Missile/Torpedo/Starburst only. Does the projectile track its target (i.e. homing)? Requires a positive `turnRate`.", "defaultValue": 0, "type": "bool" }, "wobble": { + "description": "Missile only. Missiles will turn towards random directions (new direction rolled every 16 sim frames). In legacy angular units per second.", "defaultValue": 0, "scaleValue": 3.19579e-06, "scaleValueString": "float(TAANG2RAD) / GAME_SPEED", "type": "float" }, "dance": { + "description": "Missile only. Missiles will randomly shift up to this many elmos, perpendicular to their movement direction. Movement period is hardcoded to 8 sim frames", "defaultValue": 0, "scaleValue": 0.0333333, "scaleValueString": "1.0f / GAME_SPEED", "type": "float" }, "gravityAffected": { + "description": "#DGun weapon type only. Is the dgun projectile affected by gravity? Aiming won't take this into account.", "defaultValue": 0, "type": "bool" }, "myGravity": { + "description": "Overrides the map gravity for ballistic weapons. The default of 0.0 disables the tag in favour of map gravity.", "defaultValue": 0, "type": "float" }, "canAttackGround": { + "description": "Can the unit target ground? Only units otherwise. Note, features are not directly targetable either way.", "defaultValue": 1, "type": "bool" }, "weaponTimer": { "internalName": "uptime", + "description": "StarburstLauncher only. Seconds of vertical ascent", "defaultValue": 0, "type": "float" }, "flighttime": { - "description": "Flighttime of missiles in seconds.", + "description": "Lifetime of the projectile, in seconds. Missile/Torpedo/Starburst projectiles 'lose fuel' and fall down; Cannons explode; others fade away", "defaultValue": 0, "scaleValue": 30, "scaleValueString": "GAME_SPEED", "type": "float" }, "turnrate": { + "description": "For projectiles with `tracks`, in COB angular units (65536 is tau) per second. Also the turn rate for Starburst when they stop ascending and turn towards target (regardless of homing).", "defaultValue": 0, "scaleValue": 3.19579e-06, "scaleValueString": "float(TAANG2RAD) / GAME_SPEED", "type": "float" }, "heightBoostFactor": { + "description": "#Cannon weapon type only. Controls the ballistic range gain/loss for height difference; larger means higher effect of range difference. -1 is derived some magic formula. Hard to tell how this stacks with `heightMod`.", "defaultValue": -1, "type": "float" }, "proximityPriority": { + "description": "Importance of distance when picking targets. Higher means closer units are preferred more; negative values make weapons prefer distant targets.", "defaultValue": 1, "type": "float" }, @@ -322,59 +396,71 @@ "type": "bool" }, "accuracy": { + "description": "How INaccurate are entire bursts? Larger is worse, 0 is perfect accuracy. This is an angle, so long range shots are always less likely to hit than close range given same target and inaccuracy. Can improve with unit XP.", "defaultValue": 0, "tagFunction": "math::sin(x * math::PI / 0xafff)", "type": "float" }, "sprayAngle": { + "description": "How inaccurate are individual projectiles in a burst?", "defaultValue": 0, "tagFunction": "math::sin(x * math::PI / 0xafff)", "type": "float" }, "movingAccuracy": { "fallbackName": "accuracy", + "description": "Same as `accuracy` but applies when the unit is moving.", "defaultValue": 0, "tagFunction": "math::sin(x * math::PI / 0xafff)", "type": "float" }, "targetMoveError": { + "description": "Fraction of target speed per second added as a random error. E.g. if target moves at 50 elmo/s and targetMoveError is 0.5 then a random vector of length up to 25 will be added to the target position", "defaultValue": 0, "type": "float" }, "leadLimit": { + "description": "Maximum distance in elmos the unit will lead a moving target. Less than zero is unlimited.", "defaultValue": -1, "type": "float" }, "leadBonus": { + "description": "If `leadLimit` is not unlimited, add this value multiplied by raw unit XP (not limXP) to the limit.", "defaultValue": 0, "type": "float" }, "predictBoost": { + "description": "How well the unit leads its targets. Between 0 and 1. At pb=0 it will over- or under-estimate target speed by between 0-2x its actual value. At pb=1 it will estimate speed perfectly. Keep in mind `leadLimit` can still make it undershoot.", "defaultValue": 0, "type": "float" }, "ownerExpAccWeight": { + "description": "How much does accuracy (but not sprayAngle!) improve with unit limXP? Multiplier for limXP which is then subtracted as a fraction (for example at limXP=0.4 and ownerExpAccWeight=2, the weapon only has 1-(0.4*2) = 20% of original inaccuracy.", "type": "float" }, "minIntensity": { - "description": "The minimum percentage the weapon's damage can fall-off to over its range. Setting to 1.0 will disable fall off entirely. Unrelated to the visual-only intensity tag.", + "description": "BeamLaser only. The minimum percentage the weapon's damage can fall-off to over its range. Setting to 1.0 will disable fall off entirely. Unrelated to the visual-only `intensity`. Largely a duplicate of `dynDamageExp`.", "defaultValue": 0, "type": "float" }, "duration": { + "description": "#LaserCannon only. The visual-only length of the projectile as a fraction of the per-second projectile speed.", "defaultValue": 0.05, "type": "float" }, "beamtime": { + "description": "#BeamLaser only. The laser maintains it beam for this many seconds, spreading its damage over that time.", "defaultValue": 1, "type": "float" }, "beamburst": { + "description": "#BeamLaser only. Lets a laser use burst mechanics, but sets `beamtime` to the duration of 1 sim frame.", "defaultValue": 0, "type": "bool" }, "beamTTL": { "internalName": "beamLaserTTL", + "description": "BeamLaser and LightningCannon only. Linger time of the visual sprite, in sim frames.", "defaultValue": 0, "type": "int" }, @@ -384,24 +470,25 @@ "type": "bool" }, "largeBeamLaser": { + "description": "BeamLaser only. Enables some extra fancy texturing (NOT size). Check other Beamlaser tags for 'large'.", "defaultValue": 0, "type": "bool" }, "sizeGrowth": { + "description": "#Flamethrower only. Visual-only radius growth in elmos per sim frame.", "defaultValue": 0.5, "type": "float" }, "flameGfxTime": { + "description": "#Flamethrower only. Multiplier of the total range for visuals purposes. For example at 1.2, the visual will extend 20% further than max range. Should be >= 1. Exposed back to WeaponDefs as `duration` (same as the unrelated #LaserCannon tag)", "type": "float" }, "metalPerShot": { - "internalName": "metalcost", - "defaultValue": 0, + "description": "Metal cost per shot. For stockpile weapons this is consumed over time, immediately on shot otherwise.", "type": "float" }, "energyPerShot": { - "internalName": "energycost", - "defaultValue": 0, + "description": "Energy cost per shot. For stockpile weapons this is consumed over time, immediately on shot otherwise.", "type": "float" }, "fireStarter": { @@ -447,7 +534,7 @@ "type": "int" }, "interceptedByShieldType": { - "description": "", + "description": "Bitmask representing the types of shields that this weapon can intercept. Each digit of binary that is set to one means that a shield with the corresponding digit in its shieldInterceptType tag will be hit by this weapon.", "type": "unsigned int" }, "coverage": { @@ -620,121 +707,202 @@ "internalName": "shieldArmorTypeName", "fallbackName": "shieldArmorType", "description": "Specifies the armorclass of the shield; you can input either an armorclass name OR a unitdef name to share that unit's armorclass", - "defaultValue": default, - "type": "std::__cxx11::basic_string, std::allocator >" + "defaultValue": "default", + "type": "std::string" }, "model": { - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "Name of a 3D model. Otherwise uses 2D sprites", + "defaultValue": "", + "type": "std::string" + }, + "size": { + "description": "Size of the 2D visual sprite, if the weapon has no 'model' set.", + "type": "float" + }, + "scarGlowColorMap": { + "description": "A colormap (set of RGBA tuples) for the scar decal. Will smoothly fade between these colours over its lifetime.", + "defaultValue": "", + "type": "std::string" + }, + "scarIndices": { + "description": "A table of indices to the scar table in resources.lua", + "type": "table" }, "explosionScar": { + "description": "Does the explosion leave a scar decal on the ground?", "defaultValue": 1, "type": "bool" }, + "scarDiameter": { + "description": "Diameter of the scar decal", + "defaultValue": -1, + "type": "float" + }, + "scarAlpha": { + "description": "Initial opacity of the scar decal (0-1)", + "defaultValue": 0, + "type": "float" + }, + "scarGlow": { + "description": "Initial glow intensity of the scar decal (0-1)", + "defaultValue": 0, + "type": "float" + }, + "scarTtl": { + "description": "Duration of the scar decal, in seconds", + "defaultValue": 0, + "type": "float" + }, + "scarGlowTtl": { + "description": "Duration of the glow of the scar, in seconds", + "defaultValue": 0, + "type": "float" + }, + "scarDotElimination": { + "description": "Specifies the exponent of dot product of projection vector and current terrain normal vector, this is used to remove to remove scar projection from surfaces that usually should not receive the ground scar effect, the exponent controls the degree of elimination. The default 0.0 means there will be no elimination at all.", + "defaultValue": 0, + "type": "float" + }, + "scarProjVector": { + "description": "Forced direction of a ground scar projection (you can think of this technique as if the scar image was projected onto the ground from the cinema projector at certain world-space vector). If all zeroes, it will use ground normals. Realistically this should either be left at default, or set to {0, 1, 0} for orbital-type weapons", + "defaultValue": [ 0, 0, 0 ], + "type": "float4" + }, + "scarColorTint": { + "description": "Color tint for explosion scar decal. Scaled so that 0.5 is no change, 1.0 is twice as bright.", + "defaultValue": [ 0.5, 0.5, 0.5 ], + "type": "float4" + }, "alwaysVisible": { + "description": "Is the projectile visible regardless of sight?", "defaultValue": 0, "type": "bool" }, "cameraShake": { "fallbackName": "damage.default", + "description": "Passed to the wupget:ShockFront callin as the first argument, intended for shaking the camera on particularly strong hits. Same scale as damage.", "defaultValue": 0, "minimumValue": 0, "type": "float" }, "smokeTrail": { + "description": "MissileLauncher only. Does it leave a smoke trail ribbon?", "defaultValue": 0, "type": "bool" }, "smokeTrailCastShadow": { + "description": "Does the smoke trail cast shadow?", "defaultValue": 1, "type": "bool" }, "smokePeriod": { + "description": "Smoke trail update rate - the trail ribbon will make a new vertex this many sim frames. Use for high turn-rate homing missiles to prevent jagged edges. Smaller is smoother but more performance-heavy.", "defaultValue": 8, "type": "int" }, "smokeTime": { + "description": "Smoke trail linger duration, in sim frames", "defaultValue": 60, "type": "int" }, "smokeSize": { + "description": "Smoke trail size multiplier", "defaultValue": 7, "type": "float" }, "smokeColor": { + "description": "Smoke trail brightness multiplier", "defaultValue": 0.65, "type": "float" }, "castShadow": { + "description": "Does the projectile itself cast shadow?", "defaultValue": 1, "type": "bool" }, "sizeDecay": { + "description": "#Cannon only. See `stages`. Size reduction per stage, as a fraction of the first stage", "defaultValue": 0, "type": "float" }, "alphaDecay": { + "description": "#Cannon only. See `stages`. Alpha reduction for the last stage (interpolated linearly for the others).", "defaultValue": 1, "type": "float" }, "separation": { + "description": "#Cannon only. See `stages`. Multiplier for the default distance between stages", "defaultValue": 1, "type": "float" }, "noGap": { + "description": "#Cannon only. Makes `separation` adjust to take `sizeDecay` into account so `stages` stay adjacent.", "defaultValue": 1, "type": "bool" }, "stages": { + "description": "#Cannon only. If `model` is not set then draw this many 2D sprites to simulate a sort of motion blur.", "defaultValue": 5, "type": "int" }, "lodDistance": { + "description": "LaserCannon only. Distance at which rendering is simplified, without the rounded ends", "defaultValue": 1000, "type": "int" }, "thickness": { + "description": "LaserCannon, BeamLaser and Lightning only. How thicc is the laser?", "defaultValue": 2, "type": "float" }, "coreThickness": { + "description": "BeamLaser and LaserCannon only. Thickness of the inner core as a fraction of full thickness (0-1). Just to get a secondary color via `rgbColor2`.", "defaultValue": 0.25, "type": "float" }, "laserFlareSize": { + "description": "BeamLaser only. Size of the flare visual effect at emit point, in elmos", "defaultValue": 15, "type": "float" }, "tileLength": { + "description": "'Large' BeamLaser only. Length in elmos of a repeated texture tile for the beam. Regular BeamLaser just has a single stretched tile.", "defaultValue": 200, "type": "float" }, "scrollSpeed": { + "description": "'Large' BeamLaser only. Speed in elmo/s at which the tiled beam texture shifts.", "defaultValue": 5, "type": "float" }, "pulseSpeed": { + "description": "'Large' BeamLaser only. Frequency of beam pulsation (fade to zero alpha and back) in hertz", "defaultValue": 1, "type": "float" }, "beamDecay": { + "description": "BeamLaser only. Controls the fadeout (multiplier for alpha per sim frame)", "defaultValue": 1, "type": "float" }, "falloffRate": { + "description": "LaserCannon with `hardStop = false` only. How much, as a fraction, the laser fades per sim frame beyond max range. Capped to be 0.2 or above (ie. will never take more than 5 sim frames to fade completely)", "defaultValue": 0.5, "type": "float" }, "hardstop": { "internalName": "laserHardStop", + "description": "LaserCannon only. If true, lasers get 'eaten up' at max range. Otherwise they continue on and fade away according to `intensityFalloff` (but can't collide anymore).", "defaultValue": 0, "type": "bool" }, "rgbColor": { + "description": "Color of the sprite, when not using a model. #EmgCannon has a different default of 0.9/0.9/0.2.", "defaultValue": [ 1, 0.5, 0 ], "type": "float3" }, "rgbColor2": { + "description": "BeamLaser and LaserCannon only. The color of the inner core of the sprite, see `coreThickness`.", "defaultValue": [ 1, 1, 1 ], "type": "float3" }, @@ -744,74 +912,88 @@ "type": "float" }, "colormap": { - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "A series of RGBA tuples. If the projectile is a sprite then it will shift over these colours over its lifetime", + "defaultValue": "", + "type": "std::string" }, "textures.1": { "internalName": "textures1", "fallbackName": "texture1", - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "When not using a model, sprite texture for AircraftBomb, Cannon, EMG, Flame; main beam texture for LaserCannon, BeamLaser, Lightning; flare texture for Missile, Starburst; dome for Shield. Note that DGun has a hardcoded texture.", + "defaultValue": "", + "type": "std::string" }, "textures.2": { "internalName": "textures2", "fallbackName": "texture2", - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "The end-of-beam texture for LaserCannon and BeamLaser (half of texture for each end); smoketrail for Missile and Starburst. Note that Torpedo has a hardcoded trail.", + "defaultValue": "", + "type": "std::string" }, "textures.3": { "internalName": "textures3", "fallbackName": "texture3", - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "Flare for non-'large' BeamLaser, or directional muzzle exhaust for 'large'; flame exhaust for Starburst.", + "defaultValue": "", + "type": "std::string" }, "textures.4": { "internalName": "textures4", "fallbackName": "texture4", - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "Flare for 'large' BeamLaser.", + "defaultValue": "", + "type": "std::string" }, "cegTag": { "description": "The name, without prefixes, of a CEG to be emitted by the projectile each frame.", - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "defaultValue": "", + "type": "std::string" }, "explosionGenerator": { - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "The name, with prefix, of a CEG to be emitted on impact", + "defaultValue": "", + "type": "std::string" }, "bounceExplosionGenerator": { - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "The name, with prefix, of a CEG to be emitted when bouncing", + "defaultValue": "", + "type": "std::string" }, "soundTrigger": { + "description": "Does the weapon produce the shooting sound only once for the whole burst? If false, for each shot in a burst.", "type": "bool" }, "soundStart": { - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "The sound emitted when shooting the weapon.", + "defaultValue": "", + "type": "std::string" }, "soundHitDry": { "fallbackName": "soundHit", - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "The sound emitted when hitting outside water. Note that a #BeamLaser will play this once per sim frame.", + "defaultValue": "", + "type": "std::string" }, "soundHitWet": { "fallbackName": "soundHit", - "defaultValue": , - "type": "std::__cxx11::basic_string, std::allocator >" + "description": "The sound emitted when hitting in water. Note that a #BeamLaser will play this once per sim frame.", + "defaultValue": "", + "type": "std::string" }, "soundStartVolume": { + "description": "Sound volume of the shot. -1 means autogenerated from damage.", "defaultValue": -1, "type": "float" }, "soundHitDryVolume": { "fallbackName": "soundHitVolume", + "description": "Sound volume of the impact, outside water. -1 means autogenerate from damage.", "defaultValue": -1, "type": "float" }, "soundHitWetVolume": { "fallbackName": "soundHitVolume", + "description": "Sound volume of the impact, inside water. -1 means autogenerate from damage.", "defaultValue": -1, "type": "float" } diff --git a/ldoc/classes/VAO.html b/ldoc/classes/VAO.html new file mode 100644 index 0000000000..43924422a8 --- /dev/null +++ b/ldoc/classes/VAO.html @@ -0,0 +1,558 @@ +--- +layout: default +title: VAO +permalink: ldoc/classes/VAO.html +description: Vertex Array Object +parent: Lua API +table: 0x55953a3e0650 +--- + +{% raw %} +

Class VAO

+

Vertex Array Object

+

+ +

+

+

See also:

+ + +

Methods

+
+
+ VAO:Delete +
+
+ + + +
+
+ VAO:AttachVertexBuffer +
+
+ Attachs a VBO to be used as a vertex buffer +
+
+ VAO:AttachInstanceBuffer +
+
+ Attachs a VBO to be used as an instance buffer +
+
+ VAO:AttachIndexBuffer +
+
+ Attachs a VBO to be used as an index buffer +
+
+ VAO:DrawArrays +
+
+ + + +
+
+ VAO:DrawElements +
+
+ + + +
+
+ VAO:AddUnitsToSubmission +
+
+ + + +
+
+ VAO:AddFeaturesToSubmission +
+
+ + + +
+
+ VAO:AddUnitDefsToSubmission +
+
+ + + +
+
+ VAO:AddFeatureDefsToSubmission +
+
+ + + +
+
+ VAO:RemoveFromSubmission +
+
+ + + +
+
+ VAO:Submit +
+
+ + + +
+
+ +

+ Methods +

+ +

+ VAO:Delete() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ VAO:AttachVertexBuffer(vbo) +

+

Attachs a VBO to be used as a vertex buffer

+
+

+ +

+ + +

Parameters:

+
    +
  1. + vbo + VBO + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ VAO:AttachInstanceBuffer(vbo) +

+

Attachs a VBO to be used as an instance buffer

+
+

+ +

+ + +

Parameters:

+
    +
  1. + vbo + VBO + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ VAO:AttachIndexBuffer(vbo) +

+

Attachs a VBO to be used as an index buffer

+
+

+ +

+ + +

Parameters:

+
    +
  1. + vbo + VBO + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ VAO:DrawArrays(glEnum[, vertexCount[, vertexFirst[, instanceCount[, instanceFirst]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + glEnum + number + primitivesMode +
    2. +
  2. + vertexCount + number + + + + (optional) +
    3. +
  3. + vertexFirst + number + + + + (optional) +
    4. +
  4. + instanceCount + number + + + + (optional) +
    5. +
  5. + instanceFirst + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ VAO:DrawElements(glEnum[, drawCount[, baseIndex[, instanceCount[, baseVertex[, baseInstance]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + glEnum + number + primitivesMode +
    2. +
  2. + drawCount + number + + + + (optional) +
    3. +
  3. + baseIndex + number + + + + (optional) +
    4. +
  4. + instanceCount + number + + + + (optional) +
    5. +
  5. + baseVertex + number + + + + (optional) +
    6. +
  6. + baseInstance + number + + + + (optional) +
    7. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ VAO:AddUnitsToSubmission(unitIDs) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitIDs + number or {number,...} + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + submittedCount
    2. +
+ + + +
+

+ VAO:AddFeaturesToSubmission(featureIDs) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureIDs + number or {number,...} + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + submittedCount
    2. +
+ + + +
+

+ VAO:AddUnitDefsToSubmission(unitDefIDs) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefIDs + number or {number,...} + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + submittedCount
    2. +
+ + + +
+

+ VAO:AddFeatureDefsToSubmission(featureDefIDs) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureDefIDs + number or {number,...} + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + submittedCount
    2. +
+ + + +
+

+ VAO:RemoveFromSubmission(index) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + index + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ VAO:Submit() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/classes/VBO.html b/ldoc/classes/VBO.html new file mode 100644 index 0000000000..5e1f09498a --- /dev/null +++ b/ldoc/classes/VBO.html @@ -0,0 +1,910 @@ +--- +layout: default +title: VBO +permalink: ldoc/classes/VBO.html +description: Vertex Buffer Object +parent: Lua API +table: 0x55953a75dfe0 +--- + +{% raw %} +

Class VBO

+

Vertex Buffer Object

+

+ +

+

+

See also:

+ + +

Methods

+
+
+ VBO:Delete +
+
+ + + +
+
+ VBO:Define +
+
+ Allows you to specify what kind of VBO you will be using. +
+
+ VBO:GetBufferSize +
+
+ + + +
+
+ VBO:Upload +
+
+ Uploads the data (array of floats) into the VBO +
+
+ VBO:Download +
+
+ + + +
+
+ VBO:ModelsVBO +
+
+ Binds engine side vertex or index VBO containing models (units, features) data. +
+
+ VBO:InstanceDataFromUnitDefIDs +
+
+ Fills in attribute data for each specified unitDefID +
+
+ VBO:InstanceDataFromFeatureDefIDs +
+
+ Fills in attribute data for each specified featureDefID +
+
+ VBO:InstanceDataFromUnitIDs +
+
+ Fills in attribute data for each specified unitID +
+
+ VBO:InstanceDataFromFeatureIDs +
+
+ Fills in attribute data for each specified featureID +
+
+ VBO:MatrixDataFromProjectileIDs +
+
+ + + +
+
+ VBO:BindBufferRange +
+
+ Bind a range within a buffer object to an indexed buffer target +
+
+ VBO:UnbindBufferRange +
+
+ + + +
+
+ VBO:DumpDefinition +
+
+ Logs the definition of the VBO to the console +
+
+ +

+ Methods +

+ +

+ VBO:Delete() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ VBO:Define(size, attribs) +

+

Allows you to specify what kind of VBO you will be using.

+
+

+ + + It is usually an array of vertex/color/uv data, but can also be an array of + instance uniforms. + + If you want to specify multiple instances of something to render, you will + need to create another VBO, which also specifies the number of instances you + wish to render, and the size of the data passed to each instance. + + If you want say 5 elements, and each element is defined in the layout: + + {id = 0, name = "first", size = 1},{id = 1, name = "second", size = 2}} + + , then the total size of your VBO will be 5 * (1 + 2). + + They will be laid out consecutively: [1,2],[1,2],[1,2],[1,2],[1,2]. + + This is important for when you call VBO:Upload, you need to make sure you + enter your data into the Lua array correctly. + +

+ + +

Parameters:

+
    +
  1. + size + number + the maximum number of elements this VBO can have. +
    2. +
  2. + attribs + number or {{number,number,number,number,number},...} + + + +

    When number, the maximum number of elements this VBO can have.

    + +

    Otherwise, an array of arrays specifying the layout composed of:

    + +
      +
    • id: the location in the vertex shader layout e.g.: layout (location = 0) + in vec2 aPos. optional attrib, specifies location in the vertex shader. + If not specified the implementation will increment the counter starting from 0. + There can be maximum 16 attributes (so id of 15 is max).
      • +
    • name: the name for this VBO, only used for debugging
      • +
    • size: optional, defaults to 4 for VBO. The number of floats that + constitute 1 element in this buffer. O.g. for the previous layout + (location = 0) in vec2 aPos, it would be size = 2.
      • +
    • type: is the datatype of this element, can be: GL.BYTE, + GL.UNSIGNED_BYTE, GL.SHORT, GL.UNSIGNED_SHORT, GL.INT, + GL.UNSIGNED_INT, GL.FLOAT. Default is GL.FLOAT.
      • +
    • normalized: it's possible to submit say normal without normalizing them + first, normalized will make sure data is normalized. + Optional attrib, defaults to false.
      • +
    + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + +

See also:

+ + +

Usage:

+
    + 
  • terrainVertexVBO:Define(numPoints, { {id = 0, name = "pos", size = 2}, })
    • +
+
+

+ VBO:GetBufferSize() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + elementsCount
    2. +
  2. + number + bufferSizeInBytes
    3. +
  3. + number + size
    4. +
+ + + +
+

+ VBO:Upload(vboData[, attributeIndex=-1[, elemOffset=0[, luaStartIndex=0[, luaFinishIndex]]]]) +

+

Uploads the data (array of floats) into the VBO

+
+

+ +

+ + +

Parameters:

+
    +
  1. + vboData + {number,...} + a lua array of values to upload into the + VBO +
    2. +
  2. + attributeIndex + number + If supplied with non-default value then the + data from vboData will only be used to upload the data to this particular + attribute. + The whole vboData is expected to contain only attributeIndex data. + Otherwise all attributes get updated sequentially across attributes and elements. + (default -1) +
    3. +
  3. + elemOffset + number + which VBO element to start uploading data from Lua array into + (default 0) +
    4. +
  4. + luaStartIndex + number + start uploading from that element in supplied Lua array + (default 0) +
    5. +
  5. + luaFinishIndex + number + consider this element the last element in Lua array + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + {number, + ...} indexData
    2. +
  2. + number + elemOffset
    3. +
  3. + number or {number,number,number,number} + attrID
    4. +
+ + +

See also:

+ + +

Usage:

+
    + 
  • vbo:Upload(posArray, 0, 1)
+-- 0 is offset into vbo (on GPU) in this case no offset
+-- 1 is lua index index into the Lua table, in this case it's same as default
+-- Upload will upload from luaOffset to end of lua array
    • + 
  • rectInstanceVBO:Upload({1},0)
    • +
+
+

+ VBO:Download([attributeIndex=-1[, elementOffset=0[, elementCount[, forceGPURead=false]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + attributeIndex + number + when supplied with non-default value: only data + from specified attribute will be downloaded - otherwise all attributes are + downloaded + (default -1) +
    2. +
  2. + elementOffset + number + download data starting from this element + (default 0) +
    3. +
  3. + elementCount + number + number of elements to download + (optional) +
    4. +
  4. + forceGPURead + bool + force downloading the data from GPU buffer as opposed + to using shadow RAM buffer + (default false) +
    5. +
+ +

Returns:

+
    +
  1. + {{number,...},...} + vboData
    2. +
+ + + +
+

+ VBO:ModelsVBO() +

+

Binds engine side vertex or index VBO containing models (units, features) data.

+
+

+ + + Also fills in VBO definition data as they're set for engine models (no need to do VBO:Define()). + +

+ + + +

Returns:

+
    +
  1. + nil or number + buffer size in bytes
    2. +
+ + + +
+

+ VBO:InstanceDataFromUnitDefIDs(unitDefIDs, attrID[, teamIdOpt[, elementOffset]]) +

+

Fills in attribute data for each specified unitDefID

+
+

+ + + The instance data in that attribute will contain the offset to bind position + matrix in global matrices SSBO and offset to uniform buffer structure in + global per unit/feature uniform SSBO (unused for Unit/FeatureDefs), as + well as some auxiliary data ushc as draw flags and team index. + +

+ + +

Parameters:

+
    +
  1. + unitDefIDs + number or {number,...} + + + +
    2. +
  2. + attrID + number + + + +
    3. +
  3. + teamIdOpt + number + + + + (optional) +
    4. +
  4. + elementOffset + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + {number,number,number,number} + instanceData
    2. +
  2. + number + elementOffset
    3. +
  3. + attrID + + +
    4. +
+ + + +

Usage:

+
    + 
  • Data Layout
+
+SInstanceData:
+   , matOffset{ matOffset_ }            // updated during the following draw frames
+   , uniOffset{ uniOffset_ }            // updated during the following draw frames
+   , info{ teamIndex, drawFlags, 0, 0 } // not updated during the following draw frames
+   , aux1 { 0u }
    • +
+
+

+ VBO:InstanceDataFromFeatureDefIDs(featureDefIDs, attrID[, teamIdOpt[, elementOffset]]) +

+

Fills in attribute data for each specified featureDefID

+
+

+ + + The instance data in that attribute will contain the offset to bind position + matrix in global matrices SSBO and offset to uniform buffer structure in + global per unit/feature uniform SSBO (unused for Unit/FeatureDefs), as + well as some auxiliary data ushc as draw flags and team index. + +

+ + +

Parameters:

+
    +
  1. + featureDefIDs + number or {number,...} + + + +
    2. +
  2. + attrID + number + + + +
    3. +
  3. + teamIdOpt + number + + + + (optional) +
    4. +
  4. + elementOffset + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + {number,number,number,number} + instanceData
    2. +
  2. + number + elementOffset
    3. +
  3. + attrID + + +
    4. +
+ + + +

Usage:

+
    + 
  • Data Layout
+
+SInstanceData:
+   , matOffset{ matOffset_ }            // updated during the following draw frames
+   , uniOffset{ uniOffset_ }            // updated during the following draw frames
+   , info{ teamIndex, drawFlags, 0, 0 } // not updated during the following draw frames
+   , aux1 { 0u }
    • +
+
+

+ VBO:InstanceDataFromUnitIDs(unitIDs, attrID[, teamIdOpt[, elementOffset]]) +

+

Fills in attribute data for each specified unitID

+
+

+ + + The instance data in that attribute will contain the offset to bind position + matrix in global matrices SSBO and offset to uniform buffer structure in + global per unit/feature uniform SSBO (unused for Unit/FeatureDefs), as + well as some auxiliary data ushc as draw flags and team index. + +

+ + +

Parameters:

+
    +
  1. + unitIDs + number or {number,...} + + + +
    2. +
  2. + attrID + number + + + +
    3. +
  3. + teamIdOpt + number + + + + (optional) +
    4. +
  4. + elementOffset + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + {number,number,number,number} + instanceData
    2. +
  2. + number + elementOffset
    3. +
  3. + attrID + + +
    4. +
+ + + +

Usage:

+
    + 
  • Data Layout
+
+SInstanceData:
+   , matOffset{ matOffset_ }            // updated during the following draw frames
+   , uniOffset{ uniOffset_ }            // updated during the following draw frames
+   , info{ teamIndex, drawFlags, 0, 0 } // not updated during the following draw frames
+   , aux1 { 0u }
    • +
+
+

+ VBO:InstanceDataFromFeatureIDs(featureIDs, attrID[, teamIdOpt[, elementOffset]]) +

+

Fills in attribute data for each specified featureID

+
+

+ + + The instance data in that attribute will contain the offset to bind position + matrix in global matrices SSBO and offset to uniform buffer structure in + global per unit/feature uniform SSBO (unused for Unit/FeatureDefs), as + well as some auxiliary data ushc as draw flags and team index. + +

+ + +

Parameters:

+
    +
  1. + featureIDs + number or {number,...} + + + +
    2. +
  2. + attrID + number + + + +
    3. +
  3. + teamIdOpt + number + + + + (optional) +
    4. +
  4. + elementOffset + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + {number,number,number,number} + instanceData
    2. +
  2. + number + elementOffset
    3. +
  3. + attrID + + +
    4. +
+ + + +
+

+ VBO:MatrixDataFromProjectileIDs(projectileIDs, attrID[, teamIdOpt[, elementOffset]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileIDs + number or {number,...} + + + +
    2. +
  2. + attrID + number + + + +
    3. +
  3. + teamIdOpt + number + + + + (optional) +
    4. +
  4. + elementOffset + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + {number, + ...} matDataVec 4x4 matrix
    2. +
  2. + number + elemOffset
    3. +
  3. + number or {number,number,number,number} + attrID
    4. +
+ + + +
+

+ VBO:BindBufferRange(index[, elementOffset[, elementCount[, target]]]) +

+

Bind a range within a buffer object to an indexed buffer target

+
+

+ + + Generally mimics + https://registry.khronos.org/OpenGL-Refpages/gl4/html/glBindBufferRange.xhtml + except offset and size are specified in number of elements / element indices. + +

+ + +

Parameters:

+
    +
  1. + index + number + should be in the range between + 5 < index < GL_MAX_UNIFORM_BUFFER_BINDINGS value (usually 31) +
    2. +
  2. + elementOffset + number + + + + (optional) +
    3. +
  3. + elementCount + number + + + + (optional) +
    4. +
  4. + target + number + glEnum + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + number + bindingIndex when successful, -1 otherwise
    2. +
+ + + +
+

+ VBO:UnbindBufferRange(index[, elementOffset[, elementCount[, target]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + index + number + + + +
    2. +
  2. + elementOffset + number + + + + (optional) +
    3. +
  3. + elementCount + number + + + + (optional) +
    4. +
  4. + target + number + glEnum + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + number + bindingIndex when successful, -1 otherwise
    2. +
+ + + +
+

+ VBO:DumpDefinition() +

+

Logs the definition of the VBO to the console

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/index.html b/ldoc/index.html new file mode 100644 index 0000000000..c132102b7b --- /dev/null +++ b/ldoc/index.html @@ -0,0 +1,135 @@ +--- +layout: default +title: Home +permalink: ldoc/index.html +description: +parent: Lua API +published: false +--- + +{% raw %} +

A Lua documentation tool

+ +

Modules

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SyncedCtrlSynced Lua API
UnsyncedCtrlCallouts to set state
SyncedReadSynced Read
UnsyncedReadCallouts to get state
MoveCtrlMoveCtrl
LuaHandleCallins, functions called by the Engine
LuaHandleSyncedCallins, functions called by the Engine (Synced)
VFSVirtual File System
LuaVAO + +
LuaVBO + +
OpenGLLua OpenGL API
LuaZipLuaZip
LuaRulesLua Rules
MetalMapMetal Map Lua API
ShadersShader creation and management
FBOFBO
RBORBO
MathExtramath extensions
BitOpsmath bit extensions
GameGame constants
EngineEngine constants
PlatformPlatform constants
CMDCommand constants
CMDTYPECommand type constants
COBCOB constants
GLOpenGL Constants
+

Classes

+ + + + + + + + + +
VAOVertex Array Object
VBOVertex Buffer Object
+{% endraw %} diff --git a/ldoc/ldoc.css b/ldoc/ldoc.css new file mode 100644 index 0000000000..52c4ad2bd8 --- /dev/null +++ b/ldoc/ldoc.css @@ -0,0 +1,303 @@ +/* BEGIN RESET + +Copyright (c) 2010, Yahoo! Inc. All rights reserved. +Code licensed under the BSD License: +http://developer.yahoo.com/yui/license.html +version: 2.8.2r1 +*/ +html { + color: #000; + background: #FFF; +} +body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { + margin: 0; + padding: 0; +} +table { + border-collapse: collapse; + border-spacing: 0; +} +fieldset,img { + border: 0; +} +address,caption,cite,code,dfn,em,strong,th,var,optgroup { + font-style: inherit; + font-weight: inherit; +} +del,ins { + text-decoration: none; +} +li { + margin-left: 20px; +} +caption,th { + text-align: left; +} +h1,h2,h3,h4,h5,h6 { + font-size: 100%; + font-weight: bold; +} +q:before,q:after { + content: ''; +} +abbr,acronym { + border: 0; + font-variant: normal; +} +sup { + vertical-align: baseline; +} +sub { + vertical-align: baseline; +} +legend { + color: #000; +} +input,button,textarea,select,optgroup,option { + font-family: inherit; + font-size: inherit; + font-style: inherit; + font-weight: inherit; +} +input,button,textarea,select {*font-size:100%; +} +/* END RESET */ + +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color: #ffffff; margin: 0px; +} + +code, tt { font-family: monospace; font-size: 1.1em; } +span.parameter { font-family:monospace; } +span.parameter:after { content:":"; } +span.types:before { content:"("; } +span.types:after { content:")"; } +.type { font-weight: bold; font-style:italic } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 0px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 20px 0 20px 0; +} +h2, h3, h4 { margin: 15px 0 10px 0; } +h2 { font-size: 1.25em; } +h3 { font-size: 1.15em; } +h4 { font-size: 1.06em; } + +a:link { font-weight: bold; color: #004080; text-decoration: none; } +a:visited { font-weight: bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration: underline; } + +hr { + color:#cccccc; + background: #00007f; + height: 1px; +} + +blockquote { margin-left: 3em; } + +ul { list-style-type: disc; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; +} + +pre { + background-color: rgb(245, 245, 245); + border: 1px solid #C0C0C0; /* silver */ + padding: 10px; + margin: 10px 0 10px 0; + overflow: auto; + font-family: "Andale Mono", monospace; +} + +pre.example { + font-size: .85em; +} + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } + +#container { + margin-left: 1em; + margin-right: 1em; + background-color: #f0f0f0; +} + +#product { + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#main { + background-color: #f0f0f0; + border-left: 2px solid #cccccc; +} + +#navigation { + float: left; + width: 14em; + vertical-align: top; + background-color: #f0f0f0; + overflow: visible; +} + +#navigation h2 { + background-color:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align: left; + padding:0.2em; + border-top:1px solid #dddddd; + border-bottom:1px solid #dddddd; +} + +#navigation ul +{ + font-size:1em; + list-style-type: none; + margin: 1px 1px 10px 1px; +} + +#navigation li { + text-indent: -1em; + display: block; + margin: 3px 0px 0px 22px; +} + +#navigation li li a { + margin: 0px 3px 0px -1em; +} + +#content { + margin-left: 14em; + padding: 1em; + width: 700px; + border-left: 2px solid #cccccc; + border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about { + clear: both; + padding: 5px; + border-top: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 12pt "Times New Roman", "TimeNR", Times, serif; + } + a { font-weight: bold; color: #004080; text-decoration: underline; } + + #main { + background-color: #ffffff; + border-left: 0px; + } + + #container { + margin-left: 2%; + margin-right: 2%; + background-color: #ffffff; + } + + #content { + padding: 1em; + background-color: #ffffff; + } + + #navigation { + display: none; + } + pre.example { + font-family: "Andale Mono", monospace; + font-size: 10pt; + page-break-inside: avoid; + } +} + +table.module_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.module_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.module_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.module_list td.summary { width: 100%; } + + +table.function_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.function_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.function_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.function_list td.summary { width: 100%; } + +ul.nowrap { + overflow:auto; + white-space:nowrap; +} + +dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} +dl.table h3, dl.function h3 {font-size: .95em;} + +/* stop sublists from having initial vertical space */ +ul ul { margin-top: 0px; } +ol ul { margin-top: 0px; } +ol ol { margin-top: 0px; } +ul ol { margin-top: 0px; } + +/* make the target distinct; helps when we're navigating to a function */ +a:target + * { + background-color: #FF9; +} + + +/* styles for prettification of source */ +pre .comment { color: #558817; } +pre .constant { color: #a8660d; } +pre .escape { color: #844631; } +pre .keyword { color: #aa5050; font-weight: bold; } +pre .library { color: #0e7c6b; } +pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } +pre .string { color: #8080ff; } +pre .number { color: #f8660d; } +pre .operator { color: #2239a8; font-weight: bold; } +pre .preprocessor, pre .prepro { color: #a33243; } +pre .global { color: #800080; } +pre .user-keyword { color: #800080; } +pre .prompt { color: #558817; } +pre .url { color: #272fc2; text-decoration: underline; } + diff --git a/ldoc/modules/BitOps.html b/ldoc/modules/BitOps.html new file mode 100644 index 0000000000..01c786e4a7 --- /dev/null +++ b/ldoc/modules/BitOps.html @@ -0,0 +1,330 @@ +--- +layout: default +title: BitOps +permalink: ldoc/modules/BitOps.html +description: math bit extensions +parent: Lua API +table: 0x55953a6b7d90 +--- + +{% raw %} +

Module BitOps

+

math bit extensions

+

+ + +

Note: there are no bit shift. Use those Lua functions instead for 24 bits bitshift + 24 bits because only the 24 bits of the mantissa can be easily used in a 32 bit float + bitshift functions (<<, >> equivalent)

+ + +
+-- left shift
+local function lsh(value,shift)
+    return (value*(2^shift)) % 2^24
+end
+
+-- right shift
+local function rsh(value,shift)
+    return math.floor(value/2^shift) % 2^24
+end
+
+ +
+

+

See also:

+ + +

Functions

+
+
+ math.bit_or +
+
+ Returns the bitwise OR of all arguments. +
+
+ math.bit_and +
+
+ Returns the bitwise AND of all arguments. +
+
+ math.bit_xor +
+
+ Returns the bitwise XOR of all arguments. +
+
+ math.bit_inv +
+
+ Returns the bitwise NOT of the 24 bit integer argument. +
+
+ math.bit_bits +
+
+ Set each of the bits of a 24 bit integer. +
+
+ +

+ Functions +

+ +

+ math.bit_or(a1, a2[, a3[, an]]) +

+

Returns the bitwise OR of all arguments.

+
+

+ Only use up to 24 bit integers. + +

+ + +

Parameters:

+
    +
  1. + a1 + number + + + +
    2. +
  2. + a2 + number + + + +
    3. +
  3. + a3 + number + + + + (optional) +
    4. +
  4. + an + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + number + i
    2. +
+ + + +
+

+ math.bit_and(a1, a2[, a3[, an]]) +

+

Returns the bitwise AND of all arguments.

+
+

+ Only use up to 24 bit integers. + +

+ + +

Parameters:

+
    +
  1. + a1 + number + + + +
    2. +
  2. + a2 + number + + + +
    3. +
  3. + a3 + number + + + + (optional) +
    4. +
  4. + an + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + number + i
    2. +
+ + + +
+

+ math.bit_xor(a1, a2[, a3[, an]]) +

+

Returns the bitwise XOR of all arguments.

+
+

+ Only use up to 24 bit integers. + +

+ + +

Parameters:

+
    +
  1. + a1 + number + + + +
    2. +
  2. + a2 + number + + + +
    3. +
  3. + a3 + number + + + + (optional) +
    4. +
  4. + an + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + number + i
    2. +
+ + + +
+

+ math.bit_inv(a1) +

+

Returns the bitwise NOT of the 24 bit integer argument.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + a1 + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + i
    2. +
+ + + +
+

+ math.bit_bits(a1, a2[, a3[, an]]) +

+

Set each of the bits of a 24 bit integer.

+
+

+ Returns result = result OR (1 << a1) OR (1 << a2) OR ...;) + +

+ + +

Parameters:

+
    +
  1. + a1 + number + + + +
    2. +
  2. + a2 + number + + + +
    3. +
  3. + a3 + number + + + + (optional) +
    4. +
  4. + an + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + number + i
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/CMD.html b/ldoc/modules/CMD.html new file mode 100644 index 0000000000..09bd661c5b --- /dev/null +++ b/ldoc/modules/CMD.html @@ -0,0 +1,305 @@ +--- +layout: default +title: CMD +permalink: ldoc/modules/CMD.html +description: Command constants +parent: Lua API +table: 0x55953a7713a0 +--- + +{% raw %} +

Module CMD

+

Command constants

+

+ +

+

+

See also:

+ + +

Tables

+
+
+ CMD +
+
+ + + +
+
+ +

+ Tables +

+ +

+ CMD +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + FIRESTATE_NONE + -1 +
    2. +
  2. + MOVESTATE_NONE + -1 +
    3. +
  3. + STOP + 0 +
    4. +
  4. + MOVESTATE_HOLDPOS + 0 +
    5. +
  5. + FIRESTATE_HOLDFIRE + 0 +
    6. +
  6. + INSERT + 1 +
    7. +
  7. + MOVESTATE_MANEUVER + 1 +
    8. +
  8. + FIRESTATE_RETURNFIRE + 1 +
    9. +
  9. + WAITCODE_TIME + 1 +
    10. +
  10. + WAITCODE_DEATH + 2 +
    11. +
  11. + MOVESTATE_ROAM + 2 +
    12. +
  12. + REMOVE + 2 +
    13. +
  13. + FIRESTATE_FIREATWILL + 2 +
    14. +
  14. + FIRESTATE_FIREATNEUTRAL + 3 +
    15. +
  15. + WAITCODE_SQUAD + 3 +
    16. +
  16. + OPT_META + 4 +
    17. +
  17. + WAITCODE_GATHER + 4 +
    18. +
  18. + WAIT + 5 +
    19. +
  19. + TIMEWAIT + 6 +
    20. +
  20. + DEATHWAIT + 7 +
    21. +
  21. + OPT_INTERNAL + 8 +
    22. +
  22. + SQUADWAIT + 8 +
    23. +
  23. + GATHERWAIT + 9 +
    24. +
  24. + MOVE + 10 +
    25. +
  25. + PATROL + 15 +
    26. +
  26. + FIGHT + 16 +
    27. +
  27. + OPT_RIGHT + 16 +
    28. +
  28. + LOOPBACKATTACK + 20 +
    29. +
  29. + ATTACK + 20 +
    30. +
  30. + AREA_ATTACK + 21 +
    31. +
  31. + GUARD + 25 +
    32. +
  32. + AISELECT + 30 +
    33. +
  33. + OPT_SHIFT + 32 +
    34. +
  34. + GROUPSELECT + 35 +
    35. +
  35. + GROUPADD + 36 +
    36. +
  36. + GROUPCLEAR + 37 +
    37. +
  37. + REPAIR + 40 +
    38. +
  38. + FIRE_STATE + 45 +
    39. +
  39. + MOVE_STATE + 50 +
    40. +
  40. + SETBASE + 55 +
    41. +
  41. + INTERNAL + 60 +
    42. +
  42. + OPT_CTRL + 64 +
    43. +
  43. + SELFD + 65 +
    44. +
  44. + SET_WANTED_MAX_SPEED + 70 +
    45. +
  45. + LOAD_UNITS + 75 +
    46. +
  46. + LOAD_ONTO + 76 +
    47. +
  47. + UNLOAD_UNITS + 80 +
    48. +
  48. + UNLOAD_UNIT + 81 +
    49. +
  49. + ONOFF + 85 +
    50. +
  50. + RECLAIM + 90 +
    51. +
  51. + CLOAK + 95 +
    52. +
  52. + STOCKPILE + 100 +
    53. +
  53. + MANUALFIRE + 105 +
    54. +
  54. + DGUN + 105 +
    55. +
  55. + RESTORE + 110 +
    56. +
  56. + REPEAT + 115 +
    57. +
  57. + TRAJECTORY + 120 +
    58. +
  58. + RESURRECT + 125 +
    59. +
  59. + OPT_ALT + 128 +
    60. +
  60. + CAPTURE + 130 +
    61. +
  61. + AUTOREPAIRLEVEL + 135 +
    62. +
  62. + IDLEMODE + 145 +
    63. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/CMDTYPE.html b/ldoc/modules/CMDTYPE.html new file mode 100644 index 0000000000..0f67ba65f5 --- /dev/null +++ b/ldoc/modules/CMDTYPE.html @@ -0,0 +1,136 @@ +--- +layout: default +title: CMDTYPE +permalink: ldoc/modules/CMDTYPE.html +description: Command type constants +parent: Lua API +table: 0x55953a7c20c0 +--- + +{% raw %} +

Module CMDTYPE

+

Command type constants

+

+ +

+

+

See also:

+ + +

Tables

+
+
+ CMDTYPE +
+
+ Note, the CMDTYPE[] table is bidirectional. +
+
+ +

+ Tables +

+ +

+ CMDTYPE +

+

Note, the CMDTYPE[] table is bidirectional.

+
+

+ That means: CMDTYPE[CMDTYPE.ICON] := "CMDTYPE_ICON" + +

+ + +

Fields:

+
    +
  1. + ICON + number + expect 0 parameters in return +
    2. +
  2. + ICON_MODE + number + expect 1 parameter in return (number selected mode) +
    3. +
  3. + ICON_MAP + number + expect 3 parameters in return (mappos) +
    4. +
  4. + ICON_AREA + number + expect 4 parameters in return (mappos+radius) +
    5. +
  5. + ICON_UNIT + number + expect 1 parameters in return (unitid) +
    6. +
  6. + ICON_UNIT_OR_MAP + number + expect 1 parameters in return (unitid) or 3 parameters in return (mappos) +
    7. +
  7. + ICON_FRONT + number + expect 3 or 6 parameters in return (middle and right side of front if a front was defined) +
    8. +
  8. + COMBO_BOX + number + expect 1 parameter in return (number selected option) +
    9. +
  9. + ICON_UNIT_OR_AREA + number + expect 1 parameter in return (unitid) or 4 parameters in return (mappos+radius) +
    10. +
  10. + ICON_UNIT_FEATURE_OR_AREA + number + expect 1 parameter in return (unitid or Game.maxUnits+featureid) or 4 parameters in return (mappos+radius) +
    11. +
  11. + ICON_BUILDING + number + expect 3 parameters in return (mappos) +
    12. +
  12. + ICON_UNIT_OR_RECTANGLE + number + expect 1 parameter in return (unitid) or 3 parameters in return (mappos) or 6 parameters in return (startpos+endpos) +
    13. +
  13. + NUMBER + number + expect 1 parameter in return (number) +
    14. +
  14. + CUSTOM + number + used with CMD_INTERNAL +
    15. +
  15. + NEXT + number + next command page used with CMD_INTERNAL +
    16. +
  16. + PREV + number + previous command page used with CMD_INTERNAL +
    17. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/COB.html b/ldoc/modules/COB.html new file mode 100644 index 0000000000..ae729e2f9d --- /dev/null +++ b/ldoc/modules/COB.html @@ -0,0 +1,784 @@ +--- +layout: default +title: COB +permalink: ldoc/modules/COB.html +description: COB constants +parent: Lua API +table: 0x55953a76c9d0 +--- + +{% raw %} +

Module COB

+

COB constants

+

+ +

+

+

See also:

+ + +

Tables

+
+
+ COB +
+
+ + + +
+
+ SFX +
+
+ Piece Flags for Spring.UnitScript.Explode +
+
+ SFX +
+
+ For Spring.UnitScript.EmitSfx +
+
+ +

+ Tables +

+ +

+ COB +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + ACTIVATION + number + + + +
    2. +
  2. + STANDINGMOVEORDERS + number + + + +
    3. +
  3. + STANDINGFIREORDERS + number + + + +
    4. +
  4. + HEALTH + number + + + +
    5. +
  5. + INBUILDSTANCE + number + + + +
    6. +
  6. + BUSY + number + + + +
    7. +
  7. + PIECE_XZ + number + + + +
    8. +
  8. + PIECE_Y + number + + + +
    9. +
  9. + UNIT_XZ + number + + + +
    10. +
  10. + UNIT_Y + number + + + +
    11. +
  11. + UNIT_HEIGHT + number + + + +
    12. +
  12. + XZ_ATAN + number + + + +
    13. +
  13. + XZ_HYPOT + number + + + +
    14. +
  14. + ATAN + number + + + +
    15. +
  15. + HYPOT + number + + + +
    16. +
  16. + GROUND_HEIGHT + number + + + +
    17. +
  17. + BUILD_PERCENT_LEFT + number + + + +
    18. +
  18. + YARD_OPEN + number + + + +
    19. +
  19. + BUGGER_OFF + number + + + +
    20. +
  20. + ARMORED + number + + + +
    21. +
  21. + IN_WATER + number + + + +
    22. +
  22. + CURRENT_SPEED + number + + + +
    23. +
  23. + VETERAN_LEVEL + number + + + +
    24. +
  24. + ON_ROAD + number + + + +
    25. +
  25. + MAX_ID + number + + + +
    26. +
  26. + MY_ID + number + + + +
    27. +
  27. + UNIT_TEAM + number + + + +
    28. +
  28. + UNIT_BUILD_PERCENT_LEFT + number + + + +
    29. +
  29. + UNIT_ALLIED + number + + + +
    30. +
  30. + MAX_SPEED + number + + + +
    31. +
  31. + CLOAKED + number + + + +
    32. +
  32. + WANT_CLOAK + number + + + +
    33. +
  33. + GROUND_WATER_HEIGHT + number + + + +
    34. +
  34. + UPRIGHT + number + + + +
    35. +
  35. + POW + number + + + +
    36. +
  36. + PRINT + number + + + +
    37. +
  37. + HEADING + number + + + +
    38. +
  38. + TARGET_ID + number + + + +
    39. +
  39. + LAST_ATTACKER_ID + number + + + +
    40. +
  40. + LOS_RADIUS + number + + + +
    41. +
  41. + AIR_LOS_RADIUS + number + + + +
    42. +
  42. + RADAR_RADIUS + number + + + +
    43. +
  43. + JAMMER_RADIUS + number + + + +
    44. +
  44. + SONAR_RADIUS + number + + + +
    45. +
  45. + SONAR_JAM_RADIUS + number + + + +
    46. +
  46. + SEISMIC_RADIUS + number + + + +
    47. +
  47. + DO_SEISMIC_PING + number + + + +
    48. +
  48. + CURRENT_FUEL + number + + + +
    49. +
  49. + TRANSPORT_ID + number + + + +
    50. +
  50. + SHIELD_POWER + number + + + +
    51. +
  51. + STEALTH + number + + + +
    52. +
  52. + CRASHING + number + + + +
    53. +
  53. + CHANGE_TARGET + number + + + +
    54. +
  54. + CEG_DAMAGE + number + + + +
    55. +
  55. + COB_ID + number + + + +
    56. +
  56. + PLAY_SOUND + number + + + +
    57. +
  57. + KILL_UNIT + number + + + +
    58. +
  58. + ALPHA_THRESHOLD + number + + + +
    59. +
  59. + SET_WEAPON_UNIT_TARGET + number + + + +
    60. +
  60. + SET_WEAPON_GROUND_TARGET + number + + + +
    61. +
  61. + SONAR_STEALTH + number + + + +
    62. +
  62. + REVERSING + number + + + +
    63. +
  63. + FLANK_B_MODE + number + + + +
    64. +
  64. + FLANK_B_DIR + number + + + +
    65. +
  65. + FLANK_B_MOBILITY_ADD + number + + + +
    66. +
  66. + FLANK_B_MAX_DAMAGE + number + + + +
    67. +
  67. + FLANK_B_MIN_DAMAGE + number + + + +
    68. +
  68. + WEAPON_RELOADSTATE + number + + + +
    69. +
  69. + WEAPON_RELOADTIME + number + + + +
    70. +
  70. + WEAPON_ACCURACY + number + + + +
    71. +
  71. + WEAPON_SPRAY + number + + + +
    72. +
  72. + WEAPON_RANGE + number + + + +
    73. +
  73. + WEAPON_PROJECTILE_SPEED + number + + + +
    74. +
  74. + MIN + number + + + +
    75. +
  75. + MAX + number + + + +
    76. +
  76. + ABS + number + + + +
    77. +
  77. + GAME_FRAME + number + + + +
    78. +
+ + + + +
+

+ SFX +

+

Piece Flags for Spring.UnitScript.Explode

+
+

+ +

+ + +

Fields:

+
    +
  1. + SHATTER + number + + + +
    2. +
  2. + EXPLODE + number + + + +
    3. +
  3. + EXPLODE_ON_HIT + number + + + +
    4. +
  4. + FALL + number + + + +
    5. +
  5. + SMOKE + number + + + +
    6. +
  6. + FIRE + number + + + +
    7. +
  7. + NONE + number + + + +
    8. +
  8. + NO_CEG_TRAIL + number + + + +
    9. +
  9. + NO_HEATCLOUD + number + + + +
    10. +
  10. + RECURSIVE + number + + + +
    11. +
+ + + + +
+

+ SFX +

+

For Spring.UnitScript.EmitSfx

+
+

+ +

+ + +

Fields:

+
    +
  1. + VTOL + number + + + +
    2. +
  2. + WAKE + number + + + +
    3. +
  3. + REVERSE_WAKE + number + + + +
    4. +
  4. + WHITE_SMOKE + number + + + +
    5. +
  5. + BLACK_SMOKE + number + + + +
    6. +
  6. + BUBBLE + number + + + +
    7. +
  7. + CEG + number + + + +
    8. +
  8. + FIRE_WEAPON + number + + + +
    9. +
  9. + DETONATE_WEAPON + number + + + +
    10. +
  10. + GLOBAL + number + + + +
    11. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/Engine.html b/ldoc/modules/Engine.html new file mode 100644 index 0000000000..e119151a95 --- /dev/null +++ b/ldoc/modules/Engine.html @@ -0,0 +1,89 @@ +--- +layout: default +title: Engine +permalink: ldoc/modules/Engine.html +description: Engine constants +parent: Lua API +table: 0x55953a53d280 +--- + +{% raw %} +

Module Engine

+

Engine constants

+

+ +

+

+

See also:

+ + +

Tables

+
+
+ Engine +
+
+ Engine specific information +
+
+ +

+ Tables +

+ +

+ Engine +

+

Engine specific information

+
+

+ +

+ + +

Fields:

+
    +
  1. + version + string + Returns the same as spring *sync-version, e.g. "92" +
    2. +
  2. + versionFull + string + + + +
    3. +
  3. + versionPatchSet + string + + + +
    4. +
  4. + buildFlags + string + (unsynced only) Gets additional engine buildflags, e.g. "OMP" or "MT-Sim DEBUG" +
    5. +
  5. + FeatureSupport + string + table containing various engine features as keys; use for cross-version compat +
    6. +
  6. + wordSize + number + indicates the build type and is either 32 or 64 (or 0 in synced code) +
    7. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/FBO.html b/ldoc/modules/FBO.html new file mode 100644 index 0000000000..e9dc8a1052 --- /dev/null +++ b/ldoc/modules/FBO.html @@ -0,0 +1,598 @@ +--- +layout: default +title: FBO +permalink: ldoc/modules/FBO.html +description: FBO +parent: Lua API +table: 0x55953a97bd40 +--- + +{% raw %} +

Module FBO

+

FBO

+

+ +

+

+

See also:

+ + +

Functions

+
+
+ gl.CreateFBO +
+
+ + + +
+
+ gl.DeleteFBO +
+
+ + + +
+
+ gl.IsValidFBO +
+
+ + + +
+
+ gl.ActiveFBO +
+
+ + + +
+
+ gl.BlitFBO +
+
+ needs GLEW_EXT_framebuffer_blit +
+
+ gl.BlitFBO +
+
+ needs GLEW_EXT_framebuffer_blit +
+
+

Tables

+
+
+ attachment +
+
+ + + +
+
+ fbo +
+
+ User Data FBO +
+
+ +

+ Functions +

+ +

+ gl.CreateFBO(data) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. data + + + +
+ + + + +
+

+ gl.DeleteFBO(fbo) +

+

+
+

+ + This doesn't delete the attached objects! +

+ + +

Parameters:

+
    +
  1. + fbo + fbo + + + +
    2. +
+ + + + +
+

+ gl.IsValidFBO(fbo[, target]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + fbo + fbo + + + +
    2. +
  2. + target + number + + + + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + bool + valid
    2. +
  2. + optional number + status
    3. +
+ + + +
+

+ gl.ActiveFBO(fbo[, target[, identities[, lua_function[, arg1[, arg2[, argn]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + fbo + fbo + + + +
    2. +
  2. + target + number + + + + (optional) +
    3. +
  3. + identities + bool + + + + (optional) +
    4. +
  4. + lua_function + func + + + + (optional) +
    5. +
  5. + arg1 + + + + (optional) +
    6. +
  6. + arg2 + + + + (optional) +
    7. +
  7. + argn + + + + (optional) +
    8. +
+ + + + +
+

+ gl.BlitFBO(x0Src, y0Src, x1Src, y1Src, x0Dst, y0Dst, x1Dst, y1Dst[, mask=GL_COLOR_BUFFER_BIT[, filter=GL_NEAREST]]) +

+

needs `GLEW_EXT_framebuffer_blit`

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x0Src + number + + + +
    2. +
  2. + y0Src + number + + + +
    3. +
  3. + x1Src + number + + + +
    4. +
  4. + y1Src + number + + + +
    5. +
  5. + x0Dst + number + + + +
    6. +
  6. + y0Dst + number + + + +
    7. +
  7. + x1Dst + number + + + +
    8. +
  8. + y1Dst + number + + + +
    9. +
  9. + mask + number + + + + (default GL_COLOR_BUFFER_BIT) +
    10. +
  10. + filter + number + + + + (default GL_NEAREST) +
    11. +
+ + + + +
+

+ gl.BlitFBO(fboSrc, x0Src, y0Src, x1Src, y1Src, fboDst, x0Dst, y0Dst, x1Dst, y1Dst[, mask=GL_COLOR_BUFFER_BIT[, filter=GL_NEAREST]]) +

+

needs `GLEW_EXT_framebuffer_blit`

+
+

+ +

+ + +

Parameters:

+
    +
  1. + fboSrc + fbo + + + +
    2. +
  2. + x0Src + number + + + +
    3. +
  3. + y0Src + number + + + +
    4. +
  4. + x1Src + number + + + +
    5. +
  5. + y1Src + number + + + +
    6. +
  6. + fboDst + fbo + + + +
    7. +
  7. + x0Dst + number + + + +
    8. +
  8. + y0Dst + number + + + +
    9. +
  9. + x1Dst + number + + + +
    10. +
  10. + y1Dst + number + + + +
    11. +
  11. + mask + number + + + + (default GL_COLOR_BUFFER_BIT) +
    12. +
  12. + filter + number + + + + (default GL_NEAREST) +
    13. +
+ + + + +
+

+ Tables +

+ +

+ attachment +

+

+
+

+ + attachment ::= luaTex or `RBO.rbo` or nil or { luaTex [, num target [, num level ] ] } +

+ + + + + + +
+

+ fbo +

+

User Data FBO

+
+

+ +

+ + +

Fields:

+
    +
  1. + depth + attachment + + + +
    2. +
  2. + stencil + attachment + + + +
    3. +
  3. + color0 + attachment + + + +
    4. +
  4. + color1 + attachment + + + +
    5. +
  5. + color2 + attachment + + + +
    6. +
  6. + colorn + attachment + + + +
    7. +
  7. + color15 + attachment + + + +
    8. +
  8. + drawbuffers + table + { GL_COLOR_ATTACHMENT0_EXT, GL_COLOR_ATTACHMENT3_EXT, ..} +
    9. +
  9. + readbuffer + table + GL_COLOR_ATTACHMENT0_EXT +
    10. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/GL.html b/ldoc/modules/GL.html new file mode 100644 index 0000000000..2de8c4c9d0 --- /dev/null +++ b/ldoc/modules/GL.html @@ -0,0 +1,3185 @@ +--- +layout: default +title: GL +permalink: ldoc/modules/GL.html +description: OpenGL Constants +parent: Lua API +table: 0x55953a873980 +--- + +{% raw %} +

Module GL

+

OpenGL Constants

+

+ +

+

+

See also:

+ + +

Drawing Primitives

+
+
+ GL +
+
+ + + +
+
+

BlendingFactorDest

+
+
+ GL +
+
+ + + +
+
+

BlendingFactorSrc

+
+
+ GL +
+
+ + + +
+
+

AlphaFunction and DepthFunction

+
+
+ GL +
+
+ + + +
+
+

LogicOp

+
+
+ GL +
+
+ + + +
+
+

Culling

+
+
+ GL +
+
+ + + +
+
+

PolygonMode

+
+
+ GL +
+
+ + + +
+
+

Clear Bits

+
+
+ GL +
+
+ + + +
+
+

ShadeModel

+
+
+ GL +
+
+ + + +
+
+

MatrixMode

+
+
+ GL +
+
+ + + +
+
+

Texture Filtering

+
+
+ GL +
+
+ + + +
+
+

Texture Clamping

+
+
+ GL +
+
+ + + +
+
+

Texture Environment

+
+
+ GL +
+
+ + + +
+
+ GL_TEXTURE_FILTER_CONTROL +
+
+ + + +
+
+ GL_TEXTURE_LOD_BIAS +
+
+ + + +
+
+

Texture Generation

+
+
+ GL +
+
+ + + +
+
+

glPushAttrib() bits

+
+
+ GL +
+
+ + + +
+
+

glHint() targets

+
+
+ GL +
+
+ + + +
+
+

glHint() modes

+
+
+ GL +
+
+ + + +
+
+

Light Specification

+
+
+ GL +
+
+ + + +
+
+

Shader Types

+
+
+ GL +
+
+ + + +
+
+

Geometry Shader Parameters

+
+
+ GL +
+
+ + + +
+
+

Tesselation control shader parameters

+
+
+ GL +
+
+ + + +
+
+

OpenGL Data Types

+
+
+ GL +
+
+ + + +
+
+

OpenGL Buffer Types

+
+
+ GL +
+
+ + + +
+
+

FBO Attachments

+
+
+ GL_COLOR_ATTACHMENT0_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT1_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT2_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT3_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT4_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT5_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT6_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT7_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT8_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT9_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT10_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT11_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT12_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT13_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT14_EXT +
+
+ + + +
+
+ GL_COLOR_ATTACHMENT15_EXT +
+
+ + + +
+
+ GL_DEPTH_ATTACHMENT_EXT +
+
+ + + +
+
+ GL_STENCIL_ATTACHMENT_EXT +
+
+ + + +
+
+

Not included, but useful texture Formats

+
+
+ GL_RGBA16F_ARB +
+
+ + + +
+
+ GL_RGBA32F_ARB +
+
+ + + +
+
+ GL_DEPTH_COMPONENT +
+
+ + + +
+
+

Not included, but useful RBO Formats

+
+
+ GL_RGB +
+
+ + + +
+
+ GL_RGBA +
+
+ + + +
+
+ GL_DEPTH_COMPONENT +
+
+ + + +
+
+ GL_STENCIL_INDEX +
+
+ + + +
+
+

Not included, but useful FBO Targets

+
+
+ GL_FRAMEBUFFER_EXT +
+
+ + + +
+
+ GL_READ_FRAMEBUFFER_EXT +
+
+ + + +
+
+ GL_DRAW_FRAMEBUFFER_EXT +
+
+ + + +
+
+

Not included, but useful FBO Status

+
+
+ GL_FRAMEBUFFER_COMPLETE_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_UNSUPPORTED_EXT +
+
+ + + +
+
+ GL_FRAMEBUFFER_STATUS_ERROR_EXT +
+
+ + + +
+
+ +

+ Drawing Primitives +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + POINTS + number + + + +
    2. +
  2. + LINES + number + + + +
    3. +
  3. + LINE_LOOP + number + + + +
    4. +
  4. + LINE_STRIP + number + + + +
    5. +
  5. + TRIANGLES + number + + + +
    6. +
  6. + TRIANGLE_STRIP + number + + + +
    7. +
  7. + TRIANGLE_FAN + number + + + +
    8. +
  8. + QUADS + number + + + +
    9. +
  9. + QUAD_STRIP + number + + + +
    10. +
  10. + POLYGON + number + + + +
    11. +
  11. + PATCHES + number + + + +
    12. +
+ + + + +
+

+ BlendingFactorDest +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + ZERO + number + + + +
    2. +
  2. + ONE + number + + + +
    3. +
  3. + SRC_COLOR + number + + + +
    4. +
  4. + ONE_MINUS_SRC_COLOR + number + + + +
    5. +
  5. + SRC_ALPHA + number + + + +
    6. +
  6. + ONE_MINUS_SRC_ALPHA + number + + + +
    7. +
  7. + DST_ALPHA + number + + + +
    8. +
  8. + ONE_MINUS_DST_ALPHA + number + + + +
    9. +
+ + + + +
+

+ BlendingFactorSrc +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + ZERO + number + + + +
    2. +
  2. + ONE + number + + + +
    3. +
  3. + SRC_COLOR + number + + + +
    4. +
  4. + ONE_MINUS_SRC_COLOR + number + + + +
    5. +
  5. + SRC_ALPHA + number + + + +
    6. +
  6. + ONE_MINUS_SRC_ALPHA + number + + + +
    7. +
  7. + DST_ALPHA + number + + + +
    8. +
  8. + ONE_MINUS_DST_ALPHA + number + + + +
    9. +
  9. + DST_COLOR + number + + + +
    10. +
  10. + ONE_MINUS_DST_COLOR + number + + + +
    11. +
  11. + SRC_ALPHA_SATURATE + number + + + +
    12. +
  12. + FUNC_ADD + number + + + +
    13. +
  13. + FUNC_SUBTRACT + number + + + +
    14. +
  14. + FUNC_REVERSE_SUBTRACT + number + + + +
    15. +
  15. + MIN + number + + + +
    16. +
  16. + MAX + number + + + +
    17. +
+ + + + +
+

+ AlphaFunction and DepthFunction +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + NEVER + number + + + +
    2. +
  2. + LESS + number + + + +
    3. +
  3. + EQUAL + number + + + +
    4. +
  4. + LEQUAL + number + + + +
    5. +
  5. + GREATER + number + + + +
    6. +
  6. + NOTEQUAL + number + + + +
    7. +
  7. + GEQUAL + number + + + +
    8. +
  8. + ALWAYS + number + + + +
    9. +
+ + + + +
+

+ LogicOp +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + CLEAR + number + + + +
    2. +
  2. + AND + number + + + +
    3. +
  3. + AND_REVERSE + number + + + +
    4. +
  4. + COPY + number + + + +
    5. +
  5. + AND_INVERTED + number + + + +
    6. +
  6. + NOOP + number + + + +
    7. +
  7. + XOR + number + + + +
    8. +
  8. + OR + number + + + +
    9. +
  9. + NOR + number + + + +
    10. +
  10. + EQUIV + number + + + +
    11. +
  11. + INVERT + number + + + +
    12. +
  12. + OR_REVERSE + number + + + +
    13. +
  13. + COPY_INVERTED + number + + + +
    14. +
  14. + OR_INVERTED + number + + + +
    15. +
  15. + NAND + number + + + +
    16. +
  16. + SET + number + + + +
    17. +
+ + + + +
+

+ Culling +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + BACK + number + + + +
    2. +
  2. + FRONT + number + + + +
    3. +
  3. + FRONT_AND_BACK + number + + + +
    4. +
+ + + + +
+

+ PolygonMode +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + POINT + number + + + +
    2. +
  2. + LINE + number + + + +
    3. +
  3. + FILL + number + + + +
    4. +
+ + + + +
+

+ Clear Bits +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + DEPTH_BUFFER_BIT + number + + + +
    2. +
  2. + ACCUM_BUFFER_BIT + number + + + +
    3. +
  3. + STENCIL_BUFFER_BIT + number + + + +
    4. +
  4. + COLOR_BUFFER_BIT + number + + + +
    5. +
+ + + + +
+

+ ShadeModel +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + FLAT + number + + + +
    2. +
  2. + SMOOTH + number + + + +
    3. +
+ + + + +
+

+ MatrixMode +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + MODELVIEW + number + + + +
    2. +
  2. + PROJECTION + number + + + +
    3. +
  3. + TEXTURE + number + + + +
    4. +
+ + + + +
+

+ Texture Filtering +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + NEAREST + number + + + +
    2. +
  2. + LINEAR + number + + + +
    3. +
  3. + NEAREST_MIPMAP_NEAREST + number + + + +
    4. +
  4. + LINEAR_MIPMAP_NEAREST + number + + + +
    5. +
  5. + NEAREST_MIPMAP_LINEAR + number + + + +
    6. +
  6. + LINEAR_MIPMAP_LINEAR + number + + + +
    7. +
+ + + + +
+

+ Texture Clamping +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + REPEAT + number + + + +
    2. +
  2. + MIRRORED_REPEAT + number + + + +
    3. +
  3. + CLAMP + number + + + +
    4. +
  4. + CLAMP_TO_EDGE + number + + + +
    5. +
  5. + CLAMP_TO_BORDER + number + + + +
    6. +
+ + + + +
+

+ Texture Environment +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + TEXTURE_ENV + number + + + +
    2. +
  2. + TEXTURE_ENV_MODE + number + + + +
    3. +
  3. + TEXTURE_ENV_COLOR + number + + + +
    4. +
  4. + MODULATE + number + + + +
    5. +
  5. + DECAL + number + + + +
    6. +
  6. + BLEND + number + + + +
    7. +
  7. + REPLACE + number + + + +
    8. +
+ + + + +
+

+ GL_TEXTURE_FILTER_CONTROL +

+

+
+

+ +

+ + +
    +
  1. + GL_TEXTURE_FILTER_CONTROL + + + +
    2. +
+ + + + +
+

+ GL_TEXTURE_LOD_BIAS +

+

+
+

+ +

+ + +
    +
  1. + GL_TEXTURE_LOD_BIAS + + + +
    2. +
+ + + + +
+

+ Texture Generation +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + TEXTURE_GEN_MODE + number + + + +
    2. +
  2. + EYE_PLANE + number + + + +
    3. +
  3. + OBJECT_PLANE + number + + + +
    4. +
  4. + EYE_LINEAR + number + + + +
    5. +
  5. + OBJECT_LINEAR + number + + + +
    6. +
  6. + SPHERE_MAP + number + + + +
    7. +
  7. + NORMAL_MAP + number + + + +
    8. +
  8. + REFLECTION_MAP + number + + + +
    9. +
  9. + S + number + + + +
    10. +
  10. + T + number + + + +
    11. +
  11. + R + number + + + +
    12. +
  12. + Q + number + + + +
    13. +
+ + + + +
+

+ glPushAttrib() bits +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + CURRENT_BIT + number + + + +
    2. +
  2. + POINT_BIT + number + + + +
    3. +
  3. + LINE_BIT + number + + + +
    4. +
  4. + POLYGON_BIT + number + + + +
    5. +
  5. + POLYGON_STIPPLE_BIT + number + + + +
    6. +
  6. + PIXEL_MODE_BIT + number + + + +
    7. +
  7. + LIGHTING_BIT + number + + + +
    8. +
  8. + FOG_BIT + number + + + +
    9. +
  9. + DEPTH_BUFFER_BIT + number + + + +
    10. +
  10. + ACCUM_BUFFER_BIT + number + + + +
    11. +
  11. + STENCIL_BUFFER_BIT + number + + + +
    12. +
  12. + VIEWPORT_BIT + number + + + +
    13. +
  13. + TRANSFORM_BIT + number + + + +
    14. +
  14. + ENABLE_BIT + number + + + +
    15. +
  15. + COLOR_BUFFER_BIT + number + + + +
    16. +
  16. + HINT_BIT + number + + + +
    17. +
  17. + EVAL_BIT + number + + + +
    18. +
  18. + LIST_BIT + number + + + +
    19. +
  19. + TEXTURE_BIT + number + + + +
    20. +
  20. + SCISSOR_BIT + number + + + +
    21. +
  21. + ALL_ATTRIB_BITS + number + + + +
    22. +
+ + + + +
+

+ glHint() targets +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + FOG_HINT + number + + + +
    2. +
  2. + LINE_SMOOTH_HINT + number + + + +
    3. +
  3. + POINT_SMOOTH_HINT + number + + + +
    4. +
  4. + POLYGON_SMOOTH_HINT + number + + + +
    5. +
  5. + PERSPECTIVE_CORRECTION_HINT + number + + + +
    6. +
+ + + + +
+

+ glHint() modes +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + DONT_CARE + number + + + +
    2. +
  2. + FASTEST + number + + + +
    3. +
  3. + NICEST + number + + + +
    4. +
+ + + + +
+

+ Light Specification +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + AMBIENT + number + + + +
    2. +
  2. + DIFFUSE + number + + + +
    3. +
  3. + SPECULAR + number + + + +
    4. +
  4. + POSITION + number + + + +
    5. +
  5. + SPOT_DIRECTION + number + + + +
    6. +
  6. + SPOT_EXPONENT + number + + + +
    7. +
  7. + SPOT_CUTOFF + number + + + +
    8. +
  8. + CONSTANT_ATTENUATION + number + + + +
    9. +
  9. + LINEAR_ATTENUATION + number + + + +
    10. +
  10. + QUADRATIC_ATTENUATION + number + + + +
    11. +
+ + + + +
+

+ Shader Types +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + VERTEX_SHADER + number + + + +
    2. +
  2. + TESS_CONTROL_SHADER + number + + + +
    3. +
  3. + TESS_EVALUATION_SHADER + number + + + +
    4. +
  4. + GEOMETRY_SHADER + number + + + +
    5. +
  5. + FRAGMENT_SHADER + number + + + +
    6. +
+ + + + +
+

+ Geometry Shader Parameters +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + GEOMETRY_INPUT_TYPE + number + + + +
    2. +
  2. + GEOMETRY_OUTPUT_TYPE + number + + + +
    3. +
  3. + GEOMETRY_VERTICES_OUT + number + + + +
    4. +
+ + + + +
+

+ Tesselation control shader parameters +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + PATCH_VERTICES + number + + + +
    2. +
  2. + PATCH_DEFAULT_OUTER_LEVEL + number + + + +
    3. +
  3. + PATCH_DEFAULT_INNER_LEVEL + number + + + +
    4. +
+ + + + +
+

+ OpenGL Data Types +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + BYTE + number + + + +
    2. +
  2. + UNSIGNED_BYTE + number + + + +
    3. +
  3. + SHORT + number + + + +
    4. +
  4. + UNSIGNED_SHORT + number + + + +
    5. +
  5. + INT + number + + + +
    6. +
  6. + UNSIGNED_INT + number + + + +
    7. +
  7. + FLOAT + number + + + +
    8. +
  8. + FLOAT_VEC4 + number + + + +
    9. +
  9. + INT_VEC4 + number + + + +
    10. +
  10. + UNSIGNED_INT_VEC4 + number + + + +
    11. +
  11. + FLOAT_MAT4 + number + + + +
    12. +
+ + + + +
+

+ OpenGL Buffer Types +

+ +

+ GL +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + ELEMENT_ARRAY_BUFFER + number + + + +
    2. +
  2. + ARRAY_BUFFER + number + + + +
    3. +
  3. + UNIFORM_BUFFER + number + + + +
    4. +
  4. + SHADER_STORAGE_BUFFER + number + + + +
    5. +
+ + + + +
+

+ FBO Attachments +

+ +

+ +

+

+

+ GL_COLOR_ATTACHMENT0_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT0_EXT + 0x8CE0 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT1_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT1_EXT + 0x8CE1 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT2_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT2_EXT + 0x8CE2 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT3_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT3_EXT + 0x8CE3 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT4_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT4_EXT + 0x8CE4 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT5_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT5_EXT + 0x8CE5 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT6_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT6_EXT + 0x8CE6 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT7_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT7_EXT + 0x8CE7 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT8_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT8_EXT + 0x8CE8 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT9_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT9_EXT + 0x8CE9 +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT10_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT10_EXT + 0x8CEA +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT11_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT11_EXT + 0x8CEB +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT12_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT12_EXT + 0x8CEC +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT13_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT13_EXT + 0x8CED +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT14_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT14_EXT + 0x8CEE +
    2. +
+ + + + +
+

+ GL_COLOR_ATTACHMENT15_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_COLOR_ATTACHMENT15_EXT + 0x8CEF +
    2. +
+ + + + +
+

+ GL_DEPTH_ATTACHMENT_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_DEPTH_ATTACHMENT_EXT + 0x8D00 +
    2. +
+ + + + +
+

+ GL_STENCIL_ATTACHMENT_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_STENCIL_ATTACHMENT_EXT + 0x8D20 +
    2. +
+ + + + +
+

+ Not included, but useful texture Formats +

+ +

+ +

+

+

+ GL_RGBA16F_ARB +

+

+
+

+ +

+ + +
    +
  1. + GL_RGBA16F_ARB + 0x881A +
    2. +
+ + + + +
+

+ GL_RGBA32F_ARB +

+

+
+

+ +

+ + +
    +
  1. + GL_RGBA32F_ARB + 0x8814 +
    2. +
+ + + + +
+

+ GL_DEPTH_COMPONENT +

+

+
+

+ +

+ + +
    +
  1. + GL_DEPTH_COMPONENT + 0x1902 +
    2. +
+ + + + +
+

+ Not included, but useful RBO Formats +

+ +

+ +

+

+

+ GL_RGB +

+

+
+

+ +

+ + +
    +
  1. + GL_RGB + 0x1907 +
    2. +
+ + + + +
+

+ GL_RGBA +

+

+
+

+ +

+ + +
    +
  1. + GL_RGBA + 0x1908 +
    2. +
+ + + + +
+

+ GL_DEPTH_COMPONENT +

+

+
+

+ +

+ + +
    +
  1. + GL_DEPTH_COMPONENT + 0x1902 +
    2. +
+ + + + +
+

+ GL_STENCIL_INDEX +

+

+
+

+ +

+ + +
    +
  1. + GL_STENCIL_INDEX + 0x1901 +
    2. +
+ + + + +
+

+ Not included, but useful FBO Targets +

+ +

+ +

+

+

+ GL_FRAMEBUFFER_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_EXT + 0x8D40 +
    2. +
+ + + + +
+

+ GL_READ_FRAMEBUFFER_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_READ_FRAMEBUFFER_EXT + 0x8CA8 +
    2. +
+ + + + +
+

+ GL_DRAW_FRAMEBUFFER_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_DRAW_FRAMEBUFFER_EXT + 0x8CA9 +
    2. +
+ + + + +
+

+ Not included, but useful FBO Status +

+ +

+ +

+

+

+ GL_FRAMEBUFFER_COMPLETE_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_COMPLETE_EXT + 0x8CD5 +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT + 0x8CD6 +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT + 0x8CD7 +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT + 0x8CD8 +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT + 0x8CD9 +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT + 0x8CDA +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT + 0x8CDB +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT + 0x8CDC +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_UNSUPPORTED_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_UNSUPPORTED_EXT + 0x8CDD +
    2. +
+ + + + +
+

+ GL_FRAMEBUFFER_STATUS_ERROR_EXT +

+

+
+

+ +

+ + +
    +
  1. + GL_FRAMEBUFFER_STATUS_ERROR_EXT + 0x8CDE +
    2. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/Game.html b/ldoc/modules/Game.html new file mode 100644 index 0000000000..d0210de80c --- /dev/null +++ b/ldoc/modules/Game.html @@ -0,0 +1,440 @@ +--- +layout: default +title: Game +permalink: ldoc/modules/Game.html +description: Game constants +parent: Lua API +table: 0x55953a95eea0 +--- + +{% raw %} +

Module Game

+

Game constants

+

+ +

+

+

See also:

+ + +

Tables

+
+
+ Game +
+
+ Game specific information +
+
+ +

+ Tables +

+ +

+ Game +

+

Game specific information

+
+

+ +

+ + +

Fields:

+
    +
  1. + maxUnits + number + + + +
    2. +
  2. + maxTeams + number + + + +
    3. +
  3. + maxPlayers + number + + + +
    4. +
  4. + squareSize + number + Divide Game.mapSizeX or Game.mapSizeZ by this to get engine's "mapDims" coordinates. The resolution of height, yard and type maps. +
    5. +
  5. + metalMapSquareSize + number + The resolution of metalmap (for use in API such as Spring.GetMetalAmount etc.) +
    6. +
  6. + gameSpeed + number + + + +
    7. +
  7. + startPosType + number + + + +
    8. +
  8. + ghostedBuildings + bool + + + +
    9. +
  9. + mapChecksum + string + + + +
    10. +
  10. + modChecksum + string + + + +
    11. +
  11. + mapDamage + bool + + + +
    12. +
  12. + mapName + string + + + +
    13. +
  13. + mapDescription + string + = string Game.mapHumanName +
    14. +
  14. + mapHardness + number + + + +
    15. +
  15. + mapX + number + + + +
    16. +
  16. + mapY + number + + + +
    17. +
  17. + mapSizeX + number + in worldspace/opengl coords. Divide by Game.squareSize to get engine's "mapDims" coordinates +
    18. +
  18. + mapSizeZ + number + in worldspace/opengl coords. Divide by Game.squareSize to get engine's "mapDims" coordinates +
    19. +
  19. + gravity + number + + + +
    20. +
  20. + tidal + number + + + +
    21. +
  21. + windMin + number + + + +
    22. +
  22. + windMax + number + + + +
    23. +
  23. + extractorRadius + number + + + +
    24. +
  24. + waterDamage + number + + + +
    25. +
  25. + envDamageTypes + table + Containing {def}IDs of environmental-damage sources +
    26. +
  26. + gameName + string + + + +
    27. +
  27. + gameShortName + string + + + +
    28. +
  28. + gameVersion + string + + + +
    29. +
  29. + gameMutator + string + + + +
    30. +
  30. + gameDesc + string + + + +
    31. +
  31. + requireSonarUnderWater + bool + + + +
    32. +
  32. + transportAir + number + + + +
    33. +
  33. + transportShip + number + + + +
    34. +
  34. + transportHover + number + + + +
    35. +
  35. + transportGround + number + + + +
    36. +
  36. + fireAtKilled + number + + + +
    37. +
  37. + fireAtCrashing + number + + + +
    38. +
  38. + constructionDecay + bool + + + +
    39. +
  39. + reclaimAllowEnemies + bool + + + +
    40. +
  40. + reclaimAllowAllies + bool + + + +
    41. +
  41. + constructionDecayTime + number + + + +
    42. +
  42. + constructionDecaySpeed + number + + + +
    43. +
  43. + multiReclaim + number + + + +
    44. +
  44. + reclaimMethod + number + + + +
    45. +
  45. + reclaimUnitMethod + number + + + +
    46. +
  46. + reclaimUnitEnergyCostFactor + number + + + +
    47. +
  47. + reclaimUnitEfficiency + number + + + +
    48. +
  48. + reclaimFeatureEnergyCostFactor + number + + + +
    49. +
  49. + repairEnergyCostFactor + number + + + +
    50. +
  50. + resurrectEnergyCostFactor + number + + + +
    51. +
  51. + captureEnergyCostFactor + number + + + +
    52. +
  52. + springCategories + table + + +
     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
+ }
+
    + +
    53. +
  53. + armorTypes + table + +

    (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, ...
+ }
+
    + +
    54. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/LuaHandle.html b/ldoc/modules/LuaHandle.html new file mode 100644 index 0000000000..e62b6d7f27 --- /dev/null +++ b/ldoc/modules/LuaHandle.html @@ -0,0 +1,4982 @@ +--- +layout: default +title: LuaHandle +permalink: ldoc/modules/LuaHandle.html +description: Callins, functions called by the Engine +parent: Lua API +table: 0x55953a8dcdd0 +--- + +{% raw %} +

Module LuaHandle

+

Callins, functions called by the Engine

+

+ + +

This page is future looking to unified widget/gadget (aka "addon") handler, which may yet be some way off, c.f. the changelog.

+ +

Related Sourcecode: LuaHandle.cpp

+ +

For now, to use these addons in a widget, prepend widget: and, for a gadget, prepend gadget:. For example,

+ + +
+function widget:UnitCreated(unitID, unitDefID, unitTeam, builderID)
+    ...
+end
+
+ +

Some functions may differ between (synced) gadget and widgets; those are in the Synced - Unsynced Shared section. Essentially the reason is that all information should be available to synced (game logic controlling) gadgets, but restricted to unsynced gadget/widget (e.g. information about an enemy unit only detected via radar and not yet in LOS). In such cases the full (synced) param list is documented.

+ +

Attention: some callins will only work on the unsynced portion of the gadget. Due to the type-unsafe nature of lua parsing, those callins not firing up might be hard to trace. This document will be continuously updated to properly alert about those situations.

+ +
+

+

See also:

+ + +

Teams

+
+
+ TeamDied +
+
+ Called when a team dies (see Spring.KillTeam). +
+
+ TeamChanged +
+
+ + + +
+
+ PlayerChanged +
+
+ Called whenever a player's status changes e.g. +
+
+ PlayerAdded +
+
+ Called whenever a new player joins the game. +
+
+ PlayerRemoved +
+
+ Called whenever a player is removed from the game. +
+
+

Projectiles

+
+
+ ProjectileCreated +
+
+ Called when the projectile is created. +
+
+ ProjectileDestroyed +
+
+ Called when the projectile is destroyed. +
+
+ Explosion +
+
+ Called when an explosion occurs. +
+
+ StockpileChanged +
+
+ Called when a units stockpile of weapons increases or decreases. +
+
+ RecvLuaMsg +
+
+ Receives messages from unsynced sent via Spring.SendLuaRulesMsg or Spring.SendLuaUIMsg. +
+
+ Save +
+
+ Called when a chat command '/save' or '/savegame' is received. +
+
+ UnsyncedHeightMapUpdate +
+
+ Called when the unsynced copy of the height-map is altered. +
+
+ Update +
+
+ Called for every draw frame (including when the game is paused) and at least once per sim frame except when catching up. +
+
+ ViewResize +
+
+ Called whenever the window is resized. +
+
+ SunChanged +
+
+ + + +
+
+ DefaultCommand +
+
+ Used to set the default command when a unit is selected. +
+
+

Features

+
+
+ FeatureCreated +
+
+ Called when a feature is created. +
+
+ FeatureDestroyed +
+
+ Called when a feature is destroyed. +
+
+ FeatureDamaged +
+
+ Called when a feature is damaged. +
+
+

Common

+
+
+ Initialize +
+
+ Called when the addon is (re)loaded. +
+
+ LoadCode +
+
+ Called when the game is (re)loaded. +
+
+ Shutdown +
+
+ Called when the addon or the game is shutdown. +
+
+ GotChatMsg +
+
+ Called when a player issues a UI command e.g. +
+
+ Load +
+
+ Called after GamePreload and before GameStart. +
+
+

Game

+
+
+ GamePreload +
+
+ Called before the 0 gameframe. +
+
+ GameStart +
+
+ Called upon the start of the game. +
+
+ GameOver +
+
+ Called when the game ends +
+
+ GamePaused +
+
+ Called when the game is paused. +
+
+ GameFrame +
+
+ Called for every game simulation frame (30 per second). +
+
+ GameFramePost +
+
+ Called at the end of every game simulation frame +
+
+ GameID +
+
+ Called once to deliver the gameID +
+
+

Units

+
+
+ UnitCreated +
+
+ Called at the moment the unit is created. +
+
+ UnitFinished +
+
+ Called at the moment the unit is completed. +
+
+ UnitFromFactory +
+
+ Called when a factory finishes construction of a unit. +
+
+ UnitReverseBuilt +
+
+ Called when a living unit becomes a nanoframe again. +
+
+ UnitDestroyed +
+
+ Called when a unit is destroyed. +
+
+ UnitTaken +
+
+ Called when a unit is transferred between teams. +
+
+ UnitGiven +
+
+ Called when a unit is transferred between teams. +
+
+ UnitIdle +
+
+ Called when a unit is idle (empty command queue). +
+
+ UnitCommand +
+
+ Called after when a unit accepts a command, after AllowCommand returns true. +
+
+ UnitCmdDone +
+
+ Called when a unit completes a command. +
+
+ UnitDamaged +
+
+ Called when a unit is damaged (after UnitPreDamaged). +
+
+ UnitStunned +
+
+ Called when a unit changes its stun status. +
+
+ UnitExperience +
+
+ Called when a unit gains experience greater or equal to the minimum limit set by calling Spring.SetExperienceGrade. +
+
+ UnitHarvestStorageFull +
+
+ Called when a unit's harvestStorage is full (according to its unitDef's entry). +
+
+ UnitSeismicPing +
+
+ Called when a unit emits a seismic ping. +
+
+ UnitEnteredRadar +
+
+ Called when a unit enters radar of an allyteam. +
+
+ UnitEnteredLos +
+
+ Called when a unit enters LOS of an allyteam. +
+
+ UnitLeftRadar +
+
+ Called when a unit leaves radar of an allyteam. +
+
+ UnitLeftLos +
+
+ Called when a unit leaves LOS of an allyteam. +
+
+

Transport

+
+
+ UnitLoaded +
+
+ Called when a unit is loaded by a transport. +
+
+ UnitUnloaded +
+
+ Called when a unit is unloaded by a transport. +
+
+

Unit Interactions

+
+
+ UnitEnteredUnderwater +
+
+ + + +
+
+ UnitEnteredWater +
+
+ + + +
+
+ UnitLeftAir +
+
+ + + +
+
+ UnitLeftUnderwater +
+
+ + + +
+
+ UnitLeftWater +
+
+ + + +
+
+ UnitEnteredAir +
+
+ + + +
+
+ UnitCloaked +
+
+ Called when a unit cloaks. +
+
+ UnitDecloaked +
+
+ Called when a unit decloaks. +
+
+ UnitUnitCollision +
+
+ Called when two units collide. +
+
+ UnitFeatureCollision +
+
+ Called when a unit collides with a feature. +
+
+ UnitMoveFailed +
+
+ + + +
+
+ UnitArrivedAtGoal +
+
+ + + +
+
+ RenderUnitDestroyed +
+
+ Called just before a unit is invalid, after it finishes its death animation. +
+
+

Draw* Functions

+
+
+ DrawGenesis +
+
+ Use this callin to update textures, shaders, etc. +
+
+ DrawWorld +
+
+ Spring draws command queues, 'map stuff', and map marks. +
+
+ DrawWorldPreUnit +
+
+ Spring draws units, features, some water types, cloaked units, and the sun. +
+
+ DrawPreDecals +
+
+ Called before decals are drawn +
+
+ DrawWaterPost +
+
+ + + +
+
+ DrawShadowPassTransparent +
+
+ Invoked after semi-transparent shadows pass is about to conclude +
+
+ DrawWorldShadow +
+
+ + + +
+
+ DrawWorldReflection +
+
+ + + +
+
+ DrawWorldRefraction +
+
+ + + +
+
+ DrawGroundPreForward +
+
+ Runs at the start of the forward pass when a custom map shader has been assigned via Spring.SetMapShader (convenient for setting uniforms). +
+
+ DrawGroundPostForward +
+
+ + + +
+
+ DrawGroundPreDeferred +
+
+ Runs at the start of the deferred pass when a custom map shader has been assigned via Spring.SetMapShader (convenient for setting uniforms). +
+
+ DrawGroundDeferred +
+
+ + + +
+
+ DrawGroundPostDeferred +
+
+ This runs at the end of its respective deferred pass. +
+
+ DrawUnitsPostDeferred +
+
+ Runs at the end of the unit deferred pass. +
+
+ DrawFeaturesPostDeferred +
+
+ Runs at the end of the feature deferred pass to inform Lua code it should make use of the $modelgbuffer* textures before another pass overwrites them (and to allow proper blending with e.g. +
+
+ DrawShadowUnitsLua +
+
+ + + +
+
+ DrawShadowFeaturesLua +
+
+ + + +
+
+ DrawWorldPreParticles +
+
+ DrawWorldPreParticles is called multiples times per draw frame. +
+
+ DrawScreen +
+
+ Also available to LuaMenu. +
+
+ DrawScreenEffects +
+
+ + + +
+
+ DrawScreenPost +
+
+ Similar to DrawScreenEffects, this can be used to alter the contents of a frame after it has been completely rendered (i.e. +
+
+ DrawInMinimap +
+
+ + + +
+
+ DrawInMinimapBackground +
+
+ + + +
+
+ GameProgress +
+
+ Called every 60 frames, calculating delta between GameFrame and GameProgress. +
+
+ KeyMapChanged +
+
+ Called when the keymap changes +
+
+

Input

+
+
+ mods +
+
+ Key Modifier Params +
+
+ KeyPress +
+
+ Called repeatedly when a key is pressed down. +
+
+ KeyRelease +
+
+ Called when the key is released. +
+
+ TextInput +
+
+ Called whenever a key press results in text input. +
+
+ TextEditing +
+
+ + + +
+
+ MousePress +
+
+ Called when a mouse button is pressed. +
+
+ MouseRelease +
+
+ Called when a mouse button is released. +
+
+ MouseMove +
+
+ Called when the mouse is moved. +
+
+ MouseWheel +
+
+ Called when the mouse wheel is moved. +
+
+ IsAbove +
+
+ Called every Update. +
+
+ GetTooltip +
+
+ Called when Spring.IsAbove returns true. +
+
+ cmdOpts +
+
+ Parameters for command options +
+
+ CommandNotify +
+
+ Called when a command is issued. +
+
+ AddConsoleLine +
+
+ Called when text is entered into the console (e.g. +
+
+ GroupChanged +
+
+ Called when a unit is added to or removed from a control group. +
+
+ WorldTooltip +
+
+ + + +
+
+ MapDrawCmd +
+
+ + + +
+
+ GameSetup +
+
+ + + +
+
+ RecvSkirmishAIMessage +
+
+ + + +
+
+

Downloads

+
+
+ DownloadQueued +
+
+ Called when a Pr-downloader download is queued +
+
+ DownloadStarted +
+
+ Called when a Pr-downloader download is started via VFS.DownloadArchive. +
+
+ DownloadFinished +
+
+ Called when a Pr-downloader download finishes successfully. +
+
+ DownloadFailed +
+
+ Called when a Pr-downloader download fails to complete. +
+
+ DownloadProgress +
+
+ Called incrementally during a Pr-downloader download. +
+
+ +

+ Teams +

+ +

+ +

+

+

+ TeamDied(teamID) +

+

Called when a team dies (see `Spring.KillTeam`).

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ + + + +
+

+ TeamChanged(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ + + + +
+

+ PlayerChanged(playerID) +

+

Called whenever a player's status changes e.g.

+
+

+ becoming a spectator. + +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
+ + + + +
+

+ PlayerAdded(playerID) +

+

Called whenever a new player joins the game.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
+ + + + +
+

+ PlayerRemoved(playerID, reason) +

+

Called whenever a player is removed from the game.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + reason + string + + + +
    3. +
+ + + + +
+

+ Projectiles +

+ +

+ +

+

+

+ ProjectileCreated(proID, proOwnerID, weaponDefID) +

+

Called when the projectile is created.

+
+

+ + + Note that weaponDefID is missing if the projectile is spawned as part of a burst, but `Spring.GetProjectileDefID` and `Spring.GetProjectileName` still work in callin scope using proID. + +

+ + +

Parameters:

+
    +
  1. + proID + number + + + +
    2. +
  2. + proOwnerID + number + + + +
    3. +
  3. + weaponDefID + number + + + +
    4. +
+ + + + +
+

+ ProjectileDestroyed(proID, ownerID, proWeaponDefID) +

+

Called when the projectile is destroyed.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + proID + number + + + +
    2. +
  2. + ownerID + number + + + +
    3. +
  3. + proWeaponDefID + number + + + +
    4. +
+ + + + +
+

+ Explosion(weaponDefID, px, py, pz, attackerID, projectileID) +

+

Called when an explosion occurs.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + weaponDefID + number + + + +
    2. +
  2. + px + number + + + +
    3. +
  3. + py + number + + + +
    4. +
  4. + pz + number + + + +
    5. +
  5. + attackerID + number + + + +
    6. +
  6. + projectileID + number + + + +
    7. +
+ +

Returns:

+
    +
  1. + bool noGfx if then no graphical effects are drawn by the engine for this explosion.
    2. +
+ + + +
+

+ StockpileChanged(unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount) +

+

Called when a units stockpile of weapons increases or decreases.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + weaponNum + number + + + +
    5. +
  5. + oldCount + number + + + +
    6. +
  6. + newCount + number + + + +
    7. +
+ + + + +
+

+ RecvLuaMsg(msg, playerID) +

+

Receives messages from unsynced sent via `Spring.SendLuaRulesMsg` or `Spring.SendLuaUIMsg`.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + msg + string + + + +
    2. +
  2. + playerID + number + + + +
    3. +
+ + + + +
+

+ Save(zip) +

+

Called when a chat command '/save' or '/savegame' is received.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + zip + table + a userdatum representing the savegame zip file. See Lua_SaveLoad. +
    2. +
+ + + + +
+

+ UnsyncedHeightMapUpdate() +

+

Called when the unsynced copy of the height-map is altered.

+
+

+ +

+ + + +

Returns:

+
    +
  1. + x1 + + +
    2. +
  2. + z1 + + +
    3. +
  3. + x2 + + +
    4. +
  4. + z2 + + +
    5. +
+ + + +
+

+ Update(dt) +

+

Called for every draw frame (including when the game is paused) and at least once per sim frame except when catching up.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + dt + number + the time since the last update. +
    2. +
+ + + + +
+

+ ViewResize(viewSizeX, viewSizeY) +

+

Called whenever the window is resized.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + viewSizeX + number + + + +
    2. +
  2. + viewSizeY + number + + + +
    3. +
+ + + + +
+

+ SunChanged() +

+

+
+

+ +

+ + + + + + +
+

+ DefaultCommand(type, id) +

+

Used to set the default command when a unit is selected.

+
+

+ First parameter is the type of the object pointed at (either "unit or "feature") and the second is its unitID or featureID respectively. + +

+ + +

Parameters:

+
    +
  1. + type + string + "unit" | "feature" +
    2. +
  2. + id + int + unitID | featureID +
    3. +
+ + + + +
+

+ Features +

+ +

+ +

+

+

+ FeatureCreated(featureID, allyTeamID) +

+

Called when a feature is created.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + allyTeamID + number + + + +
    3. +
+ + + + +
+

+ FeatureDestroyed(featureID, allyTeamID) +

+

Called when a feature is destroyed.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + allyTeamID + number + + + +
    3. +
+ + + + +
+

+ FeatureDamaged(featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam) +

+

Called when a feature is damaged.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + featureDefID + number + + + +
    3. +
  3. + featureTeam + number + + + +
    4. +
  4. + damage + number + + + +
    5. +
  5. + weaponDefID + number + + + +
    6. +
  6. + projectileID + number + + + +
    7. +
  7. + attackerID + number + + + +
    8. +
  8. + attackerDefID + number + + + +
    9. +
  9. + attackerTeam + number + + + +
    10. +
+ + + + +
+

+ Common +

+ +

+ +

+

+

+ Initialize() +

+

Called when the addon is (re)loaded.

+
+

+ +

+ + + + + + +
+

+ LoadCode() +

+

Called when the game is (re)loaded.

+
+

+ +

+ + + + + + +
+

+ Shutdown() +

+

Called when the addon or the game is shutdown.

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ GotChatMsg(msg, playerID) +

+

Called when a player issues a UI command e.g.

+
+

+ types /foo or /luarules foo. + +

+ + +

Parameters:

+
    +
  1. + msg + string + + + +
    2. +
  2. + playerID + number + + + +
    3. +
+ + + + +
+

+ Load(zipReader) +

+

Called after `GamePreload` and before `GameStart`.

+
+

+ See Lua_SaveLoad. + +

+ + +

Parameters:

+
    +
  1. + zipReader + table + + + +
    2. +
+ + + + +
+

+ Game +

+ +

+ GamePreload() +

+

Called before the 0 gameframe.

+
+

+ + + Is not called when a saved game is loaded. + +

+ + + + + + +
+

+ GameStart() +

+

Called upon the start of the game.

+
+

+ + + Is not called when a saved game is loaded. + +

+ + + + + + +
+

+ GameOver(winningAllyTeams) +

+

Called when the game ends

+
+

+ +

+ + +

Parameters:

+
    +
  1. + winningAllyTeams + {number,...} + list of winning allyTeams, if empty the game result was undecided (like when dropping from an host). +
    2. +
+ + + + +
+

+ GamePaused(playerID, paused) +

+

Called when the game is paused.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + paused + bool + + + +
    3. +
+ + + + +
+

+ GameFrame(frame) +

+

Called for every game simulation frame (30 per second).

+
+

+ +

+ + +

Parameters:

+
    +
  1. + frame + number + Starts at frame 1 +
    2. +
+ + + + +
+

+ GameFramePost(frame) +

+

Called at the end of every game simulation frame

+
+

+ +

+ + +

Parameters:

+
    +
  1. + frame + number + Starts at frame 1 +
    2. +
+ + + + +
+

+ GameID(gameID) +

+

Called once to deliver the gameID

+
+

+ +

+ + +

Parameters:

+
    +
  1. + gameID + string + encoded in hex. +
    2. +
+ + + + +
+

+ Units +

+ +

+ UnitCreated(unitID, unitDefID, unitTeam[, builderID]) +

+

Called at the moment the unit is created.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + builderID + number + + + + (optional) +
    5. +
+ + + + +
+

+ UnitFinished(unitID, unitDefID, unitTeam) +

+

Called at the moment the unit is completed.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitFromFactory(unitID, unitDefID, unitTeam, factID, factDefID, userOrders) +

+

Called when a factory finishes construction of a unit.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + factID + number + + + +
    5. +
  5. + factDefID + number + + + +
    6. +
  6. + userOrders + bool + + + +
    7. +
+ + + + +
+

+ UnitReverseBuilt(unitID, unitDefID, unitTeam) +

+

Called when a living unit becomes a nanoframe again.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitDestroyed(unitID, unitDefID, unitTeam, attackerID, attackerDefID, attackerTeam, weaponDefID) +

+

Called when a unit is destroyed.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + attackerID + number + + + +
    5. +
  5. + attackerDefID + number + + + +
    6. +
  6. + attackerTeam + number + + + +
    7. +
  7. + weaponDefID + number + + + +
    8. +
+ + + + +
+

+ UnitTaken(unitID, unitDefID, oldTeam, newTeam) +

+

Called when a unit is transferred between teams.

+
+

+ This is called before `UnitGiven` and in that moment unit is still assigned to the oldTeam. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + oldTeam + number + + + +
    4. +
  4. + newTeam + number + + + +
    5. +
+ + + + +
+

+ UnitGiven(unitID, unitDefID, newTeam, oldTeam) +

+

Called when a unit is transferred between teams.

+
+

+ This is called after `UnitTaken` and in that moment unit is assigned to the newTeam. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + newTeam + number + + + +
    4. +
  4. + oldTeam + number + + + +
    5. +
+ + + + +
+

+ UnitIdle(unitID, unitDefID, unitTeam) +

+

Called when a unit is idle (empty command queue).

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitCommand(unitID, unitDefID, unitTeam, cmdID, cmdParams, options, cmdTag) +

+

Called after when a unit accepts a command, after `AllowCommand` returns true.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + cmdID + number + + + +
    5. +
  5. + cmdParams + table + + + +
    6. +
  6. + options + cmdOpts + + + +
    7. +
  7. + cmdTag + number + + + +
    8. +
+ + + + +
+

+ UnitCmdDone(unitID, unitDefID, unitTeam, cmdID, cmdParams, options, cmdTag) +

+

Called when a unit completes a command.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + cmdID + number + + + +
    5. +
  5. + cmdParams + table + + + +
    6. +
  6. + options + cmdOpts + + + +
    7. +
  7. + cmdTag + number + + + +
    8. +
+ + + + +
+

+ UnitDamaged(unitID, unitDefID, unitTeam, damage, paralyzer, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam) +

+

Called when a unit is damaged (after UnitPreDamaged).

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + damage + number + + + +
    5. +
  5. + paralyzer + number + + + +
    6. +
  6. + weaponDefID + number + + + +
    7. +
  7. + projectileID + number + + + +
    8. +
  8. + attackerID + number + + + +
    9. +
  9. + attackerDefID + number + + + +
    10. +
  10. + attackerTeam + number + + + +
    11. +
+ + + + +
+

+ UnitStunned(unitID, unitDefID, unitTeam, stunned) +

+

Called when a unit changes its stun status.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + stunned + bool + + + +
    5. +
+ + + + +
+

+ UnitExperience(unitID, unitDefID, unitTeam, experience, oldExperience) +

+

Called when a unit gains experience greater or equal to the minimum limit set by calling `Spring.SetExperienceGrade`.

+
+

+ + + Should be called more reliably with small values of experience grade. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + experience + number + + + +
    5. +
  5. + oldExperience + number + + + +
    6. +
+ + + + +
+

+ UnitHarvestStorageFull(unitID, unitDefID, unitTeam) +

+

Called when a unit's harvestStorage is full (according to its unitDef's entry).

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitSeismicPing(x, y, z, strength, allyTeam, unitID, unitDefID) +

+

Called when a unit emits a seismic ping.

+
+

+ + + See `seismicSignature`. + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
  4. + strength + number + + + +
    5. +
  5. + allyTeam + number + + + +
    6. +
  6. + unitID + number + + + +
    7. +
  7. + unitDefID + number + + + +
    8. +
+ + + + +
+

+ UnitEnteredRadar(unitID, unitTeam, allyTeam, unitDefID) +

+

Called when a unit enters radar of an allyteam.

+
+

+ + + Also called when a unit enters LOS without any radar coverage. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitTeam + number + + + +
    3. +
  3. + allyTeam + number + + + +
    4. +
  4. + unitDefID + number + + + +
    5. +
+ + + + +
+

+ UnitEnteredLos(unitID, unitTeam, allyTeam, unitDefID) +

+

Called when a unit enters LOS of an allyteam.

+
+

+ + + Its called after the unit is in LOS, so you can query that unit. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitTeam + number + + + +
    3. +
  3. + allyTeam + number + who's LOS the unit entered. +
    4. +
  4. + unitDefID + number + + + +
    5. +
+ + + + +
+

+ UnitLeftRadar(unitID, unitTeam, allyTeam, unitDefID) +

+

Called when a unit leaves radar of an allyteam.

+
+

+ + + Also called when a unit leaves LOS without any radar coverage. + For widgets, this is called just after a unit leaves radar coverage, so widgets cannot get the position of units that left their radar. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitTeam + number + + + +
    3. +
  3. + allyTeam + number + + + +
    4. +
  4. + unitDefID + number + + + +
    5. +
+ + + + +
+

+ UnitLeftLos(unitID, unitTeam, allyTeam, unitDefID) +

+

Called when a unit leaves LOS of an allyteam.

+
+

+ + + For widgets, this one is called just before the unit leaves los, so you can still get the position of a unit that left los. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitTeam + number + + + +
    3. +
  3. + allyTeam + number + + + +
    4. +
  4. + unitDefID + number + + + +
    5. +
+ + + + +
+

+ Transport +

+ +

+ +

+

+

+ UnitLoaded(unitID, unitDefID, unitTeam, transportID, transportTeam) +

+

Called when a unit is loaded by a transport.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + transportID + number + + + +
    5. +
  5. + transportTeam + number + + + +
    6. +
+ + + + +
+

+ UnitUnloaded(unitID, unitDefID, unitTeam, transportID, transportTeam) +

+

Called when a unit is unloaded by a transport.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + transportID + number + + + +
    5. +
  5. + transportTeam + number + + + +
    6. +
+ + + + +
+

+ Unit Interactions +

+ +

+ +

+

+

+ UnitEnteredUnderwater(unitID, unitDefID, unitTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitEnteredWater(unitID, unitDefID, unitTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitLeftAir(unitID, unitDefID, unitTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitLeftUnderwater(unitID, unitDefID, unitTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitLeftWater(unitID, unitDefID, unitTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitEnteredAir(unitID, unitDefID, unitTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitCloaked(unitID, unitDefID, unitTeam) +

+

Called when a unit cloaks.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitDecloaked(unitID, unitDefID, unitTeam) +

+

Called when a unit decloaks.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitUnitCollision(colliderID, collideeID) +

+

Called when two units collide.

+
+

+ + + Both units must be registered with `Script.SetWatchUnit`. + +

+ + +

Parameters:

+
    +
  1. + colliderID + number + + + +
    2. +
  2. + collideeID + number + + + +
    3. +
+ + + + +
+

+ UnitFeatureCollision(colliderID, collideeID) +

+

Called when a unit collides with a feature.

+
+

+ + + The unit must be registered with `Script.SetWatchUnit` and the feature registered with `Script.SetWatchFeature`. + +

+ + +

Parameters:

+
    +
  1. + colliderID + number + + + +
    2. +
  2. + collideeID + number + + + +
    3. +
+ + + + +
+

+ UnitMoveFailed(unitID, unitDefID, unitTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ UnitArrivedAtGoal(unitID, unitDefID, unitTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ RenderUnitDestroyed(unitID, unitDefID, unitTeam) +

+

Called just before a unit is invalid, after it finishes its death animation.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
+ + + + +
+

+ Draw* Functions +

+ +

Inside the Draw* functions, you can use the Lua OpenGL Api to draw graphics.

+ +

Avoid doing heavy calculations inside these callins; ideally, do the calculations elsewhere and use Draw callins only for drawing.

+

+ DrawGenesis() +

+

Use this callin to update textures, shaders, etc.

+
+

+ + + Doesn't render to screen! + Also available to LuaMenu. +

+ + + + + + +
+

+ DrawWorld() +

+

Spring draws command queues, 'map stuff', and map marks.

+
+

+ +

+ + + + + + +
+

+ DrawWorldPreUnit() +

+

Spring draws units, features, some water types, cloaked units, and the sun.

+
+

+ +

+ + + + + + +
+

+ DrawPreDecals() +

+

Called before decals are drawn

+
+

+ +

+ + + + + + +
+

+ DrawWaterPost() +

+

+
+

+ +

+ + + + + + +
+

+ DrawShadowPassTransparent() +

+

Invoked after semi-transparent shadows pass is about to conclude

+
+

+ + + This callin has depth and color buffer of shadowmap bound via FBO as well as the FFP state to do "semi-transparent" shadows pass (traditionally only used to draw shadows of shadow casting semi-transparent particles). Can be used to draw nice colored shadows. +

+ + + + + + +
+

+ DrawWorldShadow() +

+

+
+

+ +

+ + + + + + +
+

+ DrawWorldReflection() +

+

+
+

+ +

+ + + + + + +
+

+ DrawWorldRefraction() +

+

+
+

+ +

+ + + + + + +
+

+ DrawGroundPreForward() +

+

Runs at the start of the forward pass when a custom map shader has been assigned via `Spring.SetMapShader` (convenient for setting uniforms).

+
+

+ +

+ + + + + + +
+

+ DrawGroundPostForward() +

+

+
+

+ +

+ + + + + + +
+

+ DrawGroundPreDeferred() +

+

Runs at the start of the deferred pass when a custom map shader has been assigned via `Spring.SetMapShader` (convenient for setting uniforms).

+
+

+ +

+ + + + + + +
+

+ DrawGroundDeferred() +

+

+
+

+ +

+ + + + + + +
+

+ DrawGroundPostDeferred() +

+

This runs at the end of its respective deferred pass.

+
+

+ + + Allows proper frame compositing (with ground flashes/decals/foliage/etc, which are drawn between it and `DrawWorldPreUnit`) via `gl.CopyToTexture`. +

+ + + + + + +
+

+ DrawUnitsPostDeferred() +

+

Runs at the end of the unit deferred pass.

+
+

+ + + Informs Lua code it should make use of the $model_gbuffer_* textures before another pass overwrites them (and to allow proper blending with e.g. cloaked objects which are drawn between these events and DrawWorld via gl.CopyToTexture). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled. +

+ + + + + + +
+

+ DrawFeaturesPostDeferred() +

+

Runs at the end of the feature deferred pass to inform Lua code it should make use of the $model_gbuffer_* textures before another pass overwrites them (and to allow proper blending with e.g.

+
+

+ cloaked objects which are drawn between these events and DrawWorld via gl.CopyToTexture). N.B. The *PostDeferred events are only sent (and only have a real purpose) if forward drawing is disabled. + +

+ + + + + + +
+

+ DrawShadowUnitsLua() +

+

+
+

+ +

+ + + + + + +
+

+ DrawShadowFeaturesLua() +

+

+
+

+ +

+ + + + + + +
+

+ DrawWorldPreParticles(drawAboveWater, drawBelowWater, drawReflection, drawRefraction) +

+

DrawWorldPreParticles is called multiples times per draw frame.

+
+

+ + Each call has a different permutation of values for drawAboveWater, drawBelowWater, drawReflection, and drawRefraction. + +

+ + +

Parameters:

+
    +
  1. + drawAboveWater + bool + + + +
    2. +
  2. + drawBelowWater + bool + + + +
    3. +
  3. + drawReflection + bool + + + +
    4. +
  4. + drawRefraction + bool + + + +
    5. +
+ + + + +
+

+ DrawScreen(viewSizeX, viewSizeY) +

+

Also available to LuaMenu.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + viewSizeX + number + + + +
    2. +
  2. + viewSizeY + number + + + +
    3. +
+ + + + +
+

+ DrawScreenEffects(viewSizeX, viewSizeY) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + viewSizeX + number + + + +
    2. +
  2. + viewSizeY + number + + + +
    3. +
+ + + + +
+

+ DrawScreenPost(viewSizeX, viewSizeY) +

+

Similar to DrawScreenEffects, this can be used to alter the contents of a frame after it has been completely rendered (i.e.

+
+

+ World, MiniMap, Menu, UI). + +

+ + +

Parameters:

+
    +
  1. + viewSizeX + number + + + +
    2. +
  2. + viewSizeY + number + + + +
    3. +
+ + + + +
+

+ DrawInMinimap(sx, sy) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + sx + number + relative to the minimap's position and scale. +
    2. +
  2. + sy + number + relative to the minimap's position and scale. +
    3. +
+ + + + +
+

+ DrawInMinimapBackground(sx, sy) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + sx + number + relative to the minimap's position and scale. +
    2. +
  2. + sy + number + relative to the minimap's position and scale. +
    3. +
+ + + + +
+

+ GameProgress(serverFrameNum) +

+

Called every 60 frames, calculating delta between `GameFrame` and `GameProgress`.

+
+

+ + + Can give an ETA about catching up with simulation for mid-game join players. + +

+ + +

Parameters:

+
    +
  1. + serverFrameNum + int + + + +
    2. +
+ + + + +
+

+ KeyMapChanged() +

+

Called when the keymap changes

+
+

+ + + Can be caused due to a change in language or keyboard +

+ + + + + + +
+

+ Input +

+ +

+ mods +

+

Key Modifier Params

+
+

+ +

+ + +

Fields:

+
    +
  1. + right + bool + Right mouse key pressed +
    2. +
  2. + alt + bool + Alt key pressed +
    3. +
  3. + ctrl + bool + Ctrl key pressed +
    4. +
  4. + shift + bool + Shift key pressed +
    5. +
+ + + + +
+

+ KeyPress(keyCode, mods, isRepeat, label, utf32char, scanCode, actionList) +

+

Called repeatedly when a key is pressed down.

+
+

+ + + Return true if you don't want other callins or the engine to also receive this keypress. A list of key codes can be seen at the SDL wiki. + +

+ + +

Parameters:

+
    +
  1. + keyCode + number + + + +
    2. +
  2. + mods + mods + + + +
    3. +
  3. + isRepeat + bool + If you want an action to occur only once check for isRepeat == false. +
    4. +
  4. + label + bool + the name of the key +
    5. +
  5. + utf32char + number + (deprecated) always 0 +
    6. +
  6. + scanCode + number + + + +
    7. +
  7. + actionList + table + the list of actions for this keypress +
    8. +
+ +

Returns:

+
    +
  1. + boolean + halt whether to halt the chain for consumers of the keypress
    2. +
+ + + +
+

+ KeyRelease(keyCode, mods, label, utf32char, scanCode, actionList) +

+

Called when the key is released.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + keyCode + number + + + +
    2. +
  2. + mods + mods + + + +
    3. +
  3. + label + bool + the name of the key +
    4. +
  4. + utf32char + number + (deprecated) always 0 +
    5. +
  5. + scanCode + number + + + +
    6. +
  6. + actionList + table + the list of actions for this keyrelease +
    7. +
+ +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ TextInput(utf8char) +

+

Called whenever a key press results in text input.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + utf8char + string + + + +
    2. +
+ + + + +
+

+ TextEditing(utf8, start, length) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + utf8 + string + + + +
    2. +
  2. + start + number + + + +
    3. +
  3. + length + number + + + +
    4. +
+ + + + +
+

+ MousePress(x, y, button) +

+

Called when a mouse button is pressed.

+
+

+ + + The button parameter supports up to 7 buttons. Must return true for `MouseRelease` and other functions to be called. + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + button + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + boolean + becomeMouseOwner
    2. +
+ + + +
+

+ MouseRelease(x, y, button) +

+

Called when a mouse button is released.

+
+

+ + + Please note that in order to have Spring call `Spring.MouseRelease`, you need to have a `Spring.MousePress` call-in in the same addon that returns true. + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + button + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + boolean + becomeMouseOwner
    2. +
+ + + +
+

+ MouseMove(x, y, dx, dy, button) +

+

Called when the mouse is moved.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + final x position +
    2. +
  2. + y + number + final y position +
    3. +
  3. + dx + number + distance travelled in x +
    4. +
  4. + dy + number + distance travelled in y +
    5. +
  5. + button + number + + + +
    6. +
+ + + + +
+

+ MouseWheel(up, value) +

+

Called when the mouse wheel is moved.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + up + bool + the direction +
    2. +
  2. + value + number + the amount travelled +
    3. +
+ + + + +
+

+ IsAbove(x, y) +

+

Called every `Update`.

+
+

+ + + Must return true for `Mouse*` events and `Spring.GetToolTip` to be called. + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + boolean isAbove
    2. +
+ + + +
+

+ GetTooltip(x, y) +

+

Called when `Spring.IsAbove` returns true.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + string tooltip
    2. +
+ + + +
+

+ cmdOpts +

+

Parameters for command options

+
+

+ +

+ + +

Fields:

+
    +
  1. + coded + int + + + +
    2. +
  2. + alt + bool + + + +
    3. +
  3. + ctrl + bool + + + +
    4. +
  4. + shift + bool + + + +
    5. +
  5. + right + bool + + + +
    6. +
  6. + meta + bool + + + +
    7. +
  7. + internal + bool + + + +
    8. +
+ + + + +
+

+ CommandNotify(cmdID, cmdParams, options) +

+

Called when a command is issued.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cmdID + int + + + +
    2. +
  2. + cmdParams + table + + + +
    3. +
  3. + options + cmdOpts + + + +
    4. +
+ +

Returns:

+
    +
  1. + boolean + Returning true deletes the command and does not send it through the network.
    2. +
+ + + +
+

+ AddConsoleLine(msg, priority) +

+

Called when text is entered into the console (e.g.

+
+

+ `Spring.Echo`). + +

+ + +

Parameters:

+
    +
  1. + msg + string + + + +
    2. +
  2. + priority + int + + + +
    3. +
+ + + + +
+

+ GroupChanged(groupID) +

+

Called when a unit is added to or removed from a control group.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + groupID + number + + + +
    2. +
+ + + + +
+

+ WorldTooltip(ttType, data1[, data2[, data3]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + ttType + string + "unit" | "feature" | "ground" | "selection" +
    2. +
  2. + data1 + number + unitID | featureID | posX +
    3. +
  3. + data2 + number + posY + (optional) +
    4. +
  4. + data3 + number + posZ + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + string + newTooltip
    2. +
+ + + +
+

+ MapDrawCmd(playerID, type, posX, posY, posZ, data4[, pos2Y[, pos2Z]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + type + string + "point" | "line" | "erase" +
    3. +
  3. + posX + number + + + +
    4. +
  4. + posY + number + + + +
    5. +
  5. + posZ + number + + + +
    6. +
  6. + data4 + string or number + point: label, erase: radius, line: pos2X +
    7. +
  7. + pos2Y + number + when type is line + (optional) +
    8. +
  8. + pos2Z + number + when type is line + (optional) +
    9. +
+ + + + +
+

+ GameSetup(state, ready, playerStates) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + state + string + + + +
    2. +
  2. + ready + bool + + + +
    3. +
  3. + playerStates + table + + + +
    4. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
  2. + bool + newReady
    3. +
+ + + +
+

+ RecvSkirmishAIMessage(aiTeam, dataStr) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + aiTeam + int + + + +
    2. +
  2. + dataStr + string + + + +
    3. +
+ + + + +
+

+ Downloads +

+ +

+ DownloadQueued(id, name, type) +

+

Called when a Pr-downloader download is queued

+
+

+ +

+ + +

Parameters:

+
    +
  1. + id + number + + + +
    2. +
  2. + name + string + + + +
    3. +
  3. + type + string + + + +
    4. +
+ + + + +
+

+ DownloadStarted(id) +

+

Called when a Pr-downloader download is started via VFS.DownloadArchive.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + id + number + + + +
    2. +
+ + + + +
+

+ DownloadFinished(id) +

+

Called when a Pr-downloader download finishes successfully.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + id + number + + + +
    2. +
+ + + + +
+

+ DownloadFailed(id, errorID) +

+

Called when a Pr-downloader download fails to complete.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + id + number + + + +
    2. +
  2. + errorID + number + + + +
    3. +
+ + + + +
+

+ DownloadProgress(id, downloaded, total) +

+

Called incrementally during a Pr-downloader download.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + id + number + + + +
    2. +
  2. + downloaded + number + + + +
    3. +
  3. + total + number + + + +
    4. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/LuaHandleSynced.html b/ldoc/modules/LuaHandleSynced.html new file mode 100644 index 0000000000..ba05a464a6 --- /dev/null +++ b/ldoc/modules/LuaHandleSynced.html @@ -0,0 +1,2274 @@ +--- +layout: default +title: LuaHandleSynced +permalink: ldoc/modules/LuaHandleSynced.html +description: Callins, functions called by the Engine (Synced) +parent: Lua API +table: 0x55953a727ce0 +--- + +{% raw %} +

Module LuaHandleSynced

+

Callins, functions called by the Engine (Synced)

+

+ +

+

See also:

+ + +

Misc

+
+
+ RecvFromSynced +
+
+ Receives data sent via SendToUnsynced callout. +
+
+

Custom Object Rendering

+
+
+ DrawUnit +
+
+ For custom rendering of units +
+
+ DrawFeature +
+
+ For custom rendering of features +
+
+ DrawShield +
+
+ For custom rendering of shields. +
+
+ DrawProjectile +
+
+ For custom rendering of weapon (& other) projectiles +
+
+ DrawMaterial +
+
+ + + +
+
+ CommandFallback +
+
+ Called when the unit reaches an unknown command in its queue (i.e. +
+
+ AllowCommand +
+
+ Called when the command is given, before the unit's queue is altered. +
+
+ AllowUnitCreation +
+
+ Called just before unit is created. +
+
+ AllowUnitTransfer +
+
+ Called just before a unit is transferred to a different team. +
+
+ AllowUnitBuildStep +
+
+ Called just before a unit progresses its build percentage. +
+
+ AllowUnitCaptureStep +
+
+ + + +
+
+ AllowUnitTransport +
+
+ + + +
+
+ AllowUnitTransportLoad +
+
+ + + +
+
+ AllowUnitTransportUnload +
+
+ + + +
+
+ AllowUnitCloak +
+
+ + + +
+
+ AllowUnitCloak +
+
+ + + +
+
+ AllowUnitKamikaze +
+
+ + + +
+
+ AllowFeatureCreation +
+
+ Called just before feature is created. +
+
+ AllowFeatureBuildStep +
+
+ Called just before a feature changes its build percentage. +
+
+ AllowResourceLevel +
+
+ Called when a team sets the sharing level of a resource. +
+
+ AllowResourceTransfer +
+
+ Called just before resources are transferred between players. +
+
+ AllowDirectUnitControl +
+
+ Determines if this unit can be controlled directly in FPS view. +
+
+ AllowBuilderHoldFire +
+
+ Called when a construction unit wants to "use his nano beams". +
+
+ AllowStartPosition +
+
+ Whether a start position should be allowed +
+
+ MoveCtrlNotify +
+
+ Enable both Spring.MoveCtrl.SetCollideStop and Spring.MoveCtrl.SetTrackGround to enable this call-in. +
+
+ TerraformComplete +
+
+ Called when pre-building terrain levelling terraforms are completed (c.f. +
+
+ UnitPreDamaged +
+
+ Called before damage is applied to the unit, allows fine control over how much damage and impulse is applied. +
+
+ FeaturePreDamaged +
+
+ Called before damage is applied to the feature. +
+
+ ShieldPreDamaged +
+
+ Called before any engine shield-vs-projectile logic executes. +
+
+ AllowWeaponTargetCheck +
+
+ Determines if this weapon can automatically generate targets itself. +
+
+ AllowWeaponTarget +
+
+ Controls blocking of a specific target from being considered during a weapon's periodic auto-targeting sweep. +
+
+ AllowWeaponInterceptTarget +
+
+ Controls blocking of a specific intercept target from being considered during an interceptor weapon's periodic auto-targeting sweep. +
+
+ +

+ Misc +

+ +

+ +

+

+

+ RecvFromSynced(arg1, arg2, argn) +

+

Receives data sent via `SendToUnsynced` callout.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + arg1 + any + + + +
    2. +
  2. + arg2 + any + + + +
    3. +
  3. + argn + any + + + +
    4. +
+ + + + +
+

+ Custom Object Rendering +

+ +

For the following calls drawMode can be one of the following, notDrawing = 0, normalDraw = 1, shadowDraw = 2, reflectionDraw = 3, refractionDraw = 4, and finally gameDeferredDraw = 5 which was added in 102.0.

+

+ DrawUnit(unitID, drawMode) +

+

For custom rendering of units

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + drawMode + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + suppressEngineDraw
    2. +
+ + + +
+

+ DrawFeature(featureID, drawMode) +

+

For custom rendering of features

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + drawMode + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + suppressEngineDraw
    2. +
+ + + +
+

+ DrawShield(featureID, weaponID, drawMode) +

+

For custom rendering of shields.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + weaponID + number + + + +
    3. +
  3. + drawMode + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + bool + suppressEngineDraw
    2. +
+ + + +
+

+ DrawProjectile(projectileID, drawMode) +

+

For custom rendering of weapon (& other) projectiles

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + drawMode + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + suppressEngineDraw
    2. +
+ + + +
+

+ DrawMaterial(uuid, drawMode) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + uuid + number + + + +
    2. +
  2. + drawMode + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + suppressEngineDraw
    2. +
+ + + +
+

+ CommandFallback(unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag) +

+

Called when the unit reaches an unknown command in its queue (i.e.

+
+

+ one not handled by the engine). + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + cmdID + number + + + +
    5. +
  5. + cmdParams + {number,...} + + + +
    6. +
  6. + cmdOptions + cmdOptions + + + +
    7. +
  7. + cmdTag + number + + + +
    8. +
+ +

Returns:

+
    +
  1. + boolean + whether to remove the command from the queue
    2. +
+ + + +
+

+ AllowCommand(unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced, fromLua) +

+

Called when the command is given, before the unit's queue is altered.

+
+

+ + + The queue remains untouched when a command is blocked, whether it would be queued or replace the queue. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + cmdID + number + + + +
    5. +
  5. + cmdParams + {number,...} + + + +
    6. +
  6. + cmdOptions + cmdOptions + + + +
    7. +
  7. + cmdTag + number + + + +
    8. +
  8. + synced + bool + + + +
    9. +
  9. + fromLua + bool + + + +
    10. +
+ +

Returns:

+
    +
  1. + bool + whether it should be let into the queue.
    2. +
+ + + +
+

+ AllowUnitCreation(unitDefID, builderID, builderTeam, x, y, z, facing) +

+

Called just before unit is created.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
  2. + builderID + number + + + +
    3. +
  3. + builderTeam + number + + + +
    4. +
  4. + x + number + + + +
    5. +
  5. + y + number + + + +
    6. +
  6. + z + number + + + +
    7. +
  7. + facing + number + + + +
    8. +
+ +

Returns:

+
    +
  1. + bool + allow, bool dropOrder
    2. +
+ + + +
+

+ AllowUnitTransfer(unitID, unitDefID, oldTeam, newTeam, capture) +

+

Called just before a unit is transferred to a different team.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + oldTeam + number + + + +
    4. +
  4. + newTeam + number + + + +
    5. +
  5. + capture + bool + + + +
    6. +
+ +

Returns:

+
    +
  1. + bool + whether or not the transfer is permitted.
    2. +
+ + + +
+

+ AllowUnitBuildStep(builderID, builderTeam, unitID, unitDefID, part) +

+

Called just before a unit progresses its build percentage.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + builderID + number + + + +
    2. +
  2. + builderTeam + number + + + +
    3. +
  3. + unitID + number + + + +
    4. +
  4. + unitDefID + number + + + +
    5. +
  5. + part + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + bool + whether or not the build makes progress.
    2. +
+ + + +
+

+ AllowUnitCaptureStep(builderID, builderTeam, unitID, unitDefID, part) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + builderID + number + + + +
    2. +
  2. + builderTeam + number + + + +
    3. +
  3. + unitID + number + + + +
    4. +
  4. + unitDefID + number + + + +
    5. +
  5. + part + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + bool + whether or not the capture makes progress.
    2. +
+ + + +
+

+ AllowUnitTransport(transporterID, transporterUnitDefID, transporterTeam, transporteeID, transporteeUnitDefID, transporteeTeam) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + transporterID + number + + + +
    2. +
  2. + transporterUnitDefID + number + + + +
    3. +
  3. + transporterTeam + number + + + +
    4. +
  4. + transporteeID + number + + + +
    5. +
  5. + transporteeUnitDefID + number + + + +
    6. +
  6. + transporteeTeam + number + + + +
    7. +
+ +

Returns:

+
    +
  1. + bool + whether or not the transport is allowed
    2. +
+ + + +
+

+ AllowUnitTransportLoad(transporterID, transporterUnitDefID, transporterTeam, transporteeID, transporteeUnitDefID, transporteeTeam, x, y, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + transporterID + number + + + +
    2. +
  2. + transporterUnitDefID + number + + + +
    3. +
  3. + transporterTeam + number + + + +
    4. +
  4. + transporteeID + number + + + +
    5. +
  5. + transporteeUnitDefID + number + + + +
    6. +
  6. + transporteeTeam + number + + + +
    7. +
  7. + x + number + + + +
    8. +
  8. + y + number + + + +
    9. +
  9. + z + number + + + +
    10. +
+ +

Returns:

+
    +
  1. + bool + whether or not the transport load is allowed
    2. +
+ + + +
+

+ AllowUnitTransportUnload(transporterID, transporterUnitDefID, transporterTeam, transporteeID, transporteeUnitDefID, transporteeTeam, x, y, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + transporterID + number + + + +
    2. +
  2. + transporterUnitDefID + number + + + +
    3. +
  3. + transporterTeam + number + + + +
    4. +
  4. + transporteeID + number + + + +
    5. +
  5. + transporteeUnitDefID + number + + + +
    6. +
  6. + transporteeTeam + number + + + +
    7. +
  7. + x + number + + + +
    8. +
  8. + y + number + + + +
    9. +
  9. + z + number + + + +
    10. +
+ +

Returns:

+
    +
  1. + bool + whether or not the transport unload is allowed
    2. +
+ + + +
+

+ AllowUnitCloak(unitID[, enemyID]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + enemyID + number + + + + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + bool + whether unit is allowed to cloak
    2. +
+ + + +
+

+ AllowUnitCloak(unitID[, objectID[, weaponNum]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + objectID + number + + + + (optional) +
    3. +
  3. + weaponNum + number + + + + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + bool + whether unit is allowed to decloak
    2. +
+ + + +
+

+ AllowUnitKamikaze(unitID, targetID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + targetID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + whether unit is allowed to selfd
    2. +
+ + + +
+

+ AllowFeatureCreation(featureDefID, teamID, x, y, z) +

+

Called just before feature is created.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureDefID + number + + + +
    2. +
  2. + teamID + number + + + +
    3. +
  3. + x + number + + + +
    4. +
  4. + y + number + + + +
    5. +
  5. + z + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + bool + whether or not the creation is permitted
    2. +
+ + + +
+

+ AllowFeatureBuildStep(builderID, builderTeam, featureID, featureDefID, part) +

+

Called just before a feature changes its build percentage.

+
+

+ + + Note that this is also called for resurrecting features, and for refilling features with resources before resurrection. + On reclaim the part values are negative, and on refill and ressurect they are positive. + Part is the percentage the feature be built or reclaimed per frame. + Eg. for a 30 workertime builder, that's a build power of 1 per frame. + For a 50 buildtime feature reclaimed by this builder, part will be 100/-50(/1) = -2%, or -0.02 numerically. + +

+ + +

Parameters:

+
    +
  1. + builderID + number + + + +
    2. +
  2. + builderTeam + number + + + +
    3. +
  3. + featureID + number + + + +
    4. +
  4. + featureDefID + number + + + +
    5. +
  5. + part + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + bool + whether or not the change is permitted
    2. +
+ + + +
+

+ AllowResourceLevel(teamID, res, level) +

+

Called when a team sets the sharing level of a resource.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + res + string + + + +
    3. +
  3. + level + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + bool + whether or not the sharing level is permitted
    2. +
+ + + +
+

+ AllowResourceTransfer(oldTeamID, newTeamID, res, amount) +

+

Called just before resources are transferred between players.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + oldTeamID + number + + + +
    2. +
  2. + newTeamID + number + + + +
    3. +
  3. + res + string + + + +
    4. +
  4. + amount + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + bool + whether or not the transfer is permitted.
    2. +
+ + + +
+

+ AllowDirectUnitControl(unitID, unitDefID, unitTeam, playerID) +

+

Determines if this unit can be controlled directly in FPS view.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + playerID + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + bool + allow
    2. +
+ + + +
+

+ AllowBuilderHoldFire(unitID, unitDefID, action) +

+

Called when a construction unit wants to "use his nano beams".

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + action + number + one of following:

    + +

    -1 Build + CMD.REPAIR Repair + CMD.RECLAIM Reclaim + CMD.RESTORE Restore + CMD.RESURRECT Resurrect + CMD.CAPTURE Capture +

    4. +
+ +

Returns:

+
    +
  1. + bool + actionAllowed
    2. +
+ + + +
+

+ AllowStartPosition(playerID, teamID, readyState, clampedX, clampedY, clampedZ, rawX, rawY, rawZ) +

+

Whether a start position should be allowed

+
+

+ + + clamped{X,Y,Z} are the coordinates clamped into start-boxes, raw is where player tried to place their marker. + + The readyState can be any one of: + + 0 - player picked a position, + 1 - player clicked ready, + 2 - player pressed ready OR the game was force-started (player did not click ready, but is now forcibly readied) or + 3 - the player failed to load. + The default 'failed to choose' start-position is the north-west point of their startbox, or (0,0,0) if they do not have a startbox. + +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + teamID + number + + + +
    3. +
  3. + readyState + number + + + +
    4. +
  4. + clampedX + number + + + +
    5. +
  5. + clampedY + number + + + +
    6. +
  6. + clampedZ + number + + + +
    7. +
  7. + rawX + number + + + +
    8. +
  8. + rawY + number + + + +
    9. +
  9. + rawZ + number + + + +
    10. +
+ +

Returns:

+
    +
  1. + bool + allow
    2. +
+ + + +
+

+ MoveCtrlNotify(unitID, unitDefID, unitTeam, data) +

+

Enable both Spring.MoveCtrl.SetCollideStop and Spring.MoveCtrl.SetTrackGround to enable this call-in.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + data + number + was supposed to indicate the type of notification but currently never has a value other than 1 ("unit hit the ground"). +
    5. +
+ +

Returns:

+
    +
  1. + bool + whether or not the unit should remain script-controlled (false) or return to engine controlled movement (true).
    2. +
+ + + +
+

+ TerraformComplete(unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam) +

+

Called when pre-building terrain levelling terraforms are completed (c.f.

+
+

+ levelGround) + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + buildUnitID + number + + + +
    5. +
  5. + buildUnitDefID + number + + + +
    6. +
  6. + buildUnitTeam + number + + + +
    7. +
+ +

Returns:

+
    +
  1. + bool + if true the current build order is terminated
    2. +
+ + + +
+

+ UnitPreDamaged(unitID, unitDefID, unitTeam, damage, paralyzer[, weaponDefID[, projectileID[, attackerID[, attackerDefID[, attackerTeam]]]]]) +

+

Called before damage is applied to the unit, allows fine control over how much damage and impulse is applied.

+
+

+ + + Called after every damage modification (even `HitByWeaponId`) but before the damage is applied + + expects two numbers returned by lua code: + 1st is stored under *newDamage if newDamage != NULL + 2nd is stored under *impulseMult if impulseMult != NULL + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + unitTeam + number + + + +
    4. +
  4. + damage + number + + + +
    5. +
  5. + paralyzer + bool + + + +
    6. +
  6. + weaponDefID + number + Synced Only + (optional) +
    7. +
  7. + projectileID + number + Synced Only + (optional) +
    8. +
  8. + attackerID + number + Synced Only + (optional) +
    9. +
  9. + attackerDefID + number + Synced Only + (optional) +
    10. +
  10. + attackerTeam + number + Synced Only + (optional) +
    11. +
+ +

Returns:

+
    +
  1. + number newDamage, number impulseMult
    2. +
+ + + +
+

+ FeaturePreDamaged(featureID, featureDefID, featureTeam, damage, weaponDefID, projectileID, attackerID, attackerDefID, attackerTeam) +

+

Called before damage is applied to the feature.

+
+

+ + + Allows fine control over how much damage and impulse is applied. + +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + featureDefID + number + + + +
    3. +
  3. + featureTeam + number + + + +
    4. +
  4. + damage + number + + + +
    5. +
  5. + weaponDefID + number + + + +
    6. +
  6. + projectileID + number + + + +
    7. +
  7. + attackerID + number + + + +
    8. +
  8. + attackerDefID + number + + + +
    9. +
  9. + attackerTeam + number + + + +
    10. +
+ +

Returns:

+
    +
  1. + number + newDamage
    2. +
  2. + number + impulseMult
    3. +
+ + + +
+

+ ShieldPreDamaged(projectileID, projectileOwnerID, shieldWeaponNum, shieldCarrierID, bounceProjectile, beamEmitterWeaponNum, beamEmitterUnitID, startX, startY, startZ, hitX, hitY, hitZ) +

+

Called before any engine shield-vs-projectile logic executes.

+
+

+ + + If the weapon is a hitscan type (BeamLaser or LightningCanon) then proID is nil and beamEmitterWeaponNum and beamEmitterUnitID are populated instead. + +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + projectileOwnerID + number + + + +
    3. +
  3. + shieldWeaponNum + number + + + +
    4. +
  4. + shieldCarrierID + number + + + +
    5. +
  5. + bounceProjectile + bool + + + +
    6. +
  6. + beamEmitterWeaponNum + number + + + +
    7. +
  7. + beamEmitterUnitID + number + + + +
    8. +
  8. + startX + number + + + +
    9. +
  9. + startY + number + + + +
    10. +
  10. + startZ + number + + + +
    11. +
  11. + hitX + number + + + +
    12. +
  12. + hitY + number + + + +
    13. +
  13. + hitZ + number + + + +
    14. +
+ +

Returns:

+
    +
  1. + bool + if true the gadget handles the collision event and the engine does not remove the projectile
    2. +
+ + + +
+

+ AllowWeaponTargetCheck(attackerID, attackerWeaponNum, attackerWeaponDefID) +

+

Determines if this weapon can automatically generate targets itself.

+
+

+ See also commandFire weaponDef tag. + +

+ + +

Parameters:

+
    +
  1. + attackerID + number + + + +
    2. +
  2. + attackerWeaponNum + number + + + +
    3. +
  3. + attackerWeaponDefID + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + bool + allowCheck
    2. +
  2. + bool + ignoreCheck
    3. +
+ + + +
+

+ AllowWeaponTarget(attackerID, targetID, attackerWeaponNum, attackerWeaponDefID, defPriority) +

+

Controls blocking of a specific target from being considered during a weapon's periodic auto-targeting sweep.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + attackerID + number + + + +
    2. +
  2. + targetID + number + + + +
    3. +
  3. + attackerWeaponNum + number + + + +
    4. +
  4. + attackerWeaponDefID + number + + + +
    5. +
  5. + defPriority + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + bool + allowed
    2. +
  2. + number + the new priority for this target (if you don't want to change it, return defPriority). Lower priority targets are targeted first.
    3. +
+ + + +
+

+ AllowWeaponInterceptTarget(interceptorUnitID, interceptorWeaponID, targetProjectileID) +

+

Controls blocking of a specific intercept target from being considered during an interceptor weapon's periodic auto-targeting sweep.

+
+

+ + + Only called for weaponDefIDs registered via Script.SetWatchWeapon. + +

+ + +

Parameters:

+
    +
  1. + interceptorUnitID + number + + + +
    2. +
  2. + interceptorWeaponID + number + + + +
    3. +
  3. + targetProjectileID + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + bool + allowed
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/LuaRules.html b/ldoc/modules/LuaRules.html new file mode 100644 index 0000000000..beeb13b79a --- /dev/null +++ b/ldoc/modules/LuaRules.html @@ -0,0 +1,24 @@ +--- +layout: default +title: LuaRules +permalink: ldoc/modules/LuaRules.html +description: Lua Rules +parent: Lua API +table: 0x55953a556890 +--- + +{% raw %} +

Module LuaRules

+

Lua Rules

+

+ +

+

+

See also:

+ + + + +{% endraw %} diff --git a/ldoc/modules/LuaVAO.html b/ldoc/modules/LuaVAO.html new file mode 100644 index 0000000000..b13eb8286d --- /dev/null +++ b/ldoc/modules/LuaVAO.html @@ -0,0 +1,69 @@ +--- +layout: default +title: LuaVAO +permalink: ldoc/modules/LuaVAO.html +description: + + +parent: Lua API +table: 0x55953a419140 +--- + +{% raw %} +

Module LuaVAO

+

+ +

+

+ +

+

+

See also:

+ + +

Functions

+
+
+ gl.GetVAO +
+
+ + + +
+
+ +

+ Functions +

+ +

+ gl.GetVAO() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or VAO + the VAO ref on success, else nil
    2. +
+ + + +

Usage:

+
    + 
  • local myVAO = gl.GetVAO()
+if myVAO == nil then Spring.Echo("Failed to get VAO") end
    • +
+
+ +{% endraw %} diff --git a/ldoc/modules/LuaVBO.html b/ldoc/modules/LuaVBO.html new file mode 100644 index 0000000000..003ac3c076 --- /dev/null +++ b/ldoc/modules/LuaVBO.html @@ -0,0 +1,93 @@ +--- +layout: default +title: LuaVBO +permalink: ldoc/modules/LuaVBO.html +description: + + +parent: Lua API +table: 0x55953a558aa0 +--- + +{% raw %} +

Module LuaVBO

+

+ +

+

+ +

+

+

See also:

+ + +

Functions

+
+
+ gl.GetVBO +
+
+ + + +
+
+ +

+ Functions +

+ +

+ gl.GetVBO([bufferType=GL.ARRAY_BUFFER[, freqUpdated=true]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + bufferType + number + one of [GL.ARRAY_BUFFER, + GL.ELEMENT_ARRAY_BUFFER, GL.UNIFORM_BUFFER, GL.SHADER_STORAGE_BUFFER].

    + +

    Defaults to GL.ARRAY_BUFFER, which you should use for vertex data, and + GL.ELEMENT_ARRAY_BUFFER should be used for vertex indices. + (default GL.ARRAY_BUFFER) +

    2. +
  2. + freqUpdated + bool + whether should be updated frequently, when false + will be updated only once + (default true) +
    3. +
+ +

Returns:

+
    +
  1. + nil or VBO + the VBO ref on success, nil if not supported/or other error
    2. +
+ + +

See also:

+ + +

Usage:

+
    + 
  • local myVBO = gl.GetVBO()
+if myVBO == nil then Spring.Echo("Failed to get VBO") end
    • +
+
+ +{% endraw %} diff --git a/ldoc/modules/LuaZip.html b/ldoc/modules/LuaZip.html new file mode 100644 index 0000000000..eb9aeacb9d --- /dev/null +++ b/ldoc/modules/LuaZip.html @@ -0,0 +1,24 @@ +--- +layout: default +title: LuaZip +permalink: ldoc/modules/LuaZip.html +description: LuaZip +parent: Lua API +table: 0x55953a76c4e0 +--- + +{% raw %} +

Module LuaZip

+

LuaZip

+

+ +

+

+

See also:

+ + + + +{% endraw %} diff --git a/ldoc/modules/MathExtra.html b/ldoc/modules/MathExtra.html new file mode 100644 index 0000000000..4b298923f3 --- /dev/null +++ b/ldoc/modules/MathExtra.html @@ -0,0 +1,439 @@ +--- +layout: default +title: MathExtra +permalink: ldoc/modules/MathExtra.html +description: math extensions +parent: Lua API +table: 0x55953a263740 +--- + +{% raw %} +

Module MathExtra

+

math extensions

+

+ +

+

+

See also:

+ + +

Functions

+
+
+ math.hypot +
+
+ Returns the length of hypotenuse of right angle triangle with sides x and y, equivalent to sqrt(xx + yy), but has better numerical stability and internally handles intermediate overflows/underflows, but is also slower. +
+
+ math.diag +
+
+ Returns the length of the diagonal of an n-dimensional box (or the length of an n-component vector). +
+
+ math.clamp +
+
+ Returns x clamped to min and max boundaries. +
+
+ math.sgn +
+
+ Returns 0 if x == 0, 1 if x > 0, -1 if x < 0 +
+
+ math.mix +
+
+ Returns linear interpolation between x and y with ratio a (x+(y-x)*a). +
+
+ math.round +
+
+ Returns x rounded to n decimals, if n is omitted or <=0, rounds to nearest integer. +
+
+ math.erf +
+
+ Returns erf(x), the Gauss error function, between -1 and 1. +
+
+ math.smoothstep +
+
+ Applies the smoothstep function +
+
+ math.normalize +
+
+ Returns the normalize vector of an given vector. +
+
+ +

+ Functions +

+ +

+ math.hypot(x, y) +

+

Returns the length of hypotenuse of right angle triangle with sides x and y, equivalent to sqrt(x*x + y*y), but has better numerical stability and internally handles intermediate overflows/underflows, but is also slower.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + sqrt(xx+yy)
    2. +
+ + + +
+

+ math.diag(x1[, x2[, x3[, xn]]]) +

+

Returns the length of the diagonal of an n-dimensional box (or the length of an n-component vector).

+
+

+ Rather quick method that does not handle intermediate overflows/underflows nor is made for numerical stability. + +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + x2 + number + + + + (optional) +
    3. +
  3. + x3 + number + + + + (optional) +
    4. +
  4. + xn + number + and so on + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + number + diagonal
    2. +
+ + + +
+

+ math.clamp() +

+

Returns x clamped to min and max boundaries.

+
+

+ ( number x, number min, number max ) +

+ + + +

Returns:

+
    +
  1. + number + clamped
    2. +
+ + + +
+

+ math.sgn(x) +

+

Returns 0 if x == 0, 1 if x > 0, -1 if x < 0

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + sign
    2. +
+ + + +
+

+ math.mix(x, y, a) +

+

Returns linear interpolation between x and y with ratio a (x+(y-x)*a).

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + a + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + number + (x+(y-x)*a)
    2. +
+ + + +
+

+ math.round(x, decimals) +

+

Returns x rounded to n decimals, if n is omitted or <=0, rounds to nearest integer.

+
+

+ Note that Spring's Lua interpreter uses 32-bit floats for all numbers so max. precision is ~7 decimal digits. + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + decimals + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + rounded
    2. +
+ + + +
+

+ math.erf(x) +

+

Returns erf(x), the Gauss error function, between -1 and 1.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + erf
    2. +
+ + + +
+

+ math.smoothstep(edge0, edge1, v) +

+

Applies the smoothstep function

+
+

+ + Clamps and rescales v to a value between [0; 1] based on the edges and then applies the smoothstep function. + For example math.smoothstep(10, 25, 15) is 0.259, because 15 is 0.333 of the way from 10 to 25, and smoothstep(0.333) is 0.259 +

+ + +

Parameters:

+
    +
  1. + edge0 + number + + + +
    2. +
  2. + edge1 + number + + + +
    3. +
  3. + v + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + number + smoothstep
    2. +
+ + + +
+

+ math.normalize(x1[, x2[, xN]]) +

+

Returns the normalize vector of an given vector.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + x2 + number + + + + (optional) +
    3. +
  3. + xN + number + and so on + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + number + normalized1
    2. +
  2. + number + normalized2 and so on
    3. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/MetalMap.html b/ldoc/modules/MetalMap.html new file mode 100644 index 0000000000..7ad9e4e4c9 --- /dev/null +++ b/ldoc/modules/MetalMap.html @@ -0,0 +1,80 @@ +--- +layout: default +title: MetalMap +permalink: ldoc/modules/MetalMap.html +description: Metal Map Lua API +parent: Lua API +table: 0x55953a959d90 +--- + +{% raw %} +

Module MetalMap

+

Metal Map Lua API

+

+ +

+

+

See also:

+ + +

Functions

+
+
+ Spring.SetMetalAmount +
+
+ + + +
+
+ +

+ Functions +

+ +

+ Spring.SetMetalAmount(x, z, metalAmount) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + in worldspace/16. +
    2. +
  2. + z + number + in worldspace/16. +
    3. +
  3. + metalAmount + number + must be between 0 and 255*maxMetal (with maxMetal from the .smd or mapinfo.lua). +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/MoveCtrl.html b/ldoc/modules/MoveCtrl.html new file mode 100644 index 0000000000..4df15859fd --- /dev/null +++ b/ldoc/modules/MoveCtrl.html @@ -0,0 +1,24 @@ +--- +layout: default +title: MoveCtrl +permalink: ldoc/modules/MoveCtrl.html +description: MoveCtrl +parent: Lua API +table: 0x55953a890c90 +--- + +{% raw %} +

Module MoveCtrl

+

MoveCtrl

+

+ +

+

+

See also:

+ + + + +{% endraw %} diff --git a/ldoc/modules/OpenGL.html b/ldoc/modules/OpenGL.html new file mode 100644 index 0000000000..fdcc049f3f --- /dev/null +++ b/ldoc/modules/OpenGL.html @@ -0,0 +1,207 @@ +--- +layout: default +title: OpenGL +permalink: ldoc/modules/OpenGL.html +description: Lua OpenGL API +parent: Lua API +table: 0x55953a802690 +--- + +{% raw %} +

Module OpenGL

+

Lua OpenGL API

+

+ +

+

+

See also:

+ + +

Text

+
+
+ gl.Text +
+
+ + + +
+
+

Draw Basics

+
+
+ gl.Color +
+
+ + + +
+
+ +

+ Text +

+ +

+ +

+

+

+ gl.Text(text, x, y, size[, options]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + text + string + + + +
    2. +
  2. + x + number + + + +
    3. +
  3. + y + number + + + +
    4. +
  4. + size + number + + + +
    5. +
  5. + options + string + +

    concatenated string of option characters.

    + +
      +
    • horizontal alignment: +
        +
      • 'c' = center
        • +
      • 'r' = right
        • +
      • +
    • vertical alignment: +
        +
      • 'a' = ascender
        • +
      • 't' = top
        • +
      • 'v' = vertical center
        • +
      • 'x' = baseline
        • +
      • 'b' = bottom
        • +
      • 'd' = descender
        • +
      • +
    • decorations: +
        +
      • 'o' = black outline
        • +
      • 'O' = white outline
        • +
      • 's' = shadow
        • +
      • +
    • other: +
        +
      • 'n' = don't round vertex coords to nearest integer (font may get blurry)
        • +
      • +
    + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Draw Basics +

+ +

+ +

+

+

+ gl.Color(r[, g[, b[, a]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + r + number or {number,number,number,number} + red when number, rgba + quadruple or rgb triple otherwise +
    2. +
  2. + g + number + + + + (optional) +
    3. +
  3. + b + number + + + + (optional) +
    4. +
  4. + a + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/Platform.html b/ldoc/modules/Platform.html new file mode 100644 index 0000000000..23d4e0851a --- /dev/null +++ b/ldoc/modules/Platform.html @@ -0,0 +1,212 @@ +--- +layout: default +title: Platform +permalink: ldoc/modules/Platform.html +description: Platform constants +parent: Lua API +table: 0x55953a6344f0 +--- + +{% raw %} +

Module Platform

+

Platform constants

+

+ +

+

+

See also:

+ + +

Tables

+
+
+ Platform +
+
+ Platform specific information +
+
+ +

+ Tables +

+ +

+ Platform +

+

Platform specific information

+
+

+ +

+ + +

Fields:

+
    +
  1. + gpu + string + full GPU device name +
    2. +
  2. + gpuVendor + string + one of "Nvidia", "Intel", "ATI", "Mesa", "Unknown" +
    3. +
  3. + glVersionShort + string + major.minor.buildNumber +
    4. +
  4. + glslVersionShort + string + major.minor +
    5. +
  5. + glVersion + string + full version +
    6. +
  6. + glVendor + string + + + +
    7. +
  7. + glRenderer + string + + + +
    8. +
  8. + glslVersion + string + full version +
    9. +
  9. + glewVersion + string + + + +
    10. +
  10. + osName + string + full name of the OS +
    11. +
  11. + osFamily + string + one of "Windows", "Linux", "MacOSX", "FreeBSD", "Unknown" +
    12. +
  12. + numDisplays + number + + + +
    13. +
  13. + gpuMemorySize + number + size of total GPU memory in MBs; only available for "Nvidia", (rest are 0) +
    14. +
  14. + sdlVersionCompiledMajor + number + + + +
    15. +
  15. + sdlVersionCompiledMinor + number + + + +
    16. +
  16. + sdlVersionCompiledPatch + number + + + +
    17. +
  17. + sdlVersionLinkedMajor + number + + + +
    18. +
  18. + sdlVersionLinkedMinor + number + + + +
    19. +
  19. + sdlVersionLinkedPatch + number + + + +
    20. +
  20. + glSupportNonPowerOfTwoTex + bool + + + +
    21. +
  21. + glSupportTextureQueryLOD + bool + + + +
    22. +
  22. + glSupport24bitDepthBuffer + bool + + + +
    23. +
  23. + glSupportRestartPrimitive + bool + + + +
    24. +
  24. + glSupportClipSpaceControl + bool + + + +
    25. +
  25. + glSupportFragDepthLayout + bool + + + +
    26. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/RBO.html b/ldoc/modules/RBO.html new file mode 100644 index 0000000000..0b7eb66485 --- /dev/null +++ b/ldoc/modules/RBO.html @@ -0,0 +1,196 @@ +--- +layout: default +title: RBO +permalink: ldoc/modules/RBO.html +description: RBO +parent: Lua API +table: 0x55953a5569e0 +--- + +{% raw %} +

Module RBO

+

RBO

+

+ +

+

+

See also:

+ + +

Functions

+
+
+ gl.CreateRBO +
+
+ + + +
+
+ gl.DeleteRBO +
+
+ + + +
+
+

Tables

+
+
+ rbo +
+
+ User Data RBO +
+
+ +

+ Functions +

+ +

+ gl.CreateRBO(xsize, ysize, data) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + xsize + number + + + +
    2. +
  2. + ysize + number + + + +
    3. +
  3. data + + +
      +
    • + target + number + GL_RENDERBUFFER_EXT +
      • +
    • + format + number + GL_RGBA +
      • +
    • + samples + number + any number here will result in creation of multisampled RBO + (optional) +
      • +
    +
+ + + + +
+

+ gl.DeleteRBO(rbo) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + rbo + rbo + + + +
    2. +
+ + + + +
+

+ Tables +

+ +

+ rbo +

+

User Data RBO

+
+

+ +

+ + +

Fields:

+
    +
  1. + target + number + + + +
    2. +
  2. + format + number + + + +
    3. +
  3. + xsize + number + + + +
    4. +
  4. + ysize + number + + + +
    5. +
  5. + valid + bool + + + +
    6. +
  6. + samples + number + will return globalRendering->msaaLevel for multisampled RBO or 0 otherwise +
    7. +
+ + + + +
+ +{% endraw %} diff --git a/ldoc/modules/Shaders.html b/ldoc/modules/Shaders.html new file mode 100644 index 0000000000..92530913c9 --- /dev/null +++ b/ldoc/modules/Shaders.html @@ -0,0 +1,806 @@ +--- +layout: default +title: Shaders +permalink: ldoc/modules/Shaders.html +description: Shader creation and management +parent: Lua API +table: 0x55953a54b860 +--- + +{% raw %} +

Module Shaders

+

Shader creation and management

+

+ + +

These functions are ONLY available if the graphics adapter supports GLSL. + Please test in your scripts if one of them exists before you use them. In headless mode, the gl. callouts are nil.

+ +
+

+

See also:

+ + +

Functions

+
+
+ gl.GetShaderLog +
+
+ Returns the shader compilation error log. +
+
+ gl.CreateShader +
+
+ Create a shader from shaderParams table: +
+
+ gl.DeleteShader +
+
+ Deletes a shader identified by shaderID +
+
+ gl.UseShader +
+
+ Binds a shader program identified by shaderID. +
+
+ gl.ActiveShader +
+
+ Binds a shader program identified by shaderID, and calls the Lua func with the specified arguments. +
+
+ gl.GetActiveUniforms +
+
+ Query the active (actually used) uniforms of a shader and identify their names, types (float, int, uint) and sizes (float, vec4, ...). +
+
+ gl.GetUniformLocation +
+
+ Returns the locationID of a shaders uniform. +
+
+ gl.Uniform +
+
+ Sets the uniform float value at the locationID for the currently active shader. +
+
+ gl.UniformInt +
+
+ Sets the uniform int value at the locationID for the currently active shader. +
+
+ gl.UniformArray +
+
+ Sets the an array of uniform values at the locationID for the currently active shader. +
+
+ gl.UniformMatrix +
+
+ Sets the a uniform mat4 locationID for the currently active shader. +
+
+ gl.GetEngineUniformBufferDef +
+
+ + + +
+
+ gl.GetEngineModelUniformDataDef +
+
+ + + +
+
+ gl.SetGeometryShaderParameter +
+
+ Sets the Geometry shader parameters for shaderID. +
+
+ gl.SetTesselationShaderParameter +
+
+ Sets the tesselation shader parameters for shaderID. +
+
+ +

+ Functions +

+ +

+ gl.GetShaderLog() +

+

Returns the shader compilation error log.

+
+

+ This is empty if the shader linking failed, in that case, check your in/out blocks and ensure they match. + +

+ + + +

Returns:

+
    +
  1. + string + infoLog
    2. +
+ + + +
+

+ gl.CreateShader(shaderParams) +

+

Create a shader from shaderParams table:

+
+

+ ( table shaderParams ) +

+ + +

Parameters:

+
    +
  1. + shaderParams + table + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + +

    shaderID

    + +
    ({[ vertex   = "glsl code" ,]
+  [ tcs      = "glsl code" ,]
+  [ tes      = "glsl code" ,]
+  [ geometry = "glsl code" ,]
+  [ fragment = "glsl code" ,]
+  [ uniform       = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
+  [ uniformInt    = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
+  [ uniformFloat  = { uniformName = number value, ...} ,] (specify a Lua array as an argument to uniformName to initialize GLSL arrays)
+  [ uniformMatrix = { uniformName = number value, ...} ,]
+  [ geoInputType = number inType,]
+  [ geoOutputType = number outType,]
+  [ geoOutputVerts = number maxVerts,]
+  [ definitions = "string of shader #defines", ]
+})
+
    + +
      +
    • The "Vertex" or vertex-shader is your GLSL-Code as string, its written in a C-Dialect. This shader is busy deforming the geometry of a unit but it can not create new polygons. Use it for waves, wobbling surfaces etc.
      • +
    • The "Geometry" or Geometry-shader can create new vertices and vertice-stripes from points.
      • +
    • The "TCS" or Tesselation Control Shader controls how much tessellation a particular patch gets; it also defines the size of a patch, thus allowing it to augment data. It can also filter vertex data taken from the vertex shader. The main purpose of the TCS is to feed the tessellation levels to the Tessellation primitive generator stage, as well as to feed patch data (as its output values) to the Tessellation Evaluation Shader stage.
      • +
    • The "TES" or Tesselation Evaluation Shader takes the abstract patch generated by the tessellation primitive generation stage, as well as the actual vertex data for the entire patch, and generates a particular vertex from it. Each TES invocation generates a single vertex. It can also take per-patch data provided by the Tessellation Control Shader.
      • +
    • The "Fragment" or Fragment-shader (sometimes called pixel-Shader) is post processing the allready rendered picture (for example drawing stars on the sky)- remember textures are not always 2 dimensional pictures. They can contain information about the depth, or the third value marks areas and the strength at which these are processed.
      • +
    • The Uniforms are the values, you send along with the shader-program. To use them in the shader-program declare them like this: uniform float frame;
      • +
    + +

    The engine will automatically fill in an appropriately named uniform for team colour if it is declared;

    + +
    uniform vec4 teamColor;
+
    +
    2. +
+ + + +
+

+ gl.DeleteShader(shaderID) +

+

Deletes a shader identified by shaderID

+
+

+ +

+ + +

Parameters:

+
    +
  1. + shaderID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ gl.UseShader(shaderID) +

+

Binds a shader program identified by shaderID.

+
+

+ Pass 0 to disable the shader. Returns wether the shader was successfully bound. + +

+ + +

Parameters:

+
    +
  1. + shaderID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + bool + linked
    2. +
+ + + +
+

+ gl.ActiveShader(shaderID, func[, arg1[, arg2[, argn]]]) +

+

Binds a shader program identified by shaderID, and calls the Lua func with the specified arguments.

+
+

+ + + Can be used in NON-drawing events (to update uniforms etc.)! + +

+ + +

Parameters:

+
    +
  1. + shaderID + number + + + +
    2. +
  2. + func + func + + + +
    3. +
  3. + arg1 + any + + + + (optional) +
    4. +
  4. + arg2 + any + + + + (optional) +
    5. +
  5. + argn + any + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ gl.GetActiveUniforms(shaderID) +

+

Query the active (actually used) uniforms of a shader and identify their names, types (float, int, uint) and sizes (float, vec4, ...).

+
+

+ +

+ + +

Parameters:

+
    +
  1. + shaderID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + table + ActiveUniforms = { { name = "name", type = "type", length = number length, size = number size }, ...}
    2. +
+ + + +
+

+ gl.GetUniformLocation(shaderID, name) +

+

Returns the locationID of a shaders uniform.

+
+

+ Needed for changing uniform values with @function gl.Uniform. + +

+ + +

Parameters:

+
    +
  1. + shaderID + number + + + +
    2. +
  2. + name + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + locationID
    2. +
+ + + +
+

+ gl.Uniform(locationID, f1[, f2[, f3[, f4]]]) +

+

Sets the uniform float value at the locationID for the currently active shader.

+
+

+ Shader must be activated before setting uniforms. + +

+ + +

Parameters:

+
    +
  1. + locationID + number + |string uniformName +
    2. +
  2. + f1 + number + + + +
    3. +
  3. + f2 + number + + + + (optional) +
    4. +
  4. + f3 + number + + + + (optional) +
    5. +
  5. + f4 + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ gl.UniformInt(locationID, int1[, int2[, int3[, int4]]]) +

+

Sets the uniform int value at the locationID for the currently active shader.

+
+

+ Shader must be activated before setting uniforms. + +

+ + +

Parameters:

+
    +
  1. + locationID + number + |string uniformName +
    2. +
  2. + int1 + number + + + +
    3. +
  3. + int2 + number + + + + (optional) +
    4. +
  4. + int3 + number + + + + (optional) +
    5. +
  5. + int4 + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ gl.UniformArray(locationID, type, uniforms) +

+

Sets the an array of uniform values at the locationID for the currently active shader.

+
+

+ Shader must be activated before setting uniforms. Type can be one of {1 = int, 2 = float, 3 = float matrix}. + +

+ + +

Parameters:

+
    +
  1. + locationID + number + |string uniformName +
    2. +
  2. + type + number + + + +
    3. +
  3. + uniforms + table + Array up to 1024 elements +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ gl.UniformMatrix(locationID, m1[, m2[, mn[, m16]]]) +

+

Sets the a uniform mat4 locationID for the currently active shader.

+
+

+ Shader must be activated before setting uniforms. Can set one one common matrix like shadow, or by passing 16 additional numbers for the matrix. + +

+ + +

Parameters:

+
    +
  1. + locationID + number + |string uniformName +
    2. +
  2. + m1 + string or number + "shadows" | "camera" | "caminv" | "camprj" +
    3. +
  3. + m2 + number + + + + (optional) +
    4. +
  4. + mn + number + + + + (optional) +
    5. +
  5. + m16 + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ gl.GetEngineUniformBufferDef(index) +

+

+
+

+ + + Return the GLSL compliant definition of UniformMatricesBuffer(idx=0) or UniformParamsBuffer(idx=1) structure. + +

+ + +

Parameters:

+
    +
  1. + index + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + string + glslDefinition
    2. +
+ + + +
+

+ gl.GetEngineModelUniformDataDef(index) +

+

+
+

+ + + Return the GLSL compliant definition of ModelUniformData structure (per Unit/Feature buffer available on GPU) + +

+ + +

Parameters:

+
    +
  1. + index + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + string + glslDefinition
    2. +
+ + + +
+

+ gl.SetGeometryShaderParameter(shaderID, param, number) +

+

Sets the Geometry shader parameters for shaderID.

+
+

+ Needed by geometry shader programs (check the opengl GL_ARB_geometry_shader4 extension for glProgramParameteri) + +

+ + +

Parameters:

+
    +
  1. + shaderID + number + + + +
    2. +
  2. + param + number + + + +
    3. +
  3. + number + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ gl.SetTesselationShaderParameter(param, number) +

+

Sets the tesselation shader parameters for shaderID.

+
+

+ + + Needed by tesselation shader programs (check the opengl GL_ARB_tessellation_shader extension for glProgramParameteri) + +

+ + +

Parameters:

+
    +
  1. + param + number + + + +
    2. +
  2. + number + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/SyncedCtrl.html b/ldoc/modules/SyncedCtrl.html new file mode 100644 index 0000000000..6baa8402f1 --- /dev/null +++ b/ldoc/modules/SyncedCtrl.html @@ -0,0 +1,11699 @@ +--- +layout: default +title: SyncedCtrl +permalink: ldoc/modules/SyncedCtrl.html +description: Synced Lua API +parent: Lua API +table: 0x55953a267fa0 +--- + +{% raw %} +

Module SyncedCtrl

+

Synced Lua API

+

+ +

+

See also:

+ + +

Teams

+
+
+ Spring.SetAlly +
+
+ Changes the value of the (one-sided) alliance between: firstAllyTeamID -> secondAllyTeamID. +
+
+ Spring.SetAllyTeamStartBox +
+
+ Changes the start box position of an allyTeam. +
+
+ Spring.AssignPlayerToTeam +
+
+ Assigns a player to a team. +
+
+ Spring.SetGlobalLos +
+
+ Changes access to global line of sight for a team and its allies. +
+
+

Game End

+
+
+ Spring.KillTeam +
+
+ Will declare a team to be dead (no further orders can be assigned to such teams units). +
+
+ Spring.GameOver +
+
+ Will declare game over. +
+
+

Resources

+
+
+ Spring.SetTidal +
+
+ Set tidal strength +
+
+ Spring.SetWind +
+
+ Set wind strength +
+
+ Spring.AddTeamResource +
+
+ Adds metal or energy resources to the specified team. +
+
+ Spring.UseTeamResource +
+
+ Consumes metal and/or energy resources of the specified team. +
+
+ Spring.SetTeamResource +
+
+ + + +
+
+ Spring.SetTeamShareLevel +
+
+ Changes the resource amount for a team beyond which resources aren't stored but transferred to other allied teams if possible. +
+
+ Spring.ShareTeamResource +
+
+ Transfers resources between two teams. +
+
+

Rules Params

+
+
+ losAccess +
+
+ Parameters for los access +
+
+ Spring.SetGameRulesParam +
+
+ + + +
+
+ Spring.SetTeamRulesParam +
+
+ + + +
+
+ Spring.SetPlayerRulesParam +
+
+ + + +
+
+ Spring.SetUnitRulesParam +
+
+ + + +
+
+ Spring.SetFeatureRulesParam +
+
+ + + +
+
+

Lua to COB

+
+
+ Spring.CallCOBScript +
+
+ + + +
+
+ Spring.GetCOBScriptID +
+
+ + + +
+
+

Unit Handling

+
+
+ Spring.CreateUnit +
+
+ + + +
+
+ Spring.DestroyUnit +
+
+ + + +
+
+ Spring.TransferUnit +
+
+ + + +
+
+

Unit Control

+
+
+ Spring.SetUnitCosts +
+
+ + + +
+
+

Unit Resourcing

+
+
+ Spring.SetUnitResourcing +
+
+ + + +
+
+ Spring.SetUnitResourcing +
+
+ + + +
+
+ Spring.SetUnitTooltip +
+
+ + + +
+
+ Spring.SetUnitHealth +
+
+ + + +
+
+ Spring.SetUnitMaxHealth +
+
+ + + +
+
+ Spring.SetUnitStockpile +
+
+ + + +
+
+ Spring.SetUnitUseWeapons +
+
+ + + +
+
+ states +
+
+ Parameter for weapon states +
+
+ Spring.SetUnitWeaponState +
+
+ + + +
+
+ Spring.SetUnitWeaponState +
+
+ + + +
+
+ damages +
+
+ Parameters for damage +
+
+ Spring.SetUnitWeaponDamages +
+
+ + + +
+
+ Spring.SetUnitWeaponDamages +
+
+ + + +
+
+ Spring.SetUnitMaxRange +
+
+ + + +
+
+ Spring.SetUnitExperience +
+
+ + + +
+
+ Spring.AddUnitExperience +
+
+ + + +
+
+ Spring.SetUnitArmored +
+
+ + + +
+
+

Unit LOS

+
+
+ Spring.SetUnitLosMask +
+
+ + + +
+
+ Spring.SetUnitLosState +
+
+ + + +
+
+ Spring.SetUnitCloak +
+
+ + + +
+
+ Spring.SetUnitStealth +
+
+ + + +
+
+ Spring.SetUnitSonarStealth +
+
+ + + +
+
+ Spring.SetUnitSeismicSignature +
+
+ + + +
+
+ Spring.SetUnitAlwaysVisible +
+
+ + + +
+
+ Spring.SetUnitUseAirLos +
+
+ + + +
+
+ Spring.SetUnitMetalExtraction +
+
+ + + +
+
+ Spring.SetUnitHarvestStorage +
+
+ See also harvestStorage UnitDef tag. +
+
+ Spring.SetUnitBuildParams +
+
+ + + +
+
+ Spring.SetUnitBuildSpeed +
+
+ + + +
+
+ Spring.SetUnitNanoPieces +
+
+ + + +
+
+ Spring.SetUnitBlocking +
+
+ + + +
+
+ Spring.SetUnitCrashing +
+
+ + + +
+
+ Spring.SetUnitShieldState +
+
+ + + +
+
+ Spring.SetUnitShieldRechargeDelay +
+
+ + + +
+
+ Spring.SetUnitFlanking +
+
+ + + +
+
+ Spring.SetUnitPhysicalStateBit +
+
+ + + +
+
+ Spring.GetUnitPhysicalState +
+
+ + + +
+
+ Spring.SetUnitNeutral +
+
+ + + +
+
+ Spring.SetUnitTarget +
+
+ Defines a unit's target. +
+
+ Spring.SetUnitTarget +
+
+ + + +
+
+ Spring.SetUnitMidAndAimPos +
+
+ + + +
+
+ Spring.SetUnitRadiusAndHeight +
+
+ + + +
+
+ Spring.SetUnitBuildeeRadius +
+
+ + + +
+
+ Spring.SetUnitPieceParent +
+
+ Changes the pieces hierarchy of a unit by attaching a piece to a new parent. +
+
+ Spring.SetUnitPieceMatrix +
+
+ Sets the local (i.e. +
+
+ Spring.SetUnitCollisionVolumeData +
+
+ + + +
+
+ Spring.SetUnitPieceCollisionVolumeData +
+
+ + + +
+
+ Spring.SetUnitPieceVisible +
+
+ + + +
+
+ Spring.SetUnitSensorRadius +
+
+ + + +
+
+ Spring.SetUnitPosErrorParams +
+
+ + + +
+
+ Spring.SetUnitMoveGoal +
+
+ Used by default commands to get in build-, attackrange etc. +
+
+ Spring.SetUnitLandGoal +
+
+ Used in conjunction with Spring.UnitAttach et al. +
+
+ Spring.ClearUnitGoal +
+
+ + + +
+
+ Spring.SetUnitPhysics +
+
+ + + +
+
+ Spring.SetUnitMass +
+
+ + + +
+
+ Spring.SetUnitPosition +
+
+ Set unit position (2D) +
+
+ Spring.SetUnitPosition +
+
+ Set unit position (3D) +
+
+ Spring.SetUnitRotation +
+
+ + + +
+
+ Spring.SetUnitDirection +
+
+ + + +
+
+ Spring.SetUnitHeadingAndUpDir +
+
+ + + +
+
+ Spring.SetUnitVelocity +
+
+ + + +
+
+ Spring.SetFactoryBuggerOff +
+
+ + + +
+
+ Spring.BuggerOff +
+
+ + + +
+
+ Spring.AddUnitDamage +
+
+ + + +
+
+ Spring.AddUnitImpulse +
+
+ + + +
+
+ Spring.AddUnitSeismicPing +
+
+ + + +
+
+ Spring.AddUnitResource +
+
+ + + +
+
+ Spring.UseUnitResource +
+
+ + + +
+
+ Spring.UseUnitResource +
+
+ + + +
+
+

Decals

+
+
+ Spring.AddObjectDecal +
+
+ + + +
+
+ Spring.RemoveObjectDecal +
+
+ + + +
+
+

Grass

+
+
+ Spring.AddGrass +
+
+ + + +
+
+ Spring.RemoveGrass +
+
+ + + +
+
+

Feature Handling

+
+
+ Spring.CreateFeature +
+
+ + + +
+
+ Spring.DestroyFeature +
+
+ + + +
+
+ Spring.TransferFeature +
+
+ Feature Control +
+
+ Spring.SetFeatureAlwaysVisible +
+
+ + + +
+
+ Spring.SetFeatureUseAirLos +
+
+ + + +
+
+ Spring.SetFeatureHealth +
+
+ + + +
+
+ Spring.SetFeatureMaxHealth +
+
+ + + +
+
+ Spring.SetFeatureReclaim +
+
+ + + +
+
+ Spring.SetFeatureResources +
+
+ + + +
+
+ Spring.SetFeatureResurrect +
+
+ + + +
+
+ Spring.SetFeatureMoveCtrl +
+
+ + + +
+
+ Spring.SetFeaturePhysics +
+
+ + + +
+
+ Spring.SetFeatureMass +
+
+ + + +
+
+ Spring.SetFeaturePosition +
+
+ + + +
+
+ Spring.SetFeatureRotation +
+
+ + + +
+
+ Spring.SetFeatureDirection +
+
+ + + +
+
+ Spring.SetFeatureHeadingAndUpDir +
+
+ + + +
+
+ Spring.SetFeatureVelocity +
+
+ + + +
+
+ Spring.SetFeatureBlocking +
+
+ + + +
+
+ Spring.SetFeatureNoSelect +
+
+ + + +
+
+ Spring.SetFeatureMidAndAimPos +
+
+ + + +
+
+ Spring.SetFeatureRadiusAndHeight +
+
+ + + +
+
+ Spring.SetFeatureCollisionVolumeData +
+
+ + + +
+
+ Spring.SetFeaturePieceCollisionVolumeData +
+
+ + + +
+
+ Spring.SetFeaturePieceVisible +
+
+ + + +
+
+

Projectiles

+
+
+ projectileParams +
+
+ + + +
+
+ Spring.SetProjectileAlwaysVisible +
+
+ + + +
+
+ Spring.SetProjectileUseAirLos +
+
+ + + +
+
+ Spring.SetProjectileMoveControl +
+
+ Disables engine movecontrol, so lua can fully control the physics. +
+
+ Spring.SetProjectilePosition +
+
+ + + +
+
+ Spring.SetProjectileVelocity +
+
+ + + +
+
+ Spring.SetProjectileCollision +
+
+ + + +
+
+ Spring.SetProjectileTarget +
+
+ + + +
+
+ Spring.SetProjectileIsIntercepted +
+
+ + + +
+
+ Spring.SetProjectileDamages +
+
+ + + +
+
+ Spring.SetProjectileIgnoreTrackingError +
+
+ + + +
+
+ Spring.SetProjectileGravity +
+
+ + + +
+
+ Spring.SetPieceProjectileParams +
+
+ + + +
+
+

Give Order

+
+
+ cmdOpts +
+
+ Command Options params +
+
+ cmdSpec +
+
+ Command spec +
+
+ Spring.UnitFinishCommand +
+
+ + + +
+
+ Spring.GiveOrderToUnit +
+
+ + + +
+
+ Spring.GiveOrderToUnitMap +
+
+ + + +
+
+ Spring.GiveOrderToUnitArray +
+
+ + + +
+
+ Spring.GiveOrderArrayToUnit +
+
+ + + +
+
+ Spring.GiveOrderArrayToUnitMap +
+
+ + + +
+
+ Spring.GiveOrderArrayToUnitArray +
+
+ + + +
+
+

Heightmap

+
+
+ Spring.LevelHeightMap +
+
+ Set a certain height to a point or rectangle area on the world +
+
+ Spring.AdjustHeightMap +
+
+ Add a certain height to a point or rectangle area on the world +
+
+ Spring.RevertHeightMap +
+
+ Restore original map height to a point or rectangle area on the world +
+
+ Spring.AddHeightMap +
+
+ Can only be called in Spring.SetHeightMapFunc +
+
+ Spring.SetHeightMap +
+
+ + + +
+
+ Spring.SetHeightMapFunc +
+
+ + + +
+
+

Height Map/Smooth Mesh

+
+
+ Spring.LevelOriginalHeightMap +
+
+ Set a height to a point or rectangle area to the original map height cache +
+
+ Spring.AdjustOriginalHeightMap +
+
+ Add height to a point or rectangle area to the original map height cache +
+
+ Spring.RevertOriginalHeightMap +
+
+ Restore original map height cache to a point or rectangle area on the world +
+
+ Spring.AddOriginalHeightMap +
+
+ + + +
+
+ Spring.SetOriginalHeightMap +
+
+ + + +
+
+ Spring.SetOriginalHeightMapFunc +
+
+ + + +
+
+ Spring.RebuildSmoothMesh +
+
+ + + +
+
+ Spring.LevelSmoothMesh +
+
+ + + +
+
+ Spring.AdjustSmoothMesh +
+
+ + + +
+
+ Spring.RevertSmoothMesh +
+
+ + + +
+
+ Spring.AddSmoothMesh +
+
+ Can only be called in Spring.SetSmoothMeshFunc. +
+
+ Spring.SetSmoothMesh +
+
+ Can only be called in Spring.SetSmoothMeshFunc. +
+
+ Spring.SetSmoothMeshFunc +
+
+ + + +
+
+

TerrainTypes

+
+
+ Spring.SetMapSquareTerrainType +
+
+ + + +
+
+ Spring.SetTerrainTypeData +
+
+ + + +
+
+ Spring.SetSquareBuildingMask +
+
+ + + +
+
+ Spring.UnitWeaponFire +
+
+ + + +
+
+ Spring.ForceUnitCollisionUpdate +
+
+ Prevent collision checks from working on outdated data

+ +

There's a rare edge case that requires units to be in specific positions + and being shot by specific weapons but which can result in shots ghosting + through the unit. +

+
+ Spring.UnitAttach +
+
+ + + +
+
+ Spring.UnitDetach +
+
+ + + +
+
+ Spring.UnitDetachFromAir +
+
+ + + +
+
+ Spring.SetUnitLoadingTransport +
+
+ Disables collisions between the two units to allow colvol intersection during the approach. +
+
+ Spring.SpawnProjectile +
+
+ + + +
+
+ Spring.DeleteProjectile +
+
+ Silently removes projectiles (no explosion). +
+
+ explosionParams +
+
+ Parameters for explosion

+ +

Please note the explosion defaults to 1 damage regardless of what it's defined in the weaponDef. +

+
+ Spring.SpawnExplosion +
+
+ + + +
+
+ Spring.SpawnCEG +
+
+ + + +
+
+ Spring.SpawnSFX +
+
+ Equal to the UnitScript versions of EmitSFX, but takes position and direction arguments (in either unit- or piece-space) instead of a piece index. +
+
+

Other

+
+
+ Spring.SetNoPause +
+
+ + + +
+
+ Spring.SetExperienceGrade +
+
+ Defines how often Callins.UnitExperience will be called. +
+
+ Spring.SetRadarErrorParams +
+
+ + + +
+
+

Command Descriptions

+
+
+ Spring.EditUnitCmdDesc +
+
+ + + +
+
+ Spring.InsertUnitCmdDesc +
+
+ + + +
+
+ Spring.RemoveUnitCmdDesc +
+
+ + + +
+
+ +

+ Teams +

+ +

+ +

+

+

+ Spring.SetAlly(firstAllyTeamID, secondAllyTeamID, ally) +

+

Changes the value of the (one-sided) alliance between: firstAllyTeamID -> secondAllyTeamID.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + firstAllyTeamID + number + + + +
    2. +
  2. + secondAllyTeamID + number + + + +
    3. +
  3. + ally + bool + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetAllyTeamStartBox(allyTeamID, xMin, zMin, xMax, zMax) +

+

Changes the start box position of an allyTeam.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyTeamID + number + + + +
    2. +
  2. + xMin + number + left start box boundary (elmos) +
    3. +
  3. + zMin + number + top start box boundary (elmos) +
    4. +
  4. + xMax + number + right start box boundary (elmos) +
    5. +
  5. + zMax + number + bottom start box boundary (elmos) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AssignPlayerToTeam(playerID, teamID) +

+

Assigns a player to a team.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + teamID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetGlobalLos(allyTeamID, globallos) +

+

Changes access to global line of sight for a team and its allies.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyTeamID + number + + + +
    2. +
  2. + globallos + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Game End +

+ +

+ Spring.KillTeam(teamID) +

+

Will declare a team to be dead (no further orders can be assigned to such teams units).

+
+

+ + + Gaia team cannot be killed. + +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.GameOver([allyTeamID1[, allyTeamID2[, allyTeamIDn]]]) +

+

Will declare game over.

+
+

+ + + A list of winning allyteams can be passed, if undecided (like when dropped from the host) it should be empty (no winner), in the case of a draw with multiple winners, all should be listed. + +

+ + +

Parameters:

+
    +
  1. + allyTeamID1 + number + + + + (optional) +
    2. +
  2. + allyTeamID2 + number + + + + (optional) +
    3. +
  3. + allyTeamIDn + number + + + + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Resources +

+ +

+ Spring.SetTidal(strength) +

+

Set tidal strength

+
+

+ +

+ + +

Parameters:

+
    +
  1. + strength + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetWind(minStrength, maxStrength) +

+

Set wind strength

+
+

+ +

+ + +

Parameters:

+
    +
  1. + minStrength + number + + + +
    2. +
  2. + maxStrength + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddTeamResource(teamID, type, amount) +

+

Adds metal or energy resources to the specified team.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + type + string + "metal" | "energy" +
    3. +
  3. + amount + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.UseTeamResource(teamID, type, amount) +

+

Consumes metal and/or energy resources of the specified team.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + type + string + "metal" | "energy" +
    3. +
  3. + amount + number or table + { metal = number amount, energy = number amount } +
    4. +
+ +

Returns:

+
    +
  1. + nil or bool + hadEnough
    2. +
+ + + +
+

+ Spring.SetTeamResource(teamID, res, amount) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + res + string + "m" = metal "e" = energy "ms" = metal storage "es" = energy storage +
    3. +
  3. + amount + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetTeamShareLevel(teamID, type, amount) +

+

Changes the resource amount for a team beyond which resources aren't stored but transferred to other allied teams if possible.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + type + string + "metal" | "energy" +
    3. +
  3. + amount + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ShareTeamResource(teamID_src, teamID_recv, type, amount) +

+

Transfers resources between two teams.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID_src + number + + + +
    2. +
  2. + teamID_recv + number + + + +
    3. +
  3. + type + string + "metal" | "energy" +
    4. +
  4. + amount + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Rules Params +

+ +

+ +

+

+

+ losAccess +

+

Parameters for los access

+
+

+ + If one condition is fulfilled all beneath it are too (e.g. if an unit is in LOS it can read params with `inradar=true` even if the param has `inlos=false`) + All GameRulesParam are public, TeamRulesParams can just be `private`,`allied` and/or `public` + You can read RulesParams from any Lua enviroments! With those losAccess policies you can limit their access. + +

+ + +

Fields:

+
    +
  1. + private + bool + only readable by the ally (default) + (optional) +
    2. +
  2. + allied + bool + readable by ally + ingame allied + (optional) +
    3. +
  3. + inlos + bool + readable if the unit is in LOS + (optional) +
    4. +
  4. + inradar + bool + readable if the unit is in AirLOS + (optional) +
    5. +
  5. + public + bool + readable by all + (optional) +
    6. +
+ + + + +
+

+ Spring.SetGameRulesParam(paramName, paramValue[, losAccess]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + paramName + string + + + +
    2. +
  2. + paramValue + number or string + numeric paramValues in quotes will be converted to number. +
    3. +
  3. + losAccess + losAccess + + + + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetTeamRulesParam(teamID, paramName, paramValue[, losAccess]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + paramName + string + + + +
    3. +
  3. + paramValue + number or string + numeric paramValues in quotes will be converted to number. +
    4. +
  4. + losAccess + losAccess + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetPlayerRulesParam(playerID, paramName, paramValue[, losAccess]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + paramName + string + + + +
    3. +
  3. + paramValue + number or string + numeric paramValues in quotes will be converted to number. +
    4. +
  4. + losAccess + losAccess + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitRulesParam(unitID, paramName, paramValue[, losAccess]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + paramName + string + + + +
    3. +
  3. + paramValue + number or string + numeric paramValues in quotes will be converted to number. +
    4. +
  4. + losAccess + losAccess + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureRulesParam(featureID, paramName, paramValue[, losAccess]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + paramName + string + + + +
    3. +
  3. + paramValue + number or string + numeric paramValues in quotes will be converted to number. +
    4. +
  4. + losAccess + losAccess + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Lua to COB +

+ +

+ +

+

+

+ Spring.CallCOBScript(unitID, funcName, retArgs[, COBArg1[, COBArg2[, COBArgn]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + funcName + number or string + + + +
    3. +
  3. + retArgs + number + + + +
    4. +
  4. + COBArg1 + + + + (optional) +
    5. +
  5. + COBArg2 + + + + (optional) +
    6. +
  6. + COBArgn + + + + (optional) +
    7. +
+ +

Returns:

+
    +
  1. + nil or number + returnValue
    2. +
  2. + nil or number + returnArg1
    3. +
  3. + nil or number + returnArg2
    4. +
  4. + nil or number + returnArgn
    5. +
+ + + +
+

+ Spring.GetCOBScriptID(unitID, funcName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + funcName + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + funcID
    2. +
+ + + +
+

+ Unit Handling +

+ +

+ +

+

+

+ Spring.CreateUnit(unitDefName, x, y, z, facing, teamID[, build=false[, flattenGround=true[, unitID[, builderID]]]]) +

+

+
+

+ + + Offmap positions are clamped! Use MoveCtrl to move to such positions. + +

+ + +

Parameters:

+
    +
  1. + unitDefName + string or number + or unitDefID +
    2. +
  2. + x + number + + + +
    3. +
  3. + y + number + + + +
    4. +
  4. + z + number + + + +
    5. +
  5. + facing + string or number + possible values for facing are: "south" | "s" | 0, "east" | "e" | 1, "north" | "n" | 2, "west" | "w" | 3 +
    6. +
  6. + teamID + number + + + +
    7. +
  7. + build + bool + the unit is created in "being built" state with buildProgress = 0 + (default false) +
    8. +
  8. + flattenGround + bool + the unit flattens ground, if it normally does so + (default true) +
    9. +
  9. + unitID + number + requests specific unitID + (optional) +
    10. +
  10. + builderID + number + + + + (optional) +
    11. +
+ +

Returns:

+
    +
  1. + number or nil + unitID meaning unit was created
    2. +
+ + +

See also:

+
    +
+ +
+

+ Spring.DestroyUnit(unitID[, selfd=false[, reclaimed=false[, attackerID[, cleanupImmediately=false]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + selfd + bool + makes the unit act like it self-destructed. + (default false) +
    3. +
  3. + reclaimed + bool + don't show any DeathSequences, don't leave a wreckage. This does not give back the resources to the team! + (default false) +
    4. +
  4. + attackerID + number + + + + (optional) +
    5. +
  5. + cleanupImmediately + bool + stronger version of reclaimed, removes the unit unconditionally and makes its ID available for immediate reuse (otherwise it takes a few frames) + (default false) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + +

See also:

+ + +
+

+ Spring.TransferUnit(unitID, newTeamID[, given=true]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + newTeamID + number + + + +
    3. +
  3. + given + bool + if false, the unit is captured. + (default true) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Unit Control +

+ +

+ +

+

+

+ Spring.SetUnitCosts(unitID, where) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + where + {[number]=number,...} + keys and values are, respectively and in this order: buildTime=amount, metalCost=amount, energyCost=amount +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Unit Resourcing +

+ +

+ Spring.SetUnitResourcing(unitID, res, amount) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + res + string + + + +
    3. +
  3. + amount + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitResourcing(unitID, res) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + res + {[string]=number,...} + keys are: "[u|c][u|m][m|e]" unconditional | conditional, use | make, metal | energy. Values are amounts +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitTooltip(unitID, tooltip) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + tooltip + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitHealth(unitID, health) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + health + number or {[string]=number,...} + where keys can be one of health|capture|paralyze|build and values are amounts +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitMaxHealth(unitID, maxHealth) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + maxHealth + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitStockpile(unitID[, stockpile[, buildPercent]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + stockpile + number + + + + (optional) +
    3. +
  3. + buildPercent + number + + + + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitUseWeapons(unitID[, forceUseWeapons[, allowUseWeapons]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + forceUseWeapons + number + + + + (optional) +
    3. +
  3. + allowUseWeapons + number + + + + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ states +

+

Parameter for weapon states

+
+

+ +

+ + +

Fields:

+
    +
  1. + reloadState + number + + + +
    2. +
  2. + reloadFrame + number + synonym for reloadState! +
    3. +
  3. + reloadTime + number + + + +
    4. +
  4. + accuracy + number + + + +
    5. +
  5. + sprayAngle + number + + + +
    6. +
  6. + range + number + if you change the range of a weapon with dynamic damage make sure you use SetUnitWeaponDamages to change dynDamageRange as well. +
    7. +
  7. + projectileSpeed + number + + + +
    8. +
  8. + burst + number + + + +
    9. +
  9. + burstRate + number + + + +
    10. +
  10. + projectiles + number + + + +
    11. +
  11. + salvoLeft + number + + + +
    12. +
  12. + nextSalvo + number + + + +
    13. +
  13. + aimReady + number + (<>0.0f := true) +
    14. +
+ + + + +
+

+ Spring.SetUnitWeaponState(unitID, weaponNum, states) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponNum + number + + + +
    3. +
  3. + states + states + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitWeaponState(unitID, weaponNum, key, value) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponNum + number + + + +
    3. +
  3. + key + string + + + +
    4. +
  4. + value + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ damages +

+

Parameters for damage

+
+

+ +

+ + +

Fields:

+
    +
  1. + paralyzeDamageTime + number + + + +
    2. +
  2. + impulseFactor + number + + + +
    3. +
  3. + impulseBoost + number + + + +
    4. +
  4. + craterMult + number + + + +
    5. +
  5. + craterBoost + number + + + +
    6. +
  6. + dynDamageExp + number + + + +
    7. +
  7. + dynDamageMin + number + + + +
    8. +
  8. + dynDamageRange + number + + + +
    9. +
  9. + dynDamageInverted + number + (<>0.0f := true) +
    10. +
  10. + craterAreaOfEffect + number + + + +
    11. +
  11. + damageAreaOfEffect + number + + + +
    12. +
  12. + edgeEffectiveness + number + + + +
    13. +
  13. + explosionSpeed + number + + + +
    14. +
  14. + armorType + number + + + +
    15. +
+ + + + +
+

+ Spring.SetUnitWeaponDamages(unitID, weaponNum, damages) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponNum + number or string + "selfDestruct" | "explode" +
    3. +
  3. + damages + damages + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitWeaponDamages(unitID, weaponNum, key, value) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponNum + number or string + "selfDestruct" | "explode" +
    3. +
  3. + key + string + + + +
    4. +
  4. + value + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitMaxRange(unitID, maxRange) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + maxRange + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitExperience(unitID, experience) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + experience + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + +

See also:

+ + +
+

+ Spring.AddUnitExperience(unitID, deltaExperience) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + deltaExperience + number + Can be negative to subtract, but the unit will never have negative total afterwards +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + +

See also:

+ + +
+

+ Spring.SetUnitArmored(unitID[, armored[, armorMultiple]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + armored + bool + + + + (optional) +
    3. +
  3. + armorMultiple + number + + + + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Unit LOS +

+ +

+ +

+

+

+ Spring.SetUnitLosMask(unitID, allyTeam, losTypes) +

+

+
+

+ + + The 3rd argument is either the bit-and combination of the following numbers: + + LOS_INLOS = 1 + LOS_INRADAR = 2 + LOS_PREVLOS = 4 + LOS_CONTRADAR = 8 + + or a table of the following form: + + losTypes = { + [los = boolean,] + [radar = boolean,] + [prevLos = boolean,] + [contRadar = boolean] + } + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + allyTeam + number + + + +
    3. +
  3. + losTypes + number or table + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitLosState(unitID, allyTeam, los) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + allyTeam + number + + + +
    3. +
  3. + los + number or table + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitCloak(unitID, cloak, cloakArg) +

+

+
+

+ + + If the 2nd argument is a number, the value works like this: + 1:=normal cloak + 2:=for free cloak (cost no E) + 3:=for free + no decloaking (except the unit is stunned) + 4:=ultimative cloak (no ecost, no decloaking, no stunned decloak) + + The decloak distance is only changed: + - if the 3th argument is a number or a boolean. + - if the boolean is false it takes the default decloak distance for that unitdef, + - if the boolean is true it takes the absolute value of it. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + cloak + bool or number + + + +
    3. +
  3. + cloakArg + bool or number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitStealth(unitID, stealth) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + stealth + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitSonarStealth(unitID, sonarStealth) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + sonarStealth + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitSeismicSignature(unitID, seismicSignature) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + seismicSignature + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitAlwaysVisible(unitID, alwaysVisible) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + alwaysVisible + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitUseAirLos(unitID, useAirLos) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + useAirLos + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitMetalExtraction(unitID, depth[, range]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + depth + number + corresponds to metal extraction rate +
    3. +
  3. + range + number + similar to "extractsMetal" in unitDefs. + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitHarvestStorage(unitID, metal) +

+

See also harvestStorage UnitDef tag.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + metal + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitBuildParams(unitID, paramName, bool) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + paramName + string + one of buildRange|buildDistance|buildRange3D +
    3. +
  3. + bool + number + value bool when paramName is buildRange3D, number otherwise +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitBuildSpeed(builderID, buildSpeed[, repairSpeed[, reclaimSpeed[, captureSpeed[, terraformSpeed]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + builderID + number + + + +
    2. +
  2. + buildSpeed + number + + + +
    3. +
  3. + repairSpeed + number + + + + (optional) +
    4. +
  4. + reclaimSpeed + number + + + + (optional) +
    5. +
  5. + captureSpeed + number + + + + (optional) +
    6. +
  6. + terraformSpeed + number + + + + (optional) +
    7. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitNanoPieces(builderID, pieces) +

+

+
+

+ + + This saves a lot of engine calls, by replacing: function script.QueryNanoPiece() return currentpiece end + Use it! + +

+ + +

Parameters:

+
    +
  1. + builderID + number + + + +
    2. +
  2. + pieces + table + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitBlocking(unitID, isblocking, isSolidObjectCollidable, isProjectileCollidable, isRaySegmentCollidable, crushable, blockEnemyPushing, blockHeightChanges) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + isblocking + bool + + + +
    3. +
  3. + isSolidObjectCollidable + bool + + + +
    4. +
  4. + isProjectileCollidable + bool + + + +
    5. +
  5. + isRaySegmentCollidable + bool + + + +
    6. +
  6. + crushable + bool + + + +
    7. +
  7. + blockEnemyPushing + bool + + + +
    8. +
  8. + blockHeightChanges + bool + + + +
    9. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitCrashing(unitID, crashing) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + crashing + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetUnitShieldState(unitID[, weaponID=-1[, enabled[, power]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponID + number + + + + (default -1) +
    3. +
  3. + enabled + bool + + + + (optional) +
    4. +
  4. + power + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitShieldRechargeDelay(unitID[, weaponID[, rechargeTime]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponID + number + (optional if the unit only has one shield) + (optional) +
    3. +
  3. + rechargeTime + number + (in seconds; emulates a regular hit if nil) + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitFlanking(unitID, type, arg1[, y[, z]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + type + string + "dir"|"minDamage"|"maxDamage"|"moveFactor"|"mode" +
    3. +
  3. + arg1 + number + x|minDamage|maxDamage|moveFactor|mode +
    4. +
  4. + y + number + only when type is "dir" + (optional) +
    5. +
  5. + z + number + only when type is "dir" + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitPhysicalStateBit(unitID, Physical) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + Physical + number + state bit +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.GetUnitPhysicalState(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + Unit's PhysicalState bitmask
    2. +
+ + + +
+

+ Spring.SetUnitNeutral(unitID, neutral) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + neutral + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or bool + setNeutral
    2. +
+ + + +
+

+ Spring.SetUnitTarget(unitID[, enemyUnitID[, dgun=false[, userTarget=false[, weaponNum=-1]]]]) +

+

Defines a unit's target.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + enemyUnitID + number + when nil drops the units current target. + (optional) +
    3. +
  3. + dgun + bool + + + + (default false) +
    4. +
  4. + userTarget + bool + + + + (default false) +
    5. +
  5. + weaponNum + number + + + + (default -1) +
    6. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetUnitTarget(unitID[, x[, y[, z[, dgun=false[, userTarget=false[, weaponNum=-1]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + x + number + when nil or not passed it will drop target and ignore other parameters + (optional) +
    3. +
  3. + y + number + + + + (optional) +
    4. +
  4. + z + number + + + + (optional) +
    5. +
  5. + dgun + bool + + + + (default false) +
    6. +
  6. + userTarget + bool + + + + (default false) +
    7. +
  7. + weaponNum + number + + + + (default -1) +
    8. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetUnitMidAndAimPos(unitID, mpX, mpY, mpZ, apX, apY, apZ[, relative=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + mpX + number + new middle positionX of unit +
    3. +
  3. + mpY + number + new middle positionY of unit +
    4. +
  4. + mpZ + number + new middle positionZ of unit +
    5. +
  5. + apX + number + new positionX that enemies aim at on this unit +
    6. +
  6. + apY + number + new positionY that enemies aim at on this unit +
    7. +
  7. + apZ + number + new positionZ that enemies aim at on this unit +
    8. +
  8. + relative + bool + are the new coordinates relative to world (false) or unit (true) coordinates? Also, note that apy is inverted! + (default false) +
    9. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetUnitRadiusAndHeight(unitID, radius, height) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + radius + number + + + +
    3. +
  3. + height + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetUnitBuildeeRadius(unitID, build) +

+

+
+

+ + Sets the unit's radius for when targeted by build, repair, reclaim-type commands. +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + build + number + radius for when targeted by build, repair, reclaim-type commands. +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitPieceParent(unitID, AlteredPiece, ParentPiece) +

+

Changes the pieces hierarchy of a unit by attaching a piece to a new parent.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + AlteredPiece + number + + + +
    3. +
  3. + ParentPiece + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitPieceMatrix(unitID, pieceNum, matrix) +

+

Sets the local (i.e.

+
+

+ parent-relative) matrix of the given piece. + + + If any of the first three elements are non-zero, and also blocks all script animations from modifying it until {0, 0, 0} is passed. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + pieceNum + number + + + +
    3. +
  3. + matrix + {number,...} + an array of 16 floats +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitCollisionVolumeData(unitID, scaleX, scaleY, scaleZ, offsetX, offsetY, offsetZ, vType, tType, Axis) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + scaleX + number + + + +
    3. +
  3. + scaleY + number + + + +
    4. +
  4. + scaleZ + number + + + +
    5. +
  5. + offsetX + number + + + +
    6. +
  6. + offsetY + number + + + +
    7. +
  7. + offsetZ + number + + + +
    8. +
  8. + vType + number + + + +
    9. +
  9. + tType + number + + + +
    10. +
  10. + Axis + number + + + +
    11. +
+ +

Returns:

+
    +
  1. + nil + + + +

    enum COLVOL_TYPES {

    +
      COLVOL_TYPE_DISABLED = -1,
+  COLVOL_TYPE_ELLIPSOID = 0,
+  COLVOL_TYPE_CYLINDER,
+  COLVOL_TYPE_BOX,
+  COLVOL_TYPE_SPHERE,
+  COLVOL_NUM_TYPES       // number of non-disabled collision volume types
+};
+enum COLVOL_TESTS {
+  COLVOL_TEST_DISC = 0,
+  COLVOL_TEST_CONT = 1,
+  COLVOL_NUM_TESTS = 2   // number of tests
+};
+enum COLVOL_AXES {
+  COLVOL_AXIS_X   = 0,
+  COLVOL_AXIS_Y   = 1,
+  COLVOL_AXIS_Z   = 2,
+  COLVOL_NUM_AXES = 3    // number of collision volume axes
+};
+
    +
    2. +
+ + + +
+

+ Spring.SetUnitPieceCollisionVolumeData(unitID, pieceIndex, enable, scaleX, scaleY, scaleZ, offsetX, offsetY, offsetZ[, volumeType[, primaryAxis]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
  3. + enable + bool + + + +
    4. +
  4. + scaleX + number + + + +
    5. +
  5. + scaleY + number + + + +
    6. +
  6. + scaleZ + number + + + +
    7. +
  7. + offsetX + number + + + +
    8. +
  8. + offsetY + number + + + +
    9. +
  9. + offsetZ + number + + + +
    10. +
  10. + volumeType + number + + + + (optional) +
    11. +
  11. + primaryAxis + number + + + + (optional) +
    12. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitPieceVisible(unitID, pieceIndex, visible) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
  3. + visible + bool + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitSensorRadius(unitID, type, radius) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + type + string + "los" | "airLos" | "radar" | "sonar" | "seismic" | "radarJammer" | "sonarJammer" +
    3. +
  3. + radius + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil or number + newRadius
    2. +
+ + + +
+

+ Spring.SetUnitPosErrorParams(unitID, posErrorVectorX, posErrorVectorY, posErrorVectorZ, posErrorDeltaX, posErrorDeltaY, posErrorDeltaZ[, nextPosErrorUpdate]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + posErrorVectorX + number + + + +
    3. +
  3. + posErrorVectorY + number + + + +
    4. +
  4. + posErrorVectorZ + number + + + +
    5. +
  5. + posErrorDeltaX + number + + + +
    6. +
  6. + posErrorDeltaY + number + + + +
    7. +
  7. + posErrorDeltaZ + number + + + +
    8. +
  8. + nextPosErrorUpdate + number + + + + (optional) +
    9. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitMoveGoal(unitID, goalX, goalY, goalZ[, goalRadius[, moveSpeed[, moveRaw]]]) +

+

Used by default commands to get in build-, attackrange etc.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + goalX + number + + + +
    3. +
  3. + goalY + number + + + +
    4. +
  4. + goalZ + number + + + +
    5. +
  5. + goalRadius + number + + + + (optional) +
    6. +
  6. + moveSpeed + number + + + + (optional) +
    7. +
  7. + moveRaw + bool + + + + (optional) +
    8. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitLandGoal(unitID, goalX, goalY, goalZ[, goalRadius]) +

+

Used in conjunction with Spring.UnitAttach et al.

+
+

+ to re-implement old airbase & fuel system in Lua. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + goalX + number + + + +
    3. +
  3. + goalY + number + + + +
    4. +
  4. + goalZ + number + + + +
    5. +
  5. + goalRadius + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ClearUnitGoal(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitPhysics(unitID, posX, posY, posZ, velX, velY, velZ, rotX, rotY, rotZ, dragX, dragY, dragZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + posX + number + + + +
    3. +
  3. + posY + number + + + +
    4. +
  4. + posZ + number + + + +
    5. +
  5. + velX + number + + + +
    6. +
  6. + velY + number + + + +
    7. +
  7. + velZ + number + + + +
    8. +
  8. + rotX + number + + + +
    9. +
  9. + rotY + number + + + +
    10. +
  10. + rotZ + number + + + +
    11. +
  11. + dragX + number + + + +
    12. +
  12. + dragY + number + + + +
    13. +
  13. + dragZ + number + + + +
    14. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitMass(unitID, mass) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + mass + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitPosition(unitID, x, z[, floating=false]) +

+

Set unit position (2D)

+
+

+ + + Sets a unit's position in 2D, at terrain height. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + x + number + + + +
    3. +
  3. + z + number + + + +
    4. +
  4. + floating + bool + If true, over water the position is on surface. If false, on seafloor. + (default false) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitPosition(unitID, x, y, z) +

+

Set unit position (3D)

+
+

+ + + Sets a unit's position in 3D, at an arbitrary height. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + x + number + + + +
    3. +
  3. + y + number + + + +
    4. +
  4. + z + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitRotation(unitID, yaw, pitch, roll) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + yaw + number + + + +
    3. +
  3. + pitch + number + + + +
    4. +
  4. + roll + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitDirection(unitID, x, y, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + x + number + + + +
    3. +
  3. + y + number + + + +
    4. +
  4. + z + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitHeadingAndUpDir(unitID, heading, upx, upy, upz) +

+

+
+

+ + Use this call to set up unit direction in a robust way. Heading (-32768 to 32767) represents a 2D (xz plane) unit orientation if unit was completely upright, new {upx,upy,upz} direction will be used as new "up" vector, the rotation set by "heading" will remain preserved. +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + heading + number + + + +
    3. +
  3. + upx + number + + + +
    4. +
  4. + upy + number + + + +
    5. +
  5. + upz + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitVelocity(unitID, velX, velY, velZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + velX + number + + + +
    3. +
  3. + velY + number + + + +
    4. +
  4. + velZ + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFactoryBuggerOff(unitID[, buggerOff[, offset[, radius[, relHeading[, spherical[, forced]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + buggerOff + bool + + + + (optional) +
    3. +
  3. + offset + number + + + + (optional) +
    4. +
  4. + radius + number + + + + (optional) +
    5. +
  5. + relHeading + number + + + + (optional) +
    6. +
  6. + spherical + bool + + + + (optional) +
    7. +
  7. + forced + bool + + + + (optional) +
    8. +
+ +

Returns:

+
    +
  1. + nil or number + buggerOff
    2. +
+ + + +
+

+ Spring.BuggerOff(x, y[, z], radius, teamID[, spherical=true[, forced=true[, excludeUnitID[, excludeUnitDefIDs]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + uses ground height when unspecified + (optional) +
    4. +
  4. + radius + number + + + +
    5. +
  5. + teamID + number + + + +
    6. +
  6. + spherical + bool + + + + (default true) +
    7. +
  7. + forced + bool + + + + (default true) +
    8. +
  8. + excludeUnitID + number + + + + (optional) +
    9. +
  9. + excludeUnitDefIDs + {[number],...} + + + + (optional) +
    10. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddUnitDamage(unitID, damage[, paralyze=0[, attackerID=-1[, weaponID=-1[, impulseX[, impulseY[, impulseZ]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + damage + number + + + +
    3. +
  3. + paralyze + number + equals to the paralyzetime in the WeaponDef. + (default 0) +
    4. +
  4. + attackerID + number + + + + (default -1) +
    5. +
  5. + weaponID + number + + + + (default -1) +
    6. +
  6. + impulseX + number + + + + (optional) +
    7. +
  7. + impulseY + number + + + + (optional) +
    8. +
  8. + impulseZ + number + + + + (optional) +
    9. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddUnitImpulse(unitID, x, y, z[, decayRate]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + x + number + + + +
    3. +
  3. + y + number + + + +
    4. +
  4. + z + number + + + +
    5. +
  5. + decayRate + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddUnitSeismicPing(unitID, pindSize) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + pindSize + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddUnitResource(unitID, resource, amount) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + resource + string + "m" | "e" +
    3. +
  3. + amount + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.UseUnitResource(unitID, resource, amount) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + resource + string + "m" | "e" +
    3. +
  3. + amount + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil or bool + okay
    2. +
+ + + +
+

+ Spring.UseUnitResource(unitID, resources) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + resources + {[string]=number,...} + where keys are one of "m"|"metal"|"e"|"energy" and values are amounts +
    3. +
+ +

Returns:

+
    +
  1. + nil or bool + okay
    2. +
+ + + +
+

+ Decals +

+ +

+ +

+

+

+ Spring.AddObjectDecal(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.RemoveObjectDecal(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Grass +

+ +

+ +

+

+

+ Spring.AddGrass(x, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.RemoveGrass(x, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Feature Handling +

+ +

+ +

+

+

+ Spring.CreateFeature(featureDef, x, y, z[, heading[, AllyTeamID[, featureID]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureDef + string or number + name or id +
    2. +
  2. + x + number + + + +
    3. +
  3. + y + number + + + +
    4. +
  4. + z + number + + + +
    5. +
  5. + heading + number + + + + (optional) +
    6. +
  6. + AllyTeamID + number + + + + (optional) +
    7. +
  7. + featureID + number + + + + (optional) +
    8. +
+ +

Returns:

+
    +
  1. + number + featureID
    2. +
+ + + +
+

+ Spring.DestroyFeature(featureDefID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureDefID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.TransferFeature(featureDefID, teamID) +

+

Feature Control

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureDefID + number + + + +
    2. +
  2. + teamID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureAlwaysVisible(featureID, enable) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + enable + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureUseAirLos(featureID, useAirLos) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + useAirLos + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureHealth(featureID, health) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + health + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureMaxHealth(featureID, maxHealth) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + maxHealth + number + minimum 0.1 +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureReclaim(featureID, reclaimLeft) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + reclaimLeft + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureResources(featureID, metal, energy[, reclaimTime[, reclaimLeft[, featureDefMetal[, featureDefEnergy]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + metal + number + + + +
    3. +
  3. + energy + number + + + +
    4. +
  4. + reclaimTime + number + + + + (optional) +
    5. +
  5. + reclaimLeft + number + + + + (optional) +
    6. +
  6. + featureDefMetal + number + + + + (optional) +
    7. +
  7. + featureDefEnergy + number + + + + (optional) +
    8. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureResurrect(featureID, unitDef[, facing[, progress]]) +

+

+
+

+ + + Second param can now be a number id instead of a string name, this also allows cancelling ressurection by passing -1. + The level of progress can now be set via the additional 4th param. + Possible values for facing are: + "south" | "s" | 0 + "east" | "e" | 1 + "north" | "n" | 2 + "west" | "w" | 3 + +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + unitDef + string or number + id or name +
    3. +
  3. + facing + string or number + + + + (optional) +
    4. +
  4. + progress + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureMoveCtrl(featureID[, enable[, arg1[, arg2[, argn]]]]) +

+

+
+

+ + + Use this callout to control feature movement. The arg* arguments are parsed as follows and all optional: + + If enable is true: + [, velVector(x,y,z) * initial velocity for feature + [, accVector(x,y,z) * acceleration added every frame]] + + If enable is false: + [, velocityMask(x,y,z) * dimensions in which velocity is allowed to build when not using MoveCtrl + [, impulseMask(x,y,z) * dimensions in which impulse is allowed to apply when not using MoveCtrl + [, movementMask(x,y,z) * dimensions in which feature is allowed to move when not using MoveCtrl]]] + + It is necessary to unlock feature movement on x,z axis before changing feature physics. + + For example use `Spring.SetFeatureMoveCtrl(featureID,false,1,1,1,1,1,1,1,1,1)` to unlock all movement prior to making `Spring.SetFeatureVelocity` calls. + +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + enable + bool + + + + (optional) +
    3. +
  3. + arg1 + number + + + + (optional) +
    4. +
  4. + arg2 + number + + + + (optional) +
    5. +
  5. + argn + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeaturePhysics(featureID, posX, posY, posZ, velX, velY, velZ, rotX, rotY, rotZ, dragX, dragY, dragZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + posX + number + + + +
    3. +
  3. + posY + number + + + +
    4. +
  4. + posZ + number + + + +
    5. +
  5. + velX + number + + + +
    6. +
  6. + velY + number + + + +
    7. +
  7. + velZ + number + + + +
    8. +
  8. + rotX + number + + + +
    9. +
  9. + rotY + number + + + +
    10. +
  10. + rotZ + number + + + +
    11. +
  11. + dragX + number + + + +
    12. +
  12. + dragY + number + + + +
    13. +
  13. + dragZ + number + + + +
    14. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureMass(featureID, mass) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + mass + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeaturePosition(featureID, x, y, z[, snapToGround]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + x + number + + + +
    3. +
  3. + y + number + + + +
    4. +
  4. + z + number + + + +
    5. +
  5. + snapToGround + bool + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureRotation(featureID, rotX, rotY, rotZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + rotX + number + + + +
    3. +
  3. + rotY + number + + + +
    4. +
  4. + rotZ + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureDirection(featureID, dirX, dirY, dirZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + dirX + number + + + +
    3. +
  3. + dirY + number + + + +
    4. +
  4. + dirZ + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureHeadingAndUpDir(featureID, heading, upx, upy, upz) +

+

+
+

+ + Use this call to set up feature direction in a robust way. Heading (-32768 to 32767) represents a 2D (xz plane) feature orientation if feature was completely upright, new {upx,upy,upz} direction will be used as new "up" vector, the rotation set by "heading" will remain preserved. +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + heading + number + + + +
    3. +
  3. + upx + number + + + +
    4. +
  4. + upy + number + + + +
    5. +
  5. + upz + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureVelocity(featureID, velX, velY, velZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + velX + number + + + +
    3. +
  3. + velY + number + + + +
    4. +
  4. + velZ + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureBlocking(featureID, isBlocking, isSolidObjectCollidable, isProjectileCollidable, isRaySegmentCollidable, crushable, blockEnemyPushing, blockHeightChanges) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + isBlocking + bool + + + +
    3. +
  3. + isSolidObjectCollidable + bool + + + +
    4. +
  4. + isProjectileCollidable + bool + + + +
    5. +
  5. + isRaySegmentCollidable + bool + + + +
    6. +
  6. + crushable + bool + + + +
    7. +
  7. + blockEnemyPushing + bool + + + +
    8. +
  8. + blockHeightChanges + bool + + + +
    9. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureNoSelect(featureID, noSelect) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + noSelect + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureMidAndAimPos(featureID, mpX, mpY, mpZ, apX, apY, apZ[, relative]) +

+

+
+

+ + + Check `Spring.SetUnitMidAndAimPos` for further explanation of the arguments. + +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + mpX + number + + + +
    3. +
  3. + mpY + number + + + +
    4. +
  4. + mpZ + number + + + +
    5. +
  5. + apX + number + + + +
    6. +
  6. + apY + number + + + +
    7. +
  7. + apZ + number + + + +
    8. +
  8. + relative + bool + + + + (optional) +
    9. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetFeatureRadiusAndHeight(featureID, radius, height) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + radius + number + + + +
    3. +
  3. + height + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetFeatureCollisionVolumeData(featureID, scaleX, scaleY, scaleZ, offsetX, offsetY, offsetZ, vType, tType, Axis) +

+

+
+

+ + + Check `Spring.SetUnitCollisionVolumeData` for further explanation of the arguments. + +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + scaleX + number + + + +
    3. +
  3. + scaleY + number + + + +
    4. +
  4. + scaleZ + number + + + +
    5. +
  5. + offsetX + number + + + +
    6. +
  6. + offsetY + number + + + +
    7. +
  7. + offsetZ + number + + + +
    8. +
  8. + vType + number + + + +
    9. +
  9. + tType + number + + + +
    10. +
  10. + Axis + number + + + +
    11. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeaturePieceCollisionVolumeData(featureID, pieceIndex, enable, scaleX, scaleY, scaleZ, offsetX, offsetY, offsetZ, Axis, volumeType[, primaryAxis]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
  3. + enable + bool + + + +
    4. +
  4. + scaleX + number + + + +
    5. +
  5. + scaleY + number + + + +
    6. +
  6. + scaleZ + number + + + +
    7. +
  7. + offsetX + number + + + +
    8. +
  8. + offsetY + number + + + +
    9. +
  9. + offsetZ + number + + + +
    10. +
  10. + Axis + number + + + +
    11. +
  11. + volumeType + number + + + +
    12. +
  12. + primaryAxis + number + + + + (optional) +
    13. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeaturePieceVisible(featureID, pieceIndex, visible) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
  3. + visible + bool + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Projectiles +

+ +

+ +

+

+

+ projectileParams +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. pos + + +
      +
    • + x + number + + + +
      • +
    • + y + number + + + +
      • +
    • + z + number + + + +
      • +
    +
  2. end + + +
      +
    • + x + number + + + +
      • +
    • + y + number + + + +
      • +
    • + z + number + + + +
      • +
    +
  3. speed + + +
      +
    • + x + number + + + +
      • +
    • + y + number + + + +
      • +
    • + z + number + + + +
      • +
    +
  4. spread + + +
      +
    • + x + number + + + +
      • +
    • + y + number + + + +
      • +
    • + z + number + + + +
      • +
    +
  5. error + + +
      +
    • + x + number + + + +
      • +
    • + y + number + + + +
      • +
    • + z + number + + + +
      • +
    +
  6. + owner + number + + + +
    7. +
  7. + team + number + + + +
    8. +
  8. + ttl + number + + + +
    9. +
  9. + gravity + number + + + +
    10. +
  10. + tracking + number + + + +
    11. +
  11. + maxRange + number + + + +
    12. +
  12. + startAlpha + number + + + +
    13. +
  13. + endAlpha + number + + + +
    14. +
  14. + model + string + + + +
    15. +
  15. + cegTag + string + + + +
    16. +
+ + + + +
+

+ Spring.SetProjectileAlwaysVisible(projectileID, alwaysVisible) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + alwaysVisible + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectileUseAirLos(projectileID, useAirLos) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + useAirLos + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectileMoveControl(projectileID, enable) +

+

Disables engine movecontrol, so lua can fully control the physics.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + enable + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectilePosition(projectileID[, posX=0[, posY=0[, posZ=0]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + posX + number + + + + (default 0) +
    3. +
  3. + posY + number + + + + (default 0) +
    4. +
  4. + posZ + number + + + + (default 0) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectileVelocity(projectileID[, velX=0[, velY=0[, velZ=0]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + velX + number + + + + (default 0) +
    3. +
  3. + velY + number + + + + (default 0) +
    4. +
  4. + velZ + number + + + + (default 0) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectileCollision(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectileTarget(projectileID[, arg1=0[, arg2=0[, posZ=0]]]) +

+

+
+

+ + + targetTypeStr can be one of: + 'u' - unit + 'f' - feature + 'p' - projectile + while targetTypeInt is one of: + string.byte('g') := GROUND + string.byte('u') := UNIT + string.byte('f') := FEATURE + string.byte('p') := PROJECTILE + +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + arg1 + number + targetID or posX + (default 0) +
    3. +
  3. + arg2 + number + targetType or posY + (default 0) +
    4. +
  4. + posZ + number + + + + (default 0) +
    5. +
+ +

Returns:

+
    +
  1. + nil or bool + validTarget
    2. +
+ + + +
+

+ Spring.SetProjectileIsIntercepted(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectileDamages(unitID, weaponNum, key, value) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponNum + number + + + +
    3. +
  3. + key + string + + + +
    4. +
  4. + value + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectileIgnoreTrackingError(projectileID, ignore) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + ignore + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetProjectileGravity(projectileID[, grav=0]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + grav + number + + + + (default 0) +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetPieceProjectileParams(projectileID[, explosionFlags[, spinAngle[, spinSpeed[, spinVectorX[, spinVectorY[, spinVectorZ]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + explosionFlags + number + + + + (optional) +
    3. +
  3. + spinAngle + number + + + + (optional) +
    4. +
  4. + spinSpeed + number + + + + (optional) +
    5. +
  5. + spinVectorX + number + + + + (optional) +
    6. +
  6. + spinVectorY + number + + + + (optional) +
    7. +
  7. + spinVectorZ + number + + + + (optional) +
    8. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Give Order +

+ +

Options can also be a bitmask; e.g. 0 instead of an empty table (can avoid performance hit on table creation) + See Constants.CMD for relevant constants.

+

+ cmdOpts +

+

Command Options params

+
+

+ +

+ + +

Fields:

+
    +
  1. + right + bool + Right mouse key pressed +
    2. +
  2. + alt + bool + Alt key pressed +
    3. +
  3. + ctrl + bool + Ctrl key pressed +
    4. +
  4. + shift + bool + Shift key pressed +
    5. +
+ + + + +
+

+ cmdSpec +

+

Command spec

+
+

+ + + Used when assigning multiple commands at once + +

+ + +

Fields:

+
    +
  1. + cmdID + number + + + +
    2. +
  2. + params + {number,...} + + + +
    3. +
  3. + options + cmdOpts + + + +
    4. +
+ + + + +
+

+ Spring.UnitFinishCommand(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.GiveOrderToUnit(unitID, cmdID, params, options) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + cmdID + number + + + +
    3. +
  3. + params + {number,...} + + + +
    4. +
  4. + options + cmdOpts + + + +
    5. +
+ +

Returns:

+
    +
  1. + bool + unitOrdered
    2. +
+ + + +
+

+ Spring.GiveOrderToUnitMap(unitMap, cmdID, params, options) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitMap + {[number]=table,...} + table with unitIDs as keys +
    2. +
  2. + cmdID + number + + + +
    3. +
  3. + params + {number,...} + + + +
    4. +
  4. + options + cmdOpts + + + +
    5. +
+ +

Returns:

+
    +
  1. + number + unitsOrdered
    2. +
+ + + +
+

+ Spring.GiveOrderToUnitArray(unitIDs, cmdID, params, options) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitIDs + {number,...} + + + +
    2. +
  2. + cmdID + number + + + +
    3. +
  3. + params + {number,...} + + + +
    4. +
  4. + options + cmdOpts + + + +
    5. +
+ +

Returns:

+
    +
  1. + number + unitsOrdered
    2. +
+ + + +
+

+ Spring.GiveOrderArrayToUnit(unitID, cmdArray) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + cmdArray + {cmdSpec,...} + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + ordersGiven
    2. +
+ + + +
+

+ Spring.GiveOrderArrayToUnitMap(unitMap, orderArray) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitMap + {[number]=table} + table with unitIDs as keys +
    2. +
  2. + orderArray + {cmdSpec,...} + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + unitsOrdered
    2. +
+ + + +
+

+ Spring.GiveOrderArrayToUnitArray(unitArray, orderArray) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitArray + {number,...} + containing unitIDs +
    2. +
  2. + orderArray + {cmdSpec,...} + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Heightmap +

+ +

+ +

Note that x & z coords are in worldspace (Game.mapSizeX/Z), still the heightmap resolution is Game.squareSize.

+
+

+

+ Spring.LevelHeightMap(x1, z1, x2_height[, z2[, height]]) +

+

Set a certain height to a point or rectangle area on the world

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + z1 + number + + + +
    3. +
  3. + x2_height + number + if y2 and height are nil then this parameter is the height +
    4. +
  4. + z2 + number + + + + (optional) +
    5. +
  5. + height + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AdjustHeightMap(x1, y1, x2_height[, y2[, height]]) +

+

Add a certain height to a point or rectangle area on the world

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + y1 + number + + + +
    3. +
  3. + x2_height + number + if y2 and height are nil then this parameter is the height +
    4. +
  4. + y2 + number + + + + (optional) +
    5. +
  5. + height + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.RevertHeightMap(x1, y1, x2_factor[, y2[, factor]]) +

+

Restore original map height to a point or rectangle area on the world

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + y1 + number + + + +
    3. +
  3. + x2_factor + number + if y2 and factor are nil then this parameter is the factor +
    4. +
  4. + y2 + number + + + + (optional) +
    5. +
  5. + factor + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddHeightMap(x, z, height) +

+

Can only be called in `Spring.SetHeightMapFunc`

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + height + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil or number + newHeight
    2. +
+ + + +
+

+ Spring.SetHeightMap(x, z, height[, terraform=1]) +

+

+
+

+ + + Can only be called in `Spring.SetHeightMapFunc`. The terraform argument is + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + height + number + + + +
    4. +
  4. + terraform + number + a scaling factor. + (default 1) +
    5. +
+ +

Returns:

+
    +
  1. + nil or number + absHeightDiff =0 nothing will be changed (the terraform starts) and if =1 the terraform will be finished.
    2. +
+ + + +
+

+ Spring.SetHeightMapFunc(lua_function[, arg1[, arg2[, argn]]]) +

+

+
+

+ + + Example code: + + function Spring.SetHeightMapFunc(function() + for z=0,Game.mapSizeZ, Game.squareSize do + for x=0,Game.mapSizeX, Game.squareSize do + Spring.SetHeightMap( x, z, 200 + 20 * math.cos((x + z) / 90) ) + end + end + end) + +

+ + +

Parameters:

+
    +
  1. + lua_function + func + + + +
    2. +
  2. + arg1 + + + + (optional) +
    3. +
  3. + arg2 + + + + (optional) +
    4. +
  4. + argn + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil or number + absTotalHeightMapAmountChanged
    2. +
+ + + +
+

+ Height Map/Smooth Mesh +

+ +

+ +

+

+

+ Spring.LevelOriginalHeightMap(x1, y1, x2_height[, y2[, height]]) +

+

Set a height to a point or rectangle area to the original map height cache

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + y1 + number + + + +
    3. +
  3. + x2_height + number + if y2 and height are nil then this parameter is the height +
    4. +
  4. + y2 + number + + + + (optional) +
    5. +
  5. + height + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AdjustOriginalHeightMap(x1, y1, x2_height[, y2[, height]]) +

+

Add height to a point or rectangle area to the original map height cache

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + y1 + number + + + +
    3. +
  3. + x2_height + number + if y2 and height are nil then this parameter is the height +
    4. +
  4. + y2 + number + + + + (optional) +
    5. +
  5. + height + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.RevertOriginalHeightMap(x1, y1, x2_factor[, y2[, factor]]) +

+

Restore original map height cache to a point or rectangle area on the world

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + y1 + number + + + +
    3. +
  3. + x2_factor + number + if y2 and factor are nil then this parameter is the factor +
    4. +
  4. + y2 + number + + + + (optional) +
    5. +
  5. + factor + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddOriginalHeightMap(x, y, height) +

+

+
+

+ + + Can only be called in `Spring.SetOriginalHeightMapFunc` + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + height + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetOriginalHeightMap(x, y, height[, factor]) +

+

+
+

+ + + Can only be called in `Spring.SetOriginalHeightMapFunc` + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + height + number + + + +
    4. +
  4. + factor + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetOriginalHeightMapFunc(heightMapFunc) +

+

+
+

+ + + Cannot recurse on itself + +

+ + +

Parameters:

+
    +
  1. + heightMapFunc + func + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.RebuildSmoothMesh() +

+

+
+

+ + + Heightmap changes normally take up to 25s to propagate to the smooth mesh. + Use to force a mapwide update immediately. + +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.LevelSmoothMesh(x1, z1[, x2][, z2], height) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + z1 + number + + + +
    3. +
  3. + x2 + number + + + + (optional) +
    4. +
  4. + z2 + number + + + + (optional) +
    5. +
  5. + height + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AdjustSmoothMesh(x1, z1[, x2][, z2], height) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + z1 + number + + + +
    3. +
  3. + x2 + number + + + + (optional) +
    4. +
  4. + z2 + number + + + + (optional) +
    5. +
  5. + height + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.RevertSmoothMesh(x1, z1[, x2][, z2], origFactor) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + z1 + number + + + +
    3. +
  3. + x2 + number + + + + (optional) +
    4. +
  4. + z2 + number + + + + (optional) +
    5. +
  5. + origFactor + number + + + +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddSmoothMesh(x, z, height) +

+

Can only be called in `Spring.SetSmoothMeshFunc`.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + height + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil or number + newHeight
    2. +
+ + + +
+

+ Spring.SetSmoothMesh(x, z, height[, terraform=1]) +

+

Can only be called in `Spring.SetSmoothMeshFunc`.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + height + number + + + +
    4. +
  4. + terraform + number + + + + (default 1) +
    5. +
+ +

Returns:

+
    +
  1. + nil or number + absHeightDiff
    2. +
+ + + +
+

+ Spring.SetSmoothMeshFunc(lua_function, arg1, arg2, argn) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + lua_function + func + + + +
    2. +
  2. + arg1 + [opt] +
    3. +
  3. + arg2 + [opt] +
    4. +
  4. + argn + [opt] +
    5. +
+ +

Returns:

+
    +
  1. + nil or number + absTotalHeightMapAmountChanged
    2. +
+ + + +
+

+ TerrainTypes +

+ +

+ +

+

+

+ Spring.SetMapSquareTerrainType(x, z, newType) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + newType + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil or number + oldType
    2. +
+ + + +
+

+ Spring.SetTerrainTypeData(typeIndex[, speedTanks=nil[, speedKBOts=nil[, speedHovers=nil[, speedShips=nil]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + typeIndex + number + + + +
    2. +
  2. + speedTanks + number + + + + (default nil) +
    3. +
  3. + speedKBOts + number + + + + (default nil) +
    4. +
  4. + speedHovers + number + + + + (default nil) +
    5. +
  5. + speedShips + number + + + + (default nil) +
    6. +
+ +

Returns:

+
    +
  1. + nil or bool + true
    2. +
+ + + +
+

+ Spring.SetSquareBuildingMask(x, z, mask) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + mask + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + See also buildingMask unitdef tag.
    2. +
+ + + +
+

+ Spring.UnitWeaponFire(unitID, weaponID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ForceUnitCollisionUpdate(unitID) +

+

Prevent collision checks from working on outdated data + + There's a rare edge case that requires units to be in specific positions + and being shot by specific weapons but which can result in shots ghosting + through the unit.

+
+

+ This is because the unit's collision volume is stale. + The `movement.unitQuadPositionUpdateRate` modrule controls this behaviour + and can guarantee 100% correctness if set to 1, but the default value is 3 + and large-scale games generally don't want to set it so low. This function + lets you guarantee success for important weapons regardless of how high + the normal update rate is set. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.UnitAttach(transporterID, passengerID, pieceNum) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + transporterID + number + + + +
    2. +
  2. + passengerID + number + + + +
    3. +
  3. + pieceNum + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.UnitDetach(passengerID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + passengerID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.UnitDetachFromAir(passengerID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + passengerID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitLoadingTransport(passengerID, transportID) +

+

Disables collisions between the two units to allow colvol intersection during the approach.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + passengerID + number + + + +
    2. +
  2. + transportID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SpawnProjectile(weaponDefID, projectileParams) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + weaponDefID + number + + + +
    2. +
  2. + projectileParams + projectileParams + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + projectileID
    2. +
+ + + +
+

+ Spring.DeleteProjectile(projectileID) +

+

Silently removes projectiles (no explosion).

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ explosionParams +

+

Parameters for explosion + + Please note the explosion defaults to 1 damage regardless of what it's defined in the weaponDef.

+
+

+ + The weapondefID is only used for visuals and for passing into callins like UnitDamaged. + +

+ + +

Fields:

+
    +
  1. + weaponDef + number + + + +
    2. +
  2. + owner + number + + + +
    3. +
  3. + hitUnit + number + + + +
    4. +
  4. + hitFeature + number + + + +
    5. +
  5. + craterAreaOfEffect + number + + + +
    6. +
  6. + damageAreaOfEffect + number + + + +
    7. +
  7. + edgeEffectiveness + number + + + +
    8. +
  8. + explosionSpeed + number + + + +
    9. +
  9. + gfxMod + number + + + +
    10. +
  10. + impactOnly + bool + + + +
    11. +
  11. + ignoreOwner + bool + + + +
    12. +
  12. + damageGround + bool + + + +
    13. +
+ + + + +
+

+ Spring.SpawnExplosion([posX=0][, posY=0][, posZ=0][, dirX=0][, dirY=0][, dirZ=0], explosionParams) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + posX + number + + + + (default 0) +
    2. +
  2. + posY + number + + + + (default 0) +
    3. +
  3. + posZ + number + + + + (default 0) +
    4. +
  4. + dirX + number + + + + (default 0) +
    5. +
  5. + dirY + number + + + + (default 0) +
    6. +
  6. + dirZ + number + + + + (default 0) +
    7. +
  7. + explosionParams + explosionParams + + + +
    8. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SpawnCEG(cegname[, posX=0[, posY=0[, posZ=0[, dirX=0[, dirY=0[, dirZ=0[, radius=0[, damage=0]]]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cegname + string + + + +
    2. +
  2. + posX + number + + + + (default 0) +
    3. +
  3. + posY + number + + + + (default 0) +
    4. +
  4. + posZ + number + + + + (default 0) +
    5. +
  5. + dirX + number + + + + (default 0) +
    6. +
  6. + dirY + number + + + + (default 0) +
    7. +
  7. + dirZ + number + + + + (default 0) +
    8. +
  8. + radius + number + + + + (default 0) +
    9. +
  9. + damage + number + + + + (default 0) +
    10. +
+ +

Returns:

+
    +
  1. + nil or bool + success
    2. +
  2. + number + cegID
    3. +
+ + + +
+

+ Spring.SpawnSFX([unitID=0[, sfxID=0[, posX=0[, posY=0[, posZ=0[, dirX=0[, dirY=0[, dirZ=0[, radius=0[, damage=0[, absolute]]]]]]]]]]]) +

+

Equal to the UnitScript versions of EmitSFX, but takes position and direction arguments (in either unit- or piece-space) instead of a piece index.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + + (default 0) +
    2. +
  2. + sfxID + number + + + + (default 0) +
    3. +
  3. + posX + number + + + + (default 0) +
    4. +
  4. + posY + number + + + + (default 0) +
    5. +
  5. + posZ + number + + + + (default 0) +
    6. +
  6. + dirX + number + + + + (default 0) +
    7. +
  7. + dirY + number + + + + (default 0) +
    8. +
  8. + dirZ + number + + + + (default 0) +
    9. +
  9. + radius + number + + + + (default 0) +
    10. +
  10. + damage + number + + + + (default 0) +
    11. +
  11. + absolute + bool + + + + (optional) +
    12. +
+ +

Returns:

+
    +
  1. + nil or bool + success
    2. +
+ + + +
+

+ Other +

+ +

+ +

+

+

+ Spring.SetNoPause(noPause) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + noPause + bool + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetExperienceGrade(expGrade[, ExpPowerScale[, ExpHealthScale[, ExpReloadScale]]]) +

+

Defines how often `Callins.UnitExperience` will be called.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + expGrade + number + + + +
    2. +
  2. + ExpPowerScale + number + + + + (optional) +
    3. +
  3. + ExpHealthScale + number + + + + (optional) +
    4. +
  4. + ExpReloadScale + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetRadarErrorParams(allyTeamID, allyteamErrorSize[, baseErrorSize[, baseErrorMult]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyTeamID + number + + + +
    2. +
  2. + allyteamErrorSize + number + + + +
    3. +
  3. + baseErrorSize + number + + + + (optional) +
    4. +
  4. + baseErrorMult + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Command Descriptions +

+ +

+ +

Doesn't work in unsynced code!

+
+

+

+ Spring.EditUnitCmdDesc(unitID, cmdDescID, cmdArray) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + cmdDescID + number + + + +
    3. +
  3. + cmdArray + table + +

    structure of cmdArray:

    +
     {
+   [ id          = int ],
+   [ type        = int ],
+   [ name        = string ],
+   [ action      = string ],
+   [ tooltip     = string ],
+   [ texture     = string ],
+   [ cursor      = string ],
+   [ queueing    = boolean ],
+   [ hidden      = boolean ],
+   [ disabled    = boolean ],
+   [ showUnique  = boolean ],
+   [ onlyTexture = boolean ],
+   [ params      = { string = string, ... } ]
+ }
+
    + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.InsertUnitCmdDesc(unitID[, cmdDescID], cmdArray) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + cmdDescID + number + + + + (optional) +
    3. +
  3. + cmdArray + table + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.RemoveUnitCmdDesc(unitID[, cmdDescID]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + cmdDescID + number + + + + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/SyncedRead.html b/ldoc/modules/SyncedRead.html new file mode 100644 index 0000000000..5b71e1ed1a --- /dev/null +++ b/ldoc/modules/SyncedRead.html @@ -0,0 +1,11348 @@ +--- +layout: default +title: SyncedRead +permalink: ldoc/modules/SyncedRead.html +description: Synced Read +parent: Lua API +table: 0x55953a528b20 +--- + +{% raw %} +

Module SyncedRead

+

Synced Read

+

+ +

+

+

See also:

+ + +

Teams

+
+
+ Spring.GetGaiaTeamID +
+
+ + + +
+
+ Spring.GetAllyTeamStartBox +
+
+ + + +
+
+ Spring.GetTeamStartPosition +
+
+ + + +
+
+ xyz +
+
+ Cartesian triple (XYZ) +
+
+ Spring.GetMapStartPositions +
+
+ + + +
+
+ Spring.GetAllyTeamList +
+
+ + + +
+
+ Spring.GetTeamList +
+
+ + + +
+
+ Spring.GetPlayerList +
+
+ + + +
+
+ Spring.GetTeamInfo +
+
+ + + +
+
+ Spring.GetTeamAllyTeamID +
+
+ + + +
+
+ Spring.GetTeamResources +
+
+ + + +
+
+ Spring.GetTeamUnitStats +
+
+ + + +
+
+ Spring.GetTeamResourceStats +
+
+ + + +
+
+ Spring.GetTeamDamageStats +
+
+ Gets team damage dealt/received totals +
+
+ teamStats +
+
+ + + +
+
+ Spring.GetTeamStatsHistory +
+
+ + + +
+
+ Spring.GetTeamLuaAI +
+
+ + + +
+
+ Spring.GetTeamMaxUnits +
+
+ Returns a team's unit cap. +
+
+ Spring.GetPlayerInfo +
+
+ + + +
+
+ Spring.GetPlayerControlledUnit +
+
+ Returns unit controlled by player on FPS mode +
+
+ Spring.GetAIInfo +
+
+ + + +
+
+ Spring.GetAllyTeamInfo +
+
+ + + +
+
+ Spring.AreTeamsAllied +
+
+ + + +
+
+ Spring.ArePlayersAllied +
+
+ + + +
+
+

Misc

+
+
+ Spring.GetUnitEstimatedPath +
+
+ + + +
+
+ Spring.GetUnitLastAttacker +
+
+ + + +
+
+ Spring.GetUnitLastAttackedPiece +
+
+ + + +
+
+ Spring.GetUnitCollisionVolumeData +
+
+ + + +
+
+ Spring.GetUnitSeparation +
+
+ + + +
+
+ Spring.GetUnitFeatureSeparation +
+
+ + + +
+
+ Spring.GetUnitDefDimensions +
+
+ + + +
+
+ Spring.GetCEGID +
+
+ + + +
+
+ Spring.GetUnitBlocking +
+
+ + + +
+
+ Spring.GetUnitMoveTypeData +
+
+ + + +
+
+ Spring.GetUnitCurrentCommand +
+
+ + + +
+
+ cmdOpts +
+
+ Parameters for command options +
+
+ cmd +
+
+ Command +
+
+ Spring.GetUnitCommands +
+
+ Get the number or list of commands for a unit +
+
+ Spring.GetFactoryCommands +
+
+ Get the number or list of commands for a factory +
+
+ Spring.GetFactoryBuggerOff +
+
+ + + +
+
+ Spring.GetFactoryCounts +
+
+ Gets the build queue of a factory +
+
+ Spring.GetCommandQueue +
+
+ Get the number or list of commands for a unit +
+
+ Spring.GetFullBuildQueue +
+
+ Returns the build queue +
+
+ Spring.GetRealBuildQueue +
+
+ Returns the build queue cleaned of things the unit can't build itself +
+
+ Spring.GetUnitCmdDescs +
+
+ + + +
+
+ Spring.FindUnitCmdDesc +
+
+ + + +
+
+ Spring.ValidFeatureID +
+
+ + + +
+
+ Spring.GetAllFeatures +
+
+ + + +
+
+ Spring.GetFeatureDefID +
+
+ + + +
+
+ Spring.GetFeatureTeam +
+
+ + + +
+
+ Spring.GetFeatureAllyTeam +
+
+ + + +
+
+ Spring.GetFeatureHealth +
+
+ + + +
+
+ Spring.GetFeatureHeight +
+
+ + + +
+
+ Spring.GetFeatureRadius +
+
+ + + +
+
+ Spring.GetFeatureMass +
+
+ + + +
+
+ Spring.GetFeaturePosition +
+
+ + + +
+
+ Spring.GetFeatureSeparation +
+
+ + + +
+
+ Spring.GetFeatureRotation +
+
+ + + +
+
+ Spring.GetFeatureDirection +
+
+ + + +
+
+ Spring.GetFeatureVelocity +
+
+ + + +
+
+ Spring.GetFeatureHeading +
+
+ + + +
+
+ Spring.GetFeatureResources +
+
+ + + +
+
+ Spring.GetFeatureBlocking +
+
+ + + +
+
+ Spring.GetFeatureNoSelect +
+
+ + + +
+
+ Spring.GetFeatureResurrect +
+
+ + + +
+
+ Spring.GetFeatureLastAttackedPiece +
+
+ + + +
+
+ Spring.GetFeatureCollisionVolumeData +
+
+ + + +
+
+ Spring.GetFeaturePieceCollisionVolumeData +
+
+ + + +
+
+ Spring.GetRadarErrorParams +
+
+ + + +
+
+

Game States

+
+
+ Spring.IsCheatingEnabled +
+
+ + + +
+
+ Spring.IsGodModeEnabled +
+
+ + + +
+
+ Spring.IsDevLuaEnabled +
+
+ + + +
+
+ Spring.IsEditDefsEnabled +
+
+ + + +
+
+ Spring.IsNoCostEnabled +
+
+ + + +
+
+ Spring.GetGlobalLos +
+
+ + + +
+
+ Spring.AreHelperAIsEnabled +
+
+ + + +
+
+ Spring.FixedAllies +
+
+ + + +
+
+ Spring.IsGameOver +
+
+ + + +
+
+

Speed/Time

+
+
+ Spring.GetGameFrame +
+
+ + + +
+
+ Spring.GetGameSeconds +
+
+ + + +
+
+

Environment

+
+
+ Spring.GetTidal +
+
+ + + +
+
+ Spring.GetWind +
+
+ + + +
+
+

Rules/Params

+
+
+ Spring.GetGameRulesParams +
+
+ + + +
+
+ Spring.GetTeamRulesParams +
+
+ + + +
+
+ Spring.GetPlayerRulesParams +
+
+ + + +
+
+ Spring.GetUnitRulesParams +
+
+ + + +
+
+ Spring.GetFeatureRulesParams +
+
+ + + +
+
+ Spring.GetGameRulesParam +
+
+ + + +
+
+ Spring.GetTeamRulesParam +
+
+ + + +
+
+ Spring.GetPlayerRulesParam +
+
+ + + +
+
+ Spring.GetUnitRulesParam +
+
+ + + +
+
+ Spring.GetFeatureRulesParam +
+
+ + + +
+
+

Mod and Map options

+
+
+ Spring.GetMapOption +
+
+ + + +
+
+ Spring.GetMapOptions +
+
+ + + +
+
+ Spring.GetModOption +
+
+ + + +
+
+ Spring.GetModOptions +
+
+ + + +
+
+

Vectors

+
+
+ Spring.GetHeadingFromVector +
+
+ + + +
+
+ Spring.GetVectorFromHeading +
+
+ + + +
+
+ Spring.GetFacingFromHeading +
+
+ + + +
+
+ Spring.GetHeadingFromFacing +
+
+ + + +
+
+

Sides and Factions

+
+
+ sideSpec +
+
+ Side spec +
+
+ Spring.GetSideData +
+
+ + + +
+
+ Spring.GetSideData +
+
+ + + +
+
+ Spring.GetSideData +
+
+ + + +
+
+

Unit queries

+
+
+ Spring.GetAllUnits +
+
+ Get a list of all unitIDs +
+
+ Spring.GetTeamUnits +
+
+ + + +
+
+ Spring.GetTeamUnitsSorted +
+
+ + + +
+
+ Spring.GetTeamUnitsCounts +
+
+ + + +
+
+ Spring.GetTeamUnitsByDefs +
+
+ + + +
+
+ Spring.GetTeamUnitDefCount +
+
+ + + +
+
+ Spring.GetTeamUnitCount +
+
+ + + +
+
+

Spatial unit queries

+
+
+ Spring.GetUnitsInRectangle +
+
+ + + +
+
+ Spring.GetUnitsInBox +
+
+ + + +
+
+ Spring.GetUnitsInCylinder +
+
+ + + +
+
+ Spring.GetUnitsInSphere +
+
+ + + +
+
+ planeSpec +
+
+ + + +
+
+ Spring.GetUnitsInPlanes +
+
+ + + +
+
+ Spring.GetUnitArrayCentroid +
+
+ Returns the centroid of an array of units +
+
+ Spring.GetUnitMapCentroid +
+
+ Returns the centroid of a map of units +
+
+ Spring.GetUnitNearestAlly +
+
+ + + +
+
+ Spring.GetUnitNearestEnemy +
+
+ + + +
+
+

Spatial feature queries

+
+
+ Spring.GetFeaturesInRectangle +
+
+ + + +
+
+ Spring.GetFeaturesInSphere +
+
+ + + +
+
+ Spring.GetFeaturesInCylinder +
+
+ + + +
+
+ Spring.GetProjectilesInRectangle +
+
+ + + +
+
+

Unit state

+
+
+ Spring.ValidUnitID +
+
+ + + +
+
+ unitState +
+
+ + + +
+
+ Spring.GetUnitStates +
+
+ + + +
+
+ Spring.GetUnitArmored +
+
+ + + +
+
+ Spring.GetUnitIsActive +
+
+ + + +
+
+ Spring.GetUnitIsCloaked +
+
+ + + +
+
+ Spring.GetUnitSeismicSignature +
+
+ + + +
+
+ Spring.GetUnitSelfDTime +
+
+ + + +
+
+ Spring.GetUnitStockpile +
+
+ + + +
+
+ Spring.GetUnitSensorRadius +
+
+ + + +
+
+ Spring.GetUnitPosErrorParams +
+
+ + + +
+
+ Spring.GetUnitTooltip +
+
+ + + +
+
+ Spring.GetUnitDefID +
+
+ + + +
+
+ Spring.GetUnitTeam +
+
+ + + +
+
+ Spring.GetUnitAllyTeam +
+
+ + + +
+
+ Spring.GetUnitNeutral +
+
+ Checks if a unit is neutral (NOT Gaia!) +
+
+ Spring.GetUnitHealth +
+
+ + + +
+
+ Spring.GetUnitIsDead +
+
+ + + +
+
+ Spring.GetUnitIsStunned +
+
+ Checks whether a unit is disabled and can't act

+ +

The first return value is a simple OR of the following ones, + any of those conditions is sufficient to disable the unit. +

+
+ Spring.GetUnitIsBeingBuilt +
+
+ + + +
+
+ Spring.GetUnitResources +
+
+ + + +
+
+ Spring.GetUnitCosts +
+
+ + + +
+
+ Spring.GetUnitCostTable +
+
+ + + +
+
+ Spring.GetUnitMetalExtraction +
+
+ + + +
+
+ Spring.GetUnitExperience +
+
+ + + +
+
+ Spring.GetUnitHeight +
+
+ + + +
+
+ Spring.GetUnitRadius +
+
+ + + +
+
+ Spring.GetUnitBuildeeRadius +
+
+ + + +
+
+ Spring.GetUnitMass +
+
+ + + +
+
+ Spring.GetUnitPosition +
+
+ + + +
+
+ Spring.GetUnitBasePosition +
+
+ + + +
+
+ Spring.GetUnitVectors +
+
+ + + +
+
+ Spring.GetUnitRotation +
+
+ + + +
+
+ Spring.GetUnitDirection +
+
+ + + +
+
+ Spring.GetUnitHeading +
+
+ + + +
+
+ Spring.GetUnitVelocity +
+
+ + + +
+
+ Spring.GetUnitBuildFacing +
+
+ + + +
+
+ Spring.GetUnitIsBuilding +
+
+ Checks whether a unit is currently building another (NOT for checking if it's a structure) +
+
+ Spring.GetUnitWorkerTask +
+
+ Checks a builder's current task +
+
+ Spring.GetUnitEffectiveBuildRange +
+
+ + + +
+
+ Spring.GetUnitCurrentBuildPower +
+
+ + + +
+
+ Spring.GetUnitHarvestStorage +
+
+ Get a unit's carried resources +
+
+ Spring.GetUnitBuildParams +
+
+ + + +
+
+ Spring.GetUnitInBuildStance +
+
+ Is builder in build stance +
+
+ Spring.GetUnitNanoPieces +
+
+ Get construction FX attachment points +
+
+ Spring.GetUnitTransporter +
+
+ Get the transport carrying the unit +
+
+ Spring.GetUnitIsTransporting +
+
+ Get units being transported +
+
+ Spring.GetUnitShieldState +
+
+ + + +
+
+ Spring.GetUnitFlanking +
+
+ + + +
+
+ Spring.GetUnitMaxRange +
+
+ Get a unit's engagement range +
+
+

Unit weapon state

+
+
+ Spring.GetUnitWeaponState +
+
+ Check the state of a unit's weapon +
+
+ Spring.GetUnitWeaponDamages +
+
+ + + +
+
+ Spring.GetUnitWeaponVectors +
+
+ + + +
+
+ Spring.GetUnitWeaponTryTarget +
+
+ + + +
+
+ Spring.GetUnitWeaponTestTarget +
+
+ + + +
+
+ Spring.GetUnitWeaponTestRange +
+
+ + + +
+
+ Spring.GetUnitWeaponHaveFreeLineOfFire +
+
+ + + +
+
+ Spring.GetUnitWeaponCanFire +
+
+ + + +
+
+ Spring.GetUnitWeaponTarget +
+
+ Checks a weapon's target +
+
+

Projectile state

+
+
+ Spring.GetProjectilePosition +
+
+ + + +
+
+ Spring.GetProjectileDirection +
+
+ + + +
+
+ Spring.GetProjectileVelocity +
+
+ + + +
+
+ Spring.GetProjectileGravity +
+
+ + + +
+
+ Spring.GetPieceProjectileParams +
+
+ + + +
+
+ Spring.GetProjectileTarget +
+
+ + + +
+
+ Spring.GetProjectileIsIntercepted +
+
+ + + +
+
+ Spring.GetProjectileTimeToLive +
+
+ + + +
+
+ Spring.GetProjectileOwnerID +
+
+ + + +
+
+ Spring.GetProjectileTeamID +
+
+ + + +
+
+ Spring.GetProjectileAllyTeamID +
+
+ + + +
+
+ Spring.GetProjectileType +
+
+ + + +
+
+ Spring.GetProjectileDefID +
+
+ + + +
+
+ Spring.GetProjectileDamages +
+
+ + + +
+
+

Ground

+
+
+ Spring.IsPosInMap +
+
+ + + +
+
+ Spring.GetGroundHeight +
+
+ Get ground height +
+
+ Spring.GetWaterPlaneLevel +
+
+ Get water plane height

+ +

Water may at some point become shaped (rivers etc) but for now it is always a flat plane. +

+
+ Spring.GetWaterLevel +
+
+ Get water level in a specific position

+ +

Water is currently a flat plane, so this returns the same value regardless of XZ. +

+
+ Spring.GetGroundOrigHeight +
+
+ Get ground height as it was at game start +
+
+ Spring.GetGroundNormal +
+
+ + + +
+
+ Spring.GetGroundInfo +
+
+ + + +
+
+ Spring.GetGroundBlocked +
+
+ + + +
+
+ Spring.GetGroundExtremes +
+
+ + + +
+
+ Spring.GetTerrainTypeData +
+
+ + + +
+
+ Spring.GetGrass +
+
+ + + +
+
+ Spring.GetSmoothMeshHeight +
+
+ + + +
+
+

Tests

+
+
+ Spring.TestMoveOrder +
+
+ + + +
+
+ Spring.TestBuildOrder +
+
+ + + +
+
+ Spring.Pos2BuildPos +
+
+ Snaps a position to the building grid +
+
+ Spring.ClosestBuildPos +
+
+ + + +
+
+

Visibility

+
+
+ Spring.GetPositionLosState +
+
+ + + +
+
+ Spring.IsPosInLos +
+
+ + + +
+
+ Spring.IsPosInRadar +
+
+ + + +
+
+ Spring.IsPosInAirLos +
+
+ + + +
+
+ Spring.GetUnitLosState +
+
+ + + +
+
+ Spring.IsUnitInLos +
+
+ + + +
+
+ Spring.IsUnitInAirLos +
+
+ + + +
+
+ Spring.IsUnitInRadar +
+
+ + + +
+
+ Spring.IsUnitInJammer +
+
+ + + +
+
+

Piece/Script

+
+
+ pieceSpec +
+
+ Piece spec +
+
+ Spring.GetModelRootPiece +
+
+ + + +
+
+ Spring.GetModelPieceMap +
+
+ + + +
+
+ Spring.GetModelPieceList +
+
+ + + +
+
+ Spring.GetUnitRootPiece +
+
+ + + +
+
+ Spring.GetUnitPieceMap +
+
+ + + +
+
+ Spring.GetUnitPieceList +
+
+ + + +
+
+ Spring.GetUnitPieceInfo +
+
+ + + +
+
+ Spring.GetUnitPiecePosDir +
+
+ + + +
+
+ Spring.GetUnitPiecePosition +
+
+ + + +
+
+ Spring.GetUnitPieceDirection +
+
+ + + +
+
+ Spring.GetUnitPieceMatrix +
+
+ + + +
+
+ Spring.GetFeatureRootPiece +
+
+ + + +
+
+ Spring.GetFeaturePieceMap +
+
+ + + +
+
+ Spring.GetFeaturePieceList +
+
+ + + +
+
+ Spring.GetFeaturePieceInfo +
+
+ + + +
+
+ Spring.GetFeaturePiecePosDir +
+
+ + + +
+
+ Spring.GetFeaturePiecePosition +
+
+ + + +
+
+ Spring.GetFeaturePieceDirection +
+
+ + + +
+
+ Spring.GetFeaturePieceMatrix +
+
+ + + +
+
+ Spring.GetUnitScriptPiece +
+
+ + + +
+
+ Spring.GetUnitScriptNames +
+
+ + + +
+
+ +

+ Teams +

+ +

+ +

+

+

+ Spring.GetGaiaTeamID() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + teamID
    2. +
+ + + +
+

+ Spring.GetAllyTeamStartBox(allyID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + xMin
    2. +
  2. + number + zMin
    3. +
  3. + number + xMax
    4. +
  4. + number + zMax
    5. +
+ + + +
+

+ Spring.GetTeamStartPosition(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + x
    2. +
  2. + number + y
    3. +
  3. + number + x
    4. +
+ + + +
+

+ xyz +

+

Cartesian triple (XYZ)

+
+

+ +

+ + +

Fields:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
+ + + + +
+

+ Spring.GetMapStartPositions() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {xyz,...} + array of positions indexed by teamID
    2. +
+ + + +
+

+ Spring.GetAllyTeamList() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {number,...} + list of allyTeamIDs
    2. +
+ + + +
+

+ Spring.GetTeamList([allyTeamID=-1]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyTeamID + number + to filter teams belonging to when >= 0 + (default -1) +
    2. +
+ +

Returns:

+
    +
  1. + nil or {number,...} + list of teamIDs
    2. +
+ + + +
+

+ Spring.GetPlayerList([teamID=-1[, active=false]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + to filter by when >= 0 + (default -1) +
    2. +
  2. + active + bool + whether to filter only active teams + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + nil or {number,...} + list of playerIDs
    2. +
+ + + +
+

+ Spring.GetTeamInfo(teamID[, getTeamKeys=true]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + getTeamKeys + bool + whether to return the customTeamKeys table + (default true) +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + teamID
    2. +
  2. + number + leader
    3. +
  3. + number + isDead
    4. +
  4. + number + hasAI
    5. +
  5. + string + side
    6. +
  6. + number + allyTeam
    7. +
  7. + number + incomeMultiplier
    8. +
  8. + {[string]=string,...} + customTeamKeys when getTeamKeys is true, otherwise nil
    9. +
+ + + +
+

+ Spring.GetTeamAllyTeamID(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or allyTeamID + + +
    2. +
+ + + +
+

+ Spring.GetTeamResources(teamID, resource) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + resource + string + one of "m(etal)?|e(nergy)?" +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + currentLevel
    2. +
  2. + number + storage
    3. +
  3. + number + pull
    4. +
  4. + number + income
    5. +
  5. + number + expense
    6. +
  6. + number + share
    7. +
  7. + number + sent
    8. +
  8. + number + received
    9. +
+ + + +
+

+ Spring.GetTeamUnitStats(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + killed
    2. +
  2. + number + died
    3. +
  3. + number + capturedBy
    4. +
  4. + number + capturedFrom
    5. +
  5. + number + received
    6. +
  6. + number + sent
    7. +
+ + + +
+

+ Spring.GetTeamResourceStats(teamID, resource) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + resource + string + one of "m(etal)?|e(nergy)?" +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + used
    2. +
  2. + number + produced
    3. +
  3. + number + excessed
    4. +
  4. + number + received
    5. +
  5. + number + sent
    6. +
+ + + +
+

+ Spring.GetTeamDamageStats(teamID) +

+

Gets team damage dealt/received totals

+
+

+ + + Returns a team's damage stats. Note that all damage is counted, + including self-inflicted and unconfirmed out-of-sight. + +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + damageDealt
    2. +
  2. + number + damageReceived
    3. +
+ + + +
+

+ teamStats +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + time + number + + + +
    2. +
  2. + frame + number + + + +
    3. +
  3. + metalUsed + number + + + +
    4. +
  4. + metalProduced + number + + + +
    5. +
  5. + metalExcess + number + + + +
    6. +
  6. + metalReceived + number + + + +
    7. +
  7. + metalSent + number + + + +
    8. +
  8. + energyUsed + number + + + +
    9. +
  9. + energyProduced + number + + + +
    10. +
  10. + energyExcess + number + + + +
    11. +
  11. + energyReceived + number + + + +
    12. +
  12. + energySent + number + + + +
    13. +
  13. + damageDealt + number + + + +
    14. +
  14. + damageReceived + number + + + +
    15. +
  15. + unitsProduced + number + + + +
    16. +
  16. + unitsDied + number + + + +
    17. +
  17. + unitsReceived + number + + + +
    18. +
  18. + unitsSent + number + + + +
    19. +
  19. + unitsCaptured + number + + + +
    20. +
  20. + unitsOutCaptured + number + + + +
    21. +
+ + + + +
+

+ Spring.GetTeamStatsHistory(teamID[, startIndex[, endIndex=startIndex]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + startIndex + number + when not specified return the number of history entries + (optional) +
    3. +
  3. + endIndex + number + + + + (default startIndex) +
    4. +
+ +

Returns:

+
    +
  1. + nil, number or {teamStats,...} + + +
    2. +
+ + + +
+

+ Spring.GetTeamLuaAI(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + string + + +
    2. +
+ + + +
+

+ Spring.GetTeamMaxUnits(teamID) +

+

Returns a team's unit cap.

+
+

+ + + Also returns the current unit count for readable teams as the 2nd value. + +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + maxUnits
    2. +
  2. + nil or number + currentUnits
    3. +
+ + + +
+

+ Spring.GetPlayerInfo(playerID[, getPlayerOpts=true]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + getPlayerOpts + bool + whether to return custom player options + (default true) +
    3. +
+ +

Returns:

+
    +
  1. + nil or string + name
    2. +
  2. + bool + active
    3. +
  3. + bool + spectator
    4. +
  4. + number + teamID
    5. +
  5. + number + allyTeamID
    6. +
  6. + number + pingTime
    7. +
  7. + number + cpuUsage
    8. +
  8. + string + country
    9. +
  9. + number + rank
    10. +
  10. + bool + hasSkirmishAIsInTeam
    11. +
  11. + {[string]=string} + playerOpts when playerOpts is true
    12. +
  12. + bool + desynced
    13. +
+ + + +
+

+ Spring.GetPlayerControlledUnit(playerID) +

+

Returns unit controlled by player on FPS mode

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetAIInfo(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + skirmishAIID
    2. +
  2. + string + name
    3. +
  3. + number + hostingPlayerID
    4. +
  4. + string + shortName when synced "SYNCED_NOSHORTNAME", otherwise the AI shortname or "UNKNOWN"
    5. +
  5. + string + version when synced "SYNCED_NOVERSION", otherwise the AI version or "UNKNOWN"
    6. +
  6. + {[string]=string,...} + options
    7. +
+ + + +
+

+ Spring.GetAllyTeamInfo(allyTeamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyTeamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[string]=string,...} + + +
    2. +
+ + + +
+

+ Spring.AreTeamsAllied(teamID1, teamID2) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID1 + number + + + +
    2. +
  2. + teamID2 + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Spring.ArePlayersAllied(playerID1, playerID2) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID1 + number + + + +
    2. +
  2. + playerID2 + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Misc +

+ +

+ +

+

+

+ Spring.GetUnitEstimatedPath(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitLastAttacker(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitLastAttackedPiece(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitCollisionVolumeData(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitSeparation(unitID1, unitID2[, direction=false[, subtractRadii=false]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID1 + number + + + +
    2. +
  2. + unitID2 + number + + + +
    3. +
  3. + direction + bool + to subtract from, default unitID1 - unitID2 + (default false) +
    4. +
  4. + subtractRadii + bool + whether units radii should be subtracted from the total + (default false) +
    5. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitFeatureSeparation(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitDefDimensions(unitDefID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetCEGID() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.GetUnitBlocking(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + isBlocking
    2. +
  2. + bool + isSolidObjectCollidable
    3. +
  3. + bool + isProjectileCollidable
    4. +
  4. + bool + isRaySegmentCollidable
    5. +
  5. + bool + crushable
    6. +
  6. + bool + blockEnemyPushing
    7. +
  7. + bool + blockHeightChanges
    8. +
+ + + +
+

+ Spring.GetUnitMoveTypeData(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitCurrentCommand() +

+

+
+

+ +

+ + + + + + +
+

+ cmdOpts +

+

Parameters for command options

+
+

+ +

+ + +

Fields:

+
    +
  1. + coded + number + + + +
    2. +
  2. + alt + bool + + + +
    3. +
  3. + ctrl + bool + + + +
    4. +
  4. + shift + bool + + + +
    5. +
  5. + right + bool + + + +
    6. +
  6. + meta + bool + + + +
    7. +
  7. + internal + bool + + + +
    8. +
+ + + + +
+

+ cmd +

+

Command

+
+

+ +

+ + +

Fields:

+
    +
  1. + id + number + + + +
    2. +
  2. + params + {number,...} + + + +
    3. +
  3. + options + cmdOpts + + + +
    4. +
  4. + tag + number + + + +
    5. +
+ + + + +
+

+ Spring.GetUnitCommands(unitID, count) +

+

Get the number or list of commands for a unit

+
+

+ + + Same as Spring.GetCommandQueue + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + count + number + when 0 returns the number of commands in the units queue, when -1 returns all commands, number of commands to return otherwise +
    3. +
+ +

Returns:

+
    +
  1. + number or {cmd,...} + commands
    2. +
+ + + +
+

+ Spring.GetFactoryCommands(unitID, count) +

+

Get the number or list of commands for a factory

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + count + number + when 0 returns the number of commands in the units queue, when -1 returns all commands, number of commands to return otherwise +
    3. +
+ +

Returns:

+
    +
  1. + number or {cmd,...} + commands
    2. +
+ + + +
+

+ Spring.GetFactoryBuggerOff(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetFactoryCounts(unitID[, count=-1[, addCmds=false]]) +

+

Gets the build queue of a factory

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + count + number + then number of commands to retrieve, when -1 all + (default -1) +
    3. +
  3. + addCmds + bool + if commands other than buildunit are retrieved + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + nil or {{[number]=number,...}} + counts indexed by unitDefID or -cmdID
    2. +
+ + + +
+

+ Spring.GetCommandQueue(unitID, count) +

+

Get the number or list of commands for a unit

+
+

+ + + Same as Spring.GetUnitCommands + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + count + number + when 0 returns the number of commands in the units queue, when -1 returns all commands, number of commands to return otherwise +
    3. +
+ +

Returns:

+
    +
  1. + number or {cmd,...} + commands
    2. +
+ + + +
+

+ Spring.GetFullBuildQueue(unitID) +

+

Returns the build queue

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[number]=number,...} + buildqueue indexed by unitDefID with count values
    2. +
+ + + +
+

+ Spring.GetRealBuildQueue(unitID) +

+

Returns the build queue cleaned of things the unit can't build itself

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[number]=number,...} + buildqueue indexed by unitDefID with count values
    2. +
+ + + +
+

+ Spring.GetUnitCmdDescs(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.FindUnitCmdDesc(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.ValidFeatureID(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ Spring.GetAllFeatures() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.GetFeatureDefID(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetFeatureTeam(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetFeatureAllyTeam(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetFeatureHealth(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + health
    2. +
  2. + number + defHealth
    3. +
  3. + number + resurrectProgress
    4. +
+ + + +
+

+ Spring.GetFeatureHeight(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetFeatureRadius(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetFeatureMass(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetFeaturePosition(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetFeatureSeparation(featureID1, featureID2[, direction=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID1 + number + + + +
    2. +
  2. + featureID2 + number + + + +
    3. +
  3. + direction + bool + to subtract from, default featureID1 - featureID2 + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetFeatureRotation(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + pitch, rotation in X axis
    2. +
  2. + number + yaw, rotation in Y axis
    3. +
  3. + number + roll, rotation in Z axis
    4. +
+ + + +
+

+ Spring.GetFeatureDirection(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or dirX + + +
    2. +
  2. + dirY + + +
    3. +
  3. + dirZ + + +
    4. +
+ + + +
+

+ Spring.GetFeatureVelocity(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetFeatureHeading(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetFeatureResources(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + metal
    2. +
  2. + number + defMetal
    3. +
  3. + number + energy
    4. +
  4. + number + defEnergy
    5. +
  5. + number + reclaimLeft
    6. +
  6. + number + reclaimTime
    7. +
+ + + +
+

+ Spring.GetFeatureBlocking(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + isBlocking
    2. +
  2. + bool + isSolidObjectCollidable
    3. +
  3. + bool + isProjectileCollidable
    4. +
  4. + bool + isRaySegmentCollidable
    5. +
  5. + bool + crushable
    6. +
  6. + bool + blockEnemyPushing
    7. +
  7. + bool + blockHeightChanges
    8. +
+ + + +
+

+ Spring.GetFeatureNoSelect(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Spring.GetFeatureResurrect(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetFeatureLastAttackedPiece(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetFeatureCollisionVolumeData(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetFeaturePieceCollisionVolumeData(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetRadarErrorParams(allyTeamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyTeamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + radarErrorSize actual radar error size (when allyTeamID is allied to current team) or base radar error size
    2. +
  2. + number + baseRadarErrorSize
    3. +
  3. + number + baseRadarErrorMult
    4. +
+ + + +
+

+ Game States +

+ +

+ +

+

+

+ Spring.IsCheatingEnabled() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + enabled
    2. +
+ + + +
+

+ Spring.IsGodModeEnabled() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + enabled
    2. +
+ + + +
+

+ Spring.IsDevLuaEnabled() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + enabled
    2. +
+ + + +
+

+ Spring.IsEditDefsEnabled() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + enabled
    2. +
+ + + +
+

+ Spring.IsNoCostEnabled() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + enabled
    2. +
+ + + +
+

+ Spring.GetGlobalLos([teamID]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + + (optional) +
    2. +
+ +

Returns:

+
    +
  1. + bool + enabled
    2. +
+ + + +
+

+ Spring.AreHelperAIsEnabled() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + enabled
    2. +
+ + + +
+

+ Spring.FixedAllies() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool or nil + enabled
    2. +
+ + + +
+

+ Spring.IsGameOver() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + isGameOver
    2. +
+ + + +
+

+ Speed/Time +

+ +

+ +

+

+

+ Spring.GetGameFrame() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + t1 frameNum % dayFrames
    2. +
  2. + number + t2 frameNum / dayFrames
    3. +
+ + + +
+

+ Spring.GetGameSeconds() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + seconds
    2. +
+ + + +
+

+ Environment +

+ +

+ +

+

+

+ Spring.GetTidal() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + tidalStrength
    2. +
+ + + +
+

+ Spring.GetWind() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + windStrength
    2. +
+ + + +
+

+ Rules/Params +

+ +

+ + +

The following functions allow to save data per game, team and unit. + The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!)

+
+

+

+ Spring.GetGameRulesParams() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[string] + = number,...} rulesParams map with rules names as key and values as values
    2. +
+ + + +
+

+ Spring.GetTeamRulesParams(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {[string] + = number,...} rulesParams map with rules names as key and values as values
    2. +
+ + + +
+

+ Spring.GetPlayerRulesParams(playerID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {[string] + = number,...} rulesParams map with rules names as key and values as values
    2. +
+ + + +
+

+ Spring.GetUnitRulesParams(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {[string] + = number,...} rulesParams map with rules names as key and values as values
    2. +
+ + + +
+

+ Spring.GetFeatureRulesParams(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {[string] + = number,...} rulesParams map with rules names as key and values as values
    2. +
+ + + +
+

+ Spring.GetGameRulesParam(ruleRef) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + ruleRef + number or string + the rule index or name +
    2. +
+ +

Returns:

+
    +
  1. + nil, number or string + value
    2. +
+ + + +
+

+ Spring.GetTeamRulesParam(teamID, ruleRef) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + ruleRef + number or string + the rule index or name +
    3. +
+ +

Returns:

+
    +
  1. + nil, number or string + value
    2. +
+ + + +
+

+ Spring.GetPlayerRulesParam(playerID, ruleRef) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + ruleRef + number or string + the rule index or name +
    3. +
+ +

Returns:

+
    +
  1. + nil, number or string + value
    2. +
+ + + +
+

+ Spring.GetUnitRulesParam(unitID, ruleRef) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + ruleRef + number or string + the rule index or name +
    3. +
+ +

Returns:

+
    +
  1. + nil, number or string + value
    2. +
+ + + +
+

+ Spring.GetFeatureRulesParam(featureID, ruleRef) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + ruleRef + number or string + the rule index or name +
    3. +
+ +

Returns:

+
    +
  1. + nil, number or string + value
    2. +
+ + + +
+

+ Mod and Map options +

+ +

+ + +

Warning: boolean values are not transfered from C to Lua correctly. + For this reason the respective option has to be converted to a number + and checked accordingly via an IF statement as shown below:

+ +
 if (tonumber(Spring.GetModOptions.exampleOption) == 1) then...end
+
+ +

The following check therefore is insufficient!

+ +
 if (Spring.GetModOptions.exampleOption) then...end
+
+
+

+

+ Spring.GetMapOption(mapOption) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + mapOption + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + string + value of mapOption
    2. +
+ + + +
+

+ Spring.GetMapOptions() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[string] + = string,...} options map with options names as keys and values as values
    2. +
+ + + +
+

+ Spring.GetModOption(modOption) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + modOption + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + string + value of modOption in option map
    2. +
+ + + +
+

+ Spring.GetModOptions() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[string] + = string,...} options map with options names as keys and values as values
    2. +
+ + + +
+

+ Vectors +

+ +

+ +

+

+

+ Spring.GetHeadingFromVector(x, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + heading
    2. +
+ + + +
+

+ Spring.GetVectorFromHeading(heading) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + heading + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + x
    2. +
  2. + number + z
    3. +
+ + + +
+

+ Spring.GetFacingFromHeading(heading) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + heading + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + facing
    2. +
+ + + +
+

+ Spring.GetHeadingFromFacing(facing) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + facing + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + heading
    2. +
+ + + +
+

+ Sides and Factions +

+ +

+ +

+

+

+ sideSpec +

+

Side spec

+
+

+ + + Used when returning arrays of side specifications, is itself an array with + positional values as below: + +

+ + +

Fields:

+
    +
  1. + sideName + string + + + +
    2. +
  2. + caseName + string + + + +
    3. +
  3. + startUnit + string + + + +
    4. +
+ + + + +
+

+ Spring.GetSideData(sideName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + sideName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or string + startUnit
    2. +
  2. + string + caseSensitiveSideName
    3. +
+ + + +
+

+ Spring.GetSideData(sideID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + sideID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or string + sideName
    2. +
  2. + string + startUnit
    3. +
  3. + string + caseSensitiveSideName
    4. +
+ + + +
+

+ Spring.GetSideData() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[sideSpec],...} + sideArray
    2. +
+ + + +
+

+ Unit queries +

+ +

+ +

+

+

+ Spring.GetAllUnits() +

+

Get a list of all unitIDs

+
+

+ + + Note that when called from a widget, this also returns units that are only + radar blips. + + For units that are radar blips, you may want to check if they are in los, + as GetUnitDefID() will still return true if they have previously been seen. + +

+ + + +

Returns:

+
    +
  1. + {number,...} + unitIDs
    2. +
+ + +

See also:

+ + +
+

+ Spring.GetTeamUnits(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {number,...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetTeamUnitsSorted(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[number]={number,...}} + where keys are unitDefIDs and values are unitIDs
    2. +
+ + + +
+

+ Spring.GetTeamUnitsCounts(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[number]=number} + where keys are unitDefIDs and values are counts
    2. +
+ + + +
+

+ Spring.GetTeamUnitsByDefs(teamID, unitDefIDs) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + unitDefIDs + number or {number,...} + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or {number,...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetTeamUnitDefCount(teamID, unitDefID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + count
    2. +
+ + + +
+

+ Spring.GetTeamUnitCount(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + count
    2. +
+ + + +
+

+ Spatial unit queries +

+ +

+ + +

For the allegiance parameters: AllUnits = -1, MyUnits = -2, AllyUnits = -3, EnemyUnits = -4

+
+

+

+ Spring.GetUnitsInRectangle(xmin, zmin, xmax, zmax[, allegiance]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + xmin + number + + + +
    2. +
  2. + zmin + number + + + +
    3. +
  3. + xmax + number + + + +
    4. +
  4. + zmax + number + + + +
    5. +
  5. + allegiance + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + {number,...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetUnitsInBox(xmin, ymin, zmin, xmax, ymax, zmax[, allegiance]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + xmin + number + + + +
    2. +
  2. + ymin + number + + + +
    3. +
  3. + zmin + number + + + +
    4. +
  4. + xmax + number + + + +
    5. +
  5. + ymax + number + + + +
    6. +
  6. + zmax + number + + + +
    7. +
  7. + allegiance + number + + + + (optional) +
    8. +
+ +

Returns:

+
    +
  1. + {number,...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetUnitsInCylinder(x, z, radius) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + radius + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + {number,...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetUnitsInSphere(x, y, z, radius) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
  4. + radius + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + {number,...} + unitIDs
    2. +
+ + + +
+

+ planeSpec +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + normalVecX + number + + + +
    2. +
  2. + normalVecY + number + + + +
    3. +
  3. + normalVecZ + number + + + +
    4. +
  4. + d + number + + + +
    5. +
+ + + + +
+

+ Spring.GetUnitsInPlanes(planes[, allegiance]) +

+

+
+

+ + + Plane normals point towards accepted space, so the acceptance criteria for each plane is: + + radius = unit radius + px, py, pz = unit position + [(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0 + +

+ + +

Parameters:

+
    +
  1. + planes + {planeSpec,...} + + + +
    2. +
  2. + allegiance + number + + + + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + nil or {number,...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetUnitArrayCentroid(units) +

+

Returns the centroid of an array of units

+
+

+ Returns nil for an empty array + +

+ + +

Parameters:

+
    +
  1. + units + table + { unitID, unitID, ... } +
    2. +
+ +

Returns:

+
    +
  1. + number + centerX
    2. +
  2. + number + centerY
    3. +
  3. + number + centerZ
    4. +
+ + + +
+

+ Spring.GetUnitMapCentroid(units) +

+

Returns the centroid of a map of units

+
+

+ Returns nil for an empty map + +

+ + +

Parameters:

+
    +
  1. + units + table + { [unitID] = true, [unitID] = true, ... } +
    2. +
+ +

Returns:

+
    +
  1. + number + centerX
    2. +
  2. + number + centerY
    3. +
  3. + number + centerZ
    4. +
+ + + +
+

+ Spring.GetUnitNearestAlly(unitID[, range=1.0e9f]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + range + number + + + + (default 1.0e9f) +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + unitID
    2. +
+ + + +
+

+ Spring.GetUnitNearestEnemy(unitID[, range=1.0e9f[, useLOS=true]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + range + number + + + + (default 1.0e9f) +
    3. +
  3. + useLOS + bool + + + + (default true) +
    4. +
+ +

Returns:

+
    +
  1. + nil or number + unitID
    2. +
+ + + +
+

+ Spatial feature queries +

+ +

+ +

+

+

+ Spring.GetFeaturesInRectangle(xmin, zmin, xmax, zmax) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + xmin + number + + + +
    2. +
  2. + zmin + number + + + +
    3. +
  3. + xmax + number + + + +
    4. +
  4. + zmax + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + {number,...} + featureIDs
    2. +
+ + + +
+

+ Spring.GetFeaturesInSphere(x, y, z, radius) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
  4. + radius + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + {number,...} + featureIDs
    2. +
+ + + +
+

+ Spring.GetFeaturesInCylinder(x, z, radius[, allegiance]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + radius + number + + + +
    4. +
  4. + allegiance + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + {number,...} + featureIDs
    2. +
+ + + +
+

+ Spring.GetProjectilesInRectangle(xmin, zmin, xmax, zmax[, excludeWeaponProjectiles=false[, excludePieceProjectiles=false]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + xmin + number + + + +
    2. +
  2. + zmin + number + + + +
    3. +
  3. + xmax + number + + + +
    4. +
  4. + zmax + number + + + +
    5. +
  5. + excludeWeaponProjectiles + bool + + + + (default false) +
    6. +
  6. + excludePieceProjectiles + bool + + + + (default false) +
    7. +
+ +

Returns:

+
    +
  1. + {number,...} + projectileIDs
    2. +
+ + + +
+

+ Unit state +

+ +

+ +

+

+

+ Spring.ValidUnitID(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ unitState +

+

+
+

+ +

+ + +

Fields:

+
    +
  1. + firestate + number + + + +
    2. +
  2. + movestate + number + + + +
    3. +
  3. + repeat + bool + + + +
    4. +
  4. + cloak + bool + + + +
    5. +
  5. + active + bool + + + +
    6. +
  6. + trajectory + bool + + + +
    7. +
  7. + autoland + bool + optional +
    8. +
  8. + autorepairlevel + number + optional +
    9. +
  9. + loopbackattack + bool + optional +
    10. +
+ + + + +
+

+ Spring.GetUnitStates(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {unitState,...} + + +
    2. +
+ + + +
+

+ Spring.GetUnitArmored(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + armored
    2. +
  2. + number + armorMultiple
    3. +
+ + + +
+

+ Spring.GetUnitIsActive(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Spring.GetUnitIsCloaked(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Spring.GetUnitSeismicSignature(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitSelfDTime(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitStockpile(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + numStockpiled
    2. +
  2. + number + numStockpileQued
    3. +
  3. + number + buildPercent
    4. +
+ + + +
+

+ Spring.GetUnitSensorRadius(unitID, type) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + type + string + one of los, airLos, radar, sonar, seismic, radarJammer, sonarJammer +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + radius
    2. +
+ + + +
+

+ Spring.GetUnitPosErrorParams(unitID[, allyTeamID]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + allyTeamID + number + + + + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + posErrorVectorX
    2. +
  2. + number + posErrorVectorY
    3. +
  3. + number + posErrorVectorZ
    4. +
  4. + number + posErrorDeltaX
    5. +
  5. + number + posErrorDeltaY
    6. +
  6. + number + posErrorDeltaZ
    7. +
  7. + number + nextPosErrorUpdatebaseErrorMult
    8. +
  8. + bool + posErrorBit
    9. +
+ + + +
+

+ Spring.GetUnitTooltip(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or string + + +
    2. +
+ + + +
+

+ Spring.GetUnitDefID(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitTeam(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitAllyTeam(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitNeutral(unitID) +

+

Checks if a unit is neutral (NOT Gaia!)

+
+

+ + + Note that a "neutral" unit can belong to any ally-team (ally, enemy, Gaia). + To check if a unit is Gaia, check its owner team. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Spring.GetUnitHealth(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + health
    2. +
  2. + number + maxHealth
    3. +
  3. + number + paralyzeDamage
    4. +
  4. + number + captureProgress
    5. +
  5. + number + buildProgress between 0.0-1.0
    6. +
+ + + +
+

+ Spring.GetUnitIsDead(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Spring.GetUnitIsStunned(unitID) +

+

Checks whether a unit is disabled and can't act + + The first return value is a simple OR of the following ones, + any of those conditions is sufficient to disable the unit.

+
+

+ + + Note that EMP and being transported are mechanically the same and thus lumped together. + Use other callouts to differentiate them if you need to. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + stunnedOrBuilt unit is disabled
    2. +
  2. + bool + stunned unit is either stunned via EMP or being transported by a non-fireplatform
    3. +
  3. + bool + beingBuilt unit is under construction
    4. +
+ + + +
+

+ Spring.GetUnitIsBeingBuilt(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + bool + beingBuilt
    2. +
  2. + number + buildProgress
    3. +
+ + + +
+

+ Spring.GetUnitResources(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + metalMake
    2. +
  2. + number + metalUse
    3. +
  3. + number + energyMake
    4. +
  4. + number + energyUse
    5. +
+ + + +
+

+ Spring.GetUnitCosts(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + buildTime
    2. +
  2. + number + metalCost
    3. +
  3. + number + energyCost
    4. +
+ + + +
+

+ Spring.GetUnitCostTable(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or { + metal = number, energy = number }
    2. +
  2. + number + buildTime
    3. +
+ + + +
+

+ Spring.GetUnitMetalExtraction(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitExperience(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + XP [0.0; +∞)
    2. +
  2. + number + limXP [0.0; 1.0) as experience approaches infinity
    3. +
+ + + +
+

+ Spring.GetUnitHeight(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitRadius(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitBuildeeRadius(unitID) +

+

+
+

+ + Gets the unit's radius for when targeted by build, repair, reclaim-type commands. +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitMass(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetUnitPosition(unitID[, midPos=false[, aimPos=false]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + midPos + bool + return midpoint as well + (default false) +
    3. +
  3. + aimPos + bool + return aimpoint as well + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + nil or number + basePointX
    2. +
  2. + number + basePointY
    3. +
  3. + number + basePointZ
    4. +
  4. + nil or number + midPointX
    5. +
  5. + number + midPointY
    6. +
  6. + number + midPointZ
    7. +
  7. + nil or number + aimPointX
    8. +
  8. + number + aimPointY
    9. +
  9. + number + aimPointZ
    10. +
+ + + +
+

+ Spring.GetUnitBasePosition(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + posX
    2. +
  2. + number + posY
    3. +
  3. + number + posZ
    4. +
+ + + +
+

+ Spring.GetUnitVectors(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or xyz + front
    2. +
  2. + xyz + up
    3. +
  3. + xyz + right
    4. +
+ + + +
+

+ Spring.GetUnitRotation(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + pitch, rotation in X axis
    2. +
  2. + number + yaw, rotation in Y axis
    3. +
  3. + number + roll, rotation in Z axis
    4. +
+ + + +
+

+ Spring.GetUnitDirection(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or dirX + + +
    2. +
  2. + dirY + + +
    3. +
  3. + dirZ + + +
    4. +
+ + + +
+

+ Spring.GetUnitHeading(unitID[, convertToRadians=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + convertToRadians + bool + + + + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + heading + + +
    2. +
+ + + +
+

+ Spring.GetUnitVelocity(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitBuildFacing(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitIsBuilding(unitID) +

+

Checks whether a unit is currently building another (NOT for checking if it's a structure)

+
+

+ + + Works for both mobile builders and factories. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + buildeeUnitID or nil
    2. +
+ + + +
+

+ Spring.GetUnitWorkerTask(unitID) +

+

Checks a builder's current task

+
+

+ + + Checks what a builder is currently doing. This is not the same as `Spring.GetUnitCurrentCommand`, + because you can have a command at the front of the queue and not be doing it (for example because + the target is still too far away), and on the other hand you can also be doing a task despite not + having it in front of the queue (for example you're Guarding another builder who does). Also, it + resolves the Repair command into either actual repair, or construction assist (in which case it + returns the appropriate "build" command). Only build-related commands are returned (no Move or any + custom commands). + + The possible commands returned are repair, reclaim, resurrect, capture, restore, + and build commands (negative buildee unitDefID). + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + cmdID of the relevant command
    2. +
  2. + number + targetID if applicable (all except RESTORE)
    3. +
+ + + +
+

+ Spring.GetUnitEffectiveBuildRange(unitID, buildeeDefID) +

+

+
+

+ + Useful for setting move goals manually. +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + buildeeDefID + number + or nil +
    3. +
+ +

Returns:

+
    +
  1. + number + effectiveBuildRange counted to the center of prospective buildee; buildRange if buildee nil
    2. +
+ + + +
+

+ Spring.GetUnitCurrentBuildPower(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitHarvestStorage(unitID) +

+

Get a unit's carried resources

+
+

+ + + Checks resources being carried internally by the unit. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + storedMetal
    2. +
  2. + number + maxStoredMetal
    3. +
  3. + number + storedEnergy
    4. +
  4. + number + maxStoredEnergy
    5. +
+ + + +
+

+ Spring.GetUnitBuildParams(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitInBuildStance(unitID) +

+

Is builder in build stance

+
+

+ + + Checks if a builder is in build stance, i.e. can create nanoframes. + Returns nil for non-builders. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + bool + inBuildStance
    2. +
+ + + +
+

+ Spring.GetUnitNanoPieces(unitID) +

+

Get construction FX attachment points

+
+

+ + + Returns an array of pieces which represent construction + points. Default engine construction FX (nano spray) will + originate there. + + Only works on builders and factories, returns nil (NOT empty table) + for other units. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + pieceArray {pieceID, pieceID, ...}
    2. +
+ + + +
+

+ Spring.GetUnitTransporter(unitID) +

+

Get the transport carrying the unit

+
+

+ + + Returns the unit ID of the transport, if any. + Returns nil if the unit is not being transported. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number or nil + transportUnitID
    2. +
+ + + +
+

+ Spring.GetUnitIsTransporting(unitID) +

+

Get units being transported

+
+

+ + + Returns an array of unitIDs being transported by this unit. + Returns nil (NOT an empty array) for units that are not transports. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + transporteeArray {unitID, unitID, ...}
    2. +
+ + + +
+

+ Spring.GetUnitShieldState(unitID[, weaponNum]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponNum + number + Optional if the unit has just one shield + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + number + isEnabled Warning, number not bool. 0 or 1
    2. +
  2. + number + currentPower
    3. +
+ + + +
+

+ Spring.GetUnitFlanking(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitMaxRange(unitID) +

+

Get a unit's engagement range

+
+

+ + + Returns the range at which a unit will stop to engage. + By default this is the highest among the unit's weapon ranges (hence name), + but can be changed dynamically. Also note that unarmed units ignore this. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + maxRange
    2. +
+ + + +
+

+ Unit weapon state +

+ +

+ +

+

+

+ Spring.GetUnitWeaponState(unitID, weaponNum, stateName) +

+

Check the state of a unit's weapon

+
+

+ + + Available states to poll: + "reloadFrame" (frame on which the weapon will be ready to fire), + "reloadSpeed" (reload time in seconds), + "range" (in elmos), + "autoTargetRangeBoost" (predictive aiming range buffer, in elmos), + "projectileSpeed" (in elmos/frame), + "reloadTimeXP" (reload time after XP bonus, in seconds), + "reaimTime" (frames between AimWeapon calls), + "burst" (shots in a burst), + "burstRate" (delay between shots in a burst, in seconds), + "projectiles" (projectiles per shot), + "salvoLeft" (shots remaining in ongoing burst), + "nextSalvo" (simframe of the next shot in an ongoing burst), + "accuracy" (INaccuracy after XP bonus), + "sprayAngle" (spray angle after XP bonus), + "targetMoveError" (extra inaccuracy against moving targets, after XP bonus) + "avoidFlags" (bitmask for targeting avoidance), + "collisionFlags" (bitmask for collisions). + + The state "salvoError" is an exception and returns a table: {x, y, z}, + which represents the inaccuracy error of the ongoing burst. + +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponNum + number + + + +
    3. +
  3. + stateName + string + + + +
    4. +
+ +

Returns:

+
    +
  1. + number stateValue
    2. +
+ + + +
+

+ Spring.GetUnitWeaponDamages(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitWeaponVectors(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitWeaponTryTarget(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitWeaponTestTarget(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitWeaponTestRange(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitWeaponHaveFreeLineOfFire(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitWeaponCanFire(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ + + + +
+

+ Spring.GetUnitWeaponTarget(unitID, weaponNum) +

+

Checks a weapon's target

+
+

+ Note that this doesn't need to reflect the unit's Attack orders or such, and that weapons can aim individually unless slaved. +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + weaponNum + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + targetType (0: none, 1: unit, 2: position, 3: projectile)
    2. +
  2. + boolean + isUserTarget
    3. +
  3. + target (depending on type, 0: nil, 1: unitID, 2: table {x, y, z}, 3: projectileID)
    4. +
+ + + +
+

+ Projectile state +

+ +

+ +

+

+

+ Spring.GetProjectilePosition(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + posX
    2. +
  2. + number + posY
    3. +
  3. + number + posZ
    4. +
+ + + +
+

+ Spring.GetProjectileDirection(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + dirX
    2. +
  2. + number + dirY
    3. +
  3. + number + dirZ
    4. +
+ + + +
+

+ Spring.GetProjectileVelocity(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + velX
    2. +
  2. + number + velY
    3. +
  3. + number + velZ
    4. +
  4. + number + velW
    5. +
+ + + +
+

+ Spring.GetProjectileGravity(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetPieceProjectileParams(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + explosionFlags encoded bitwise with SHATTER = 1, EXPLODE = 2, EXPLODEONHIT = 2, FALL = 4, SMOKE = 8, FIRE = 16, NONE = 32, NOCEGTRAIL = 64, NO_HEATCLOUD = 128
    2. +
  2. + number + spinAngle
    3. +
  3. + number + spinSpeed
    4. +
  4. + number + spinVectorX
    5. +
  5. + number + spinVectorY
    6. +
  6. + number + spinVectorZ
    7. +
+ + + +
+

+ Spring.GetProjectileTarget(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + targetTypeInt where + string.byte('g') := GROUND + string.byte('u') := UNIT + string.byte('f') := FEATURE + string.byte('p') := PROJECTILE
    2. +
  2. + number or xyz + target targetID or targetPos when targetTypeInt == string.byte('g')
    3. +
+ + + +
+

+ Spring.GetProjectileIsIntercepted(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Spring.GetProjectileTimeToLive(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetProjectileOwnerID(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetProjectileTeamID(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetProjectileAllyTeamID(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetProjectileType(projectileID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + weapon
    2. +
  2. + bool + piece
    3. +
+ + + +
+

+ Spring.GetProjectileDefID(projectileID) +

+

+
+

+ + + Using this to get a weaponDefID is HIGHLY preferred to indexing WeaponDefNames via GetProjectileName + +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Spring.GetProjectileDamages(projectileID, tag) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + projectileID + number + + + +
    2. +
  2. + tag + string + +

    one of:

    +
     "paralyzeDamageTime"
+ "impulseFactor"
+ "impulseBoost"
+ "craterMult"
+ "craterBoost"
+ "dynDamageExp"
+ "dynDamageMin"
+ "dynDamageRange"
+ "dynDamageInverted"
+ "craterAreaOfEffect"
+ "damageAreaOfEffect"
+ "edgeEffectiveness"
+ "explosionSpeed"
+ - or -
+ an armor type index to get the damage against it.
+
    + +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + + +
    2. +
+ + + +
+

+ Ground +

+ +

+ +

+

+

+ Spring.IsPosInMap(x, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + boolean + inPlayArea whether the position is in the active play area
    2. +
  2. + boolean + inMap whether the position is in the full map area (currently this is the same as above)
    3. +
+ + + +
+

+ Spring.GetGroundHeight(x, z) +

+

Get ground height

+
+

+ On sea, this returns the negative depth of the seafloor + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + + +
    2. +
+ + + +
+

+ Spring.GetWaterPlaneLevel() +

+

Get water plane height + + Water may at some point become shaped (rivers etc) but for now it is always a flat plane.

+
+

+ + Use this function instead of GetWaterLevel to denote you are relying on that assumption. + +

+ + + +

Returns:

+
    +
  1. + number + waterPlaneLevel
    2. +
+ + +

See also:

+ + +
+

+ Spring.GetWaterLevel(x, z) +

+

Get water level in a specific position + + Water is currently a flat plane, so this returns the same value regardless of XZ.

+
+

+ + However water may become more dynamic at some point so by using this you are future-proof. + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + waterLevel
    2. +
+ + + +
+

+ Spring.GetGroundOrigHeight(x, z) +

+

Get ground height as it was at game start

+
+

+ Returns the original height before the ground got deformed + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + + +
    2. +
+ + + +
+

+ Spring.GetGroundNormal(x, z[, smoothed=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
  3. + smoothed + bool + raw or smoothed center normal + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + number + normalX
    2. +
  2. + number + normalY
    3. +
  3. + number + normalZ
    4. +
  4. + number + slope
    5. +
+ + + +
+

+ Spring.GetGroundInfo(x, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + ix
    2. +
  2. + number + iz
    3. +
  3. + number + terrainTypeIndex
    4. +
  4. + string + name
    5. +
  5. + number + metalExtraction
    6. +
  6. + number + hardness
    7. +
  7. + number + tankSpeed
    8. +
  8. + number + kbotSpeed
    9. +
  9. + number + hoverSpeed
    10. +
  10. + number + shipSpeed
    11. +
  11. + bool + receiveTracks
    12. +
+ + + +
+

+ Spring.GetGroundBlocked() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.GetGroundExtremes() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + initMinHeight
    2. +
  2. + number + initMaxHeight
    3. +
  3. + number + currMinHeight
    4. +
  4. + number + currMaxHeight
    5. +
+ + + +
+

+ Spring.GetTerrainTypeData(terrainTypeInfo) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + terrainTypeInfo + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + index
    2. +
  2. + string + name
    3. +
  3. + number + hardness
    4. +
  4. + number + tankSpeed
    5. +
  5. + number + kbotSpeed
    6. +
  6. + number + hoverSpeed
    7. +
  7. + number + shipSpeed
    8. +
  8. + bool + receiveTracks
    9. +
+ + + +
+

+ Spring.GetGrass(x, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + + +
    2. +
+ + + +
+

+ Spring.GetSmoothMeshHeight(x, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + z + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number + height
    2. +
+ + + +
+

+ Tests +

+ +

+ +

+

+

+ Spring.TestMoveOrder(unitDefID, testTerrain, testObjects, centerOnly) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
  2. + testTerrain + bool + + + + (default true) +
    3. +
  3. + testObjects + bool + + + + (default true) +
    4. +
  4. + centerOnly + bool + + + + (default false) +
    5. +
+ +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ Spring.TestBuildOrder(unitDefID, x, y, z, facing) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
  2. + x + number + + + +
    3. +
  3. + y + number + + + +
    4. +
  4. + z + number + + + +
    5. +
  5. + facing + number or string + one of: 0-s,1-e,2-n,3-w +
    6. +
+ +

Returns:

+
    +
  1. + number + blocking one of: 0 = blocked, 1 = mobile unit on the way, 2 = reclaimable, 3 = open
    2. +
  2. + nil or featureID + when there's a reclaimable feature on the way
    3. +
+ + + +
+

+ Spring.Pos2BuildPos(unitDefID, posX, posY, posZ[, buildFacing=0]) +

+

Snaps a position to the building grid

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
  2. + posX + number + + + +
    3. +
  3. + posY + number + + + +
    4. +
  4. + posZ + number + + + +
    5. +
  5. + buildFacing + number + one of SOUTH = 0, EAST = 1, NORTH = 2, WEST = 3 + (default 0) +
    6. +
+ +

Returns:

+
    +
  1. + number + buildPosX
    2. +
  2. + number + buildPosY
    3. +
  3. + number + buildPosZ
    4. +
+ + + +
+

+ Spring.ClosestBuildPos(teamID, unitDefID, posX, posY, posZ, searchRadius, minDistance, buildFacing) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + unitDefID + number + + + +
    3. +
  3. + posX + number + + + +
    4. +
  4. + posY + number + + + +
    5. +
  5. + posZ + number + + + +
    6. +
  6. + searchRadius + number + + + +
    7. +
  7. + minDistance + number + + + +
    8. +
  8. + buildFacing + number + one of SOUTH = 0, EAST = 1, NORTH = 2, WEST = 3 +
    9. +
+ +

Returns:

+
    +
  1. + number + buildPosX
    2. +
  2. + number + buildPosY
    3. +
  3. + number + buildPosZ
    4. +
+ + + +
+

+ Visibility +

+ +

+ +

+

+

+ Spring.GetPositionLosState(posX, posY, posZ[, allyTeamID]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + posX + number + + + +
    2. +
  2. + posY + number + + + +
    3. +
  3. + posZ + number + + + +
    4. +
  4. + allyTeamID + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + bool + inLosOrRadar
    2. +
  2. + inLos + + +
    3. +
  3. + inRadar + + +
    4. +
  4. + inJammer + + +
    5. +
+ + + +
+

+ Spring.IsPosInLos(posX, posY, posZ[, allyTeamID]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + posX + number + + + +
    2. +
  2. + posY + number + + + +
    3. +
  3. + posZ + number + + + +
    4. +
  4. + allyTeamID + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ Spring.IsPosInRadar(posX, posY, posZ[, allyTeamID]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + posX + number + + + +
    2. +
  2. + posY + number + + + +
    3. +
  3. + posZ + number + + + +
    4. +
  4. + allyTeamID + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ Spring.IsPosInAirLos(posX, posY, posZ[, allyTeamID]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + posX + number + + + +
    2. +
  2. + posY + number + + + +
    3. +
  3. + posZ + number + + + +
    4. +
  4. + allyTeamID + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ Spring.GetUnitLosState(unitID[, allyTeamID[, raw=false]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + allyTeamID + number + + + + (optional) +
    3. +
  3. + raw + bool + + + + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + nil, number or {los=bool,radar=bool,typed=bool} + los

    + +

    Raw is only available in gadgets and when raw parameter is true.

    + +

    RAW returns an bitmask integer, where the bits are: + 1: LOSINLOS, the unit is currently in the los of the allyteam, + 2: LOSINRADAR the unit is currently in radar from the allyteam, + 4: LOSPREVLOS the unit has previously been in los from the allyteam, + 8: LOSCONTRADAR the unit has continuously been in radar since it was last inlos by the allyteam

    2. +
+ + + +
+

+ Spring.IsUnitInLos(unitID, allyTeamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + allyTeamID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + inLos
    2. +
+ + + +
+

+ Spring.IsUnitInAirLos(unitID, allyTeamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + allyTeamID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + inAirLos
    2. +
+ + + +
+

+ Spring.IsUnitInRadar(unitID, allyTeamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + allyTeamID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + inRadar
    2. +
+ + + +
+

+ Spring.IsUnitInJammer(unitID, allyTeamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + allyTeamID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + inJammer
    2. +
+ + + +
+

+ Piece/Script +

+ +

+ +

+

+

+ pieceSpec +

+

Piece spec

+
+

+ +

+ + +

Fields:

+
    +
  1. + name + string + + + +
    2. +
  2. + parent + string + + + +
    3. +
  3. + children + {[string],...} + names +
    4. +
  4. + empty + bool + + + +
    5. +
  5. + min + {number,number,number} + (x,y,z) +
    6. +
  6. + max + {number,number,number} + (x,y,z) +
    7. +
  7. + offset + {number,number,number} + (x,y,z) +
    8. +
+ + + + +
+

+ Spring.GetModelRootPiece(modelName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + modelName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + index of the root piece
    2. +
+ + + +
+

+ Spring.GetModelPieceMap(modelName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + modelName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[string]=number,...} + pieceInfos where keys are piece names and values are indices
    2. +
+ + + +
+

+ Spring.GetModelPieceList(modelName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + modelName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[string],...} + pieceNames
    2. +
+ + + +
+

+ Spring.GetUnitRootPiece(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + index of the root piece
    2. +
+ + + +
+

+ Spring.GetUnitPieceMap(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[string]=number,...} + pieceInfos where keys are piece names and values are indices
    2. +
+ + + +
+

+ Spring.GetUnitPieceList(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {[string],...} + pieceNames
    2. +
+ + + +
+

+ Spring.GetUnitPieceInfo(unitID, pieceIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or pieceSpec + pieceInfo
    2. +
+ + + +
+

+ Spring.GetUnitPiecePosDir(unitID, pieceIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number or nil + posX
    2. +
  2. + number + posY
    3. +
  3. + number + posZ
    4. +
  4. + number + dirX
    5. +
  5. + number + dirY
    6. +
  6. + number + dirZ
    7. +
+ + + +
+

+ Spring.GetUnitPiecePosition(unitID, pieceIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number or nil + posX
    2. +
  2. + number + posY
    3. +
  3. + number + posZ
    4. +
+ + + +
+

+ Spring.GetUnitPieceDirection(unitID, pieceIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number or nil + dirX
    2. +
  2. + number + dirY
    3. +
  3. + number + dirZ
    4. +
+ + + +
+

+ Spring.GetUnitPieceMatrix(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number or nil + m11
    2. +
  2. + number + m12
    3. +
  3. + number + m13
    4. +
  4. + number + m14
    5. +
  5. + number + m21
    6. +
  6. + number + m22
    7. +
  7. + number + m23
    8. +
  8. + number + m24
    9. +
  9. + number + m31
    10. +
  10. + number + m32
    11. +
  11. + number + m33
    12. +
  12. + number + m34
    13. +
  13. + number + m41
    14. +
  14. + number + m42
    15. +
  15. + number + m43
    16. +
  16. + number + m44
    17. +
+ + + +
+

+ Spring.GetFeatureRootPiece(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + index of the root piece
    2. +
+ + + +
+

+ Spring.GetFeaturePieceMap(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {[string]=number,...} + pieceInfos where keys are piece names and values are indices
    2. +
+ + + +
+

+ Spring.GetFeaturePieceList(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {[string],...} + pieceNames
    2. +
+ + + +
+

+ Spring.GetFeaturePieceInfo(featureID, pieceIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or pieceSpec + pieceInfo
    2. +
+ + + +
+

+ Spring.GetFeaturePiecePosDir(featureID, pieceIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number or nil + posX
    2. +
  2. + number + posY
    3. +
  3. + number + posZ
    4. +
  4. + number + dirX
    5. +
  5. + number + dirY
    6. +
  6. + number + dirZ
    7. +
+ + + +
+

+ Spring.GetFeaturePiecePosition(featureID, pieceIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number or nil + posX
    2. +
  2. + number + posY
    3. +
  3. + number + posZ
    4. +
+ + + +
+

+ Spring.GetFeaturePieceDirection(featureID, pieceIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + pieceIndex + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + number or nil + dirX
    2. +
  2. + number + dirY
    3. +
  3. + number + dirZ
    4. +
+ + + +
+

+ Spring.GetFeaturePieceMatrix(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number or nil + m11
    2. +
  2. + number + m12
    3. +
  3. + number + m13
    4. +
  4. + number + m14
    5. +
  5. + number + m21
    6. +
  6. + number + m22
    7. +
  7. + number + m23
    8. +
  8. + number + m24
    9. +
  9. + number + m31
    10. +
  10. + number + m32
    11. +
  11. + number + m33
    12. +
  12. + number + m34
    13. +
  13. + number + m41
    14. +
  14. + number + m42
    15. +
  15. + number + m43
    16. +
  16. + number + m44
    17. +
+ + + +
+

+ Spring.GetUnitScriptPiece(unitID[, scriptPiece]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + scriptPiece + number + + + + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + {number,...} or number + pieceIndices when scriptPiece is not specified, pieceIndex otherwise
    2. +
+ + + +
+

+ Spring.GetUnitScriptNames(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + {[string]=number,...} + where keys are piece names and values are piece indices
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/UnsyncedCtrl.html b/ldoc/modules/UnsyncedCtrl.html new file mode 100644 index 0000000000..4704785236 --- /dev/null +++ b/ldoc/modules/UnsyncedCtrl.html @@ -0,0 +1,8660 @@ +--- +layout: default +title: UnsyncedCtrl +permalink: ldoc/modules/UnsyncedCtrl.html +description: Callouts to set state +parent: Lua API +table: 0x55953a3ac540 +--- + +{% raw %} +

Module UnsyncedCtrl

+

Callouts to set state

+

+ +

+

+

See also:

+ + +

Tables

+
+
+ rgb +
+
+ Color triple (RGB) +
+
+ rgba +
+
+ Color quadruple (RGBA) +
+
+

Decals

+
+
+ Spring.CreateGroundDecal +
+
+ + + +
+
+ Spring.DestroyGroundDecal +
+
+ + + +
+
+ Spring.SetGroundDecalPosAndDims +
+
+ + + +
+
+ Spring.SetGroundDecalQuadPosAndHeight +
+
+ + + +
+
+ Spring.SetGroundDecalRotation +
+
+ + + +
+
+ Spring.SetGroundDecalTexture +
+
+ + + +
+
+ Spring.SetGroundDecalTextureParams +
+
+ + + +
+
+ Spring.SetGroundDecalAlpha +
+
+ + + +
+
+ Spring.SetGroundDecalNormal +
+
+ + + +
+
+ Spring.SetGroundDecalTint +
+
+ + + +
+
+ Spring.SetGroundDecalMisc +
+
+ + + +
+
+ Spring.SetGroundDecalCreationFrame +
+
+ + + +
+
+

Give Order

+
+
+ cmdOpts +
+
+ Command Options params +
+
+ Spring.GiveOrder +
+
+ + + +
+
+ Spring.GiveOrderToUnit +
+
+ + + +
+
+ Spring.GiveOrderToUnitMap +
+
+ + + +
+
+ Spring.GiveOrderToUnitArray +
+
+ + + +
+
+ cmdSpec +
+
+ Command spec +
+
+ Spring.GiveOrderArrayToUnit +
+
+ + + +
+
+ Spring.GiveOrderArrayToUnitMap +
+
+ + + +
+
+ Spring.GiveOrderArrayToUnitArray +
+
+ + + +
+
+ Spring.SetBuildSpacing +
+
+ + + +
+
+ Spring.SetBuildFacing +
+
+ + + +
+
+

Ingame Console

+
+
+ Spring.Ping +
+
+ Send a ping request to the server +
+
+ Spring.Echo +
+
+ Useful for debugging. +
+
+ Spring.Log +
+
+ + + +
+
+ Spring.SendCommands +
+
+ + + +
+
+ Spring.SetMapShader +
+
+ + + +
+
+ Spring.SetMapSquareTexture +
+
+ + + +
+
+ Spring.SetMapShadingTexture +
+
+ + + +
+
+ Spring.SetSkyBoxTexture +
+
+ + + +
+
+

Messages

+
+
+ Spring.SendMessage +
+
+ + + +
+
+ Spring.SendMessageToSpectators +
+
+ + + +
+
+ Spring.SendMessageToPlayer +
+
+ + + +
+
+ Spring.SendMessageToTeam +
+
+ + + +
+
+ Spring.SendMessageToAllyTeam +
+
+ + + +
+
+

Sounds

+
+
+ Spring.LoadSoundDef +
+
+ Loads a SoundDefs file, the format is the same as in gamedata/sounds.lua. +
+
+ Spring.PlaySoundFile +
+
+ + + +
+
+ Spring.PlaySoundStream +
+
+ Allows to play an Ogg Vorbis (.OGG) and mp3 compressed sound file. +
+
+ Spring.StopSoundStream +
+
+ Terminates any SoundStream currently running. +
+
+ Spring.PauseSoundStream +
+
+ Pause any SoundStream currently running. +
+
+ Spring.SetSoundStreamVolume +
+
+ Set volume for SoundStream +
+
+ Spring.SetSoundEffectParams +
+
+ + + +
+
+ Spring.AddWorldIcon +
+
+ + + +
+
+ Spring.AddWorldText +
+
+ + + +
+
+ Spring.AddWorldUnit +
+
+ + + +
+
+ Spring.DrawUnitCommands +
+
+ + + +
+
+ Spring.DrawUnitCommands +
+
+ + + +
+
+

Camera

+
+
+ camState +
+
+ Parameters for camera state +
+
+ Spring.SetCameraTarget +
+
+ For Spring Engine XZ represents horizontal, from north west corner of map and Y vertical, from water level and rising. +
+
+ Spring.SetCameraTarget +
+
+ + + +
+
+ Spring.SetCameraState +
+
+ Sets camera state +
+
+

Unit Selection

+
+
+ Spring.SelectUnit +
+
+ Selects a single unit +
+
+ Spring.DeselectUnit +
+
+ + + +
+
+ Spring.DeselectUnitArray +
+
+ Deselects multiple units. +
+
+ Spring.DeselectUnitMap +
+
+ Deselects multiple units. +
+
+ Spring.SelectUnitArray +
+
+ Selects multiple units, or appends to selection. +
+
+ Spring.SelectUnitMap +
+
+ Selects multiple units, or appends to selection. +
+
+

Lighting

+
+
+ lightParams +
+
+ Parameters for lighting +
+
+ Spring.AddMapLight +
+
+ + + +
+
+ Spring.AddModelLight +
+
+ + + +
+
+ Spring.UpdateMapLight +
+
+ + + +
+
+ Spring.UpdateModelLight +
+
+ + + +
+
+ Spring.AddLightTrackingTarget +
+
+ + + +
+
+ Spring.SetMapLightTrackingState +
+
+ Set a map-illuminating light to start/stop tracking the position of a moving object (unit or projectile) +
+
+ Spring.SetModelLightTrackingState +
+
+ Set a model-illuminating light to start/stop tracking the position of a moving object (unit or projectile) +
+
+

Unit custom rendering

+
+
+ Spring.SetUnitNoDraw +
+
+ + + +
+
+ Spring.SetUnitEngineDrawMask +
+
+ + + +
+
+ Spring.SetUnitAlwaysUpdateMatrix +
+
+ + + +
+
+ Spring.SetUnitNoMinimap +
+
+ + + +
+
+ Spring.SetUnitNoSelect +
+
+ + + +
+
+ Spring.SetUnitLeaveTracks +
+
+ + + +
+
+ Spring.SetUnitSelectionVolumeData +
+
+ + + +
+
+

Features

+
+
+ Spring.SetFeatureNoDraw +
+
+ + + +
+
+ Spring.SetFeatureEngineDrawMask +
+
+ + + +
+
+ Spring.SetFeatureAlwaysUpdateMatrix +
+
+ + + +
+
+ Spring.SetFeatureFade +
+
+ Control whether a feature will fade or not when zoomed out. +
+
+ Spring.SetFeatureSelectionVolumeData +
+
+ + + +
+
+

Unit Icons

+
+
+ Spring.AddUnitIcon +
+
+ + + +
+
+ Spring.FreeUnitIcon +
+
+ + + +
+
+ Spring.UnitIconSetDraw +
+
+ + + +
+
+ Spring.SetUnitDefIcon +
+
+ + + +
+
+ Spring.SetUnitDefImage +
+
+ + + +
+
+

Virtual File System

+
+
+ Spring.ExtractModArchiveFile +
+
+ + + +
+
+ Spring.CreateDir +
+
+ + + +
+
+ Spring.AllocateTable +
+
+ + + +
+
+

GUI

+
+
+ Spring.SetActiveCommand +
+
+ + + +
+
+ Spring.SetActiveCommand +
+
+ + + +
+
+ Spring.LoadCmdColorsConfig +
+
+ + + +
+
+ Spring.LoadCtrlPanelConfig +
+
+ + + +
+
+ Spring.ForceLayoutUpdate +
+
+ + + +
+
+ Spring.SetDrawSelectionInfo +
+
+ Disables the "Selected Units x" box in the GUI. +
+
+ Spring.SetBoxSelectionByEngine +
+
+ + + +
+
+ Spring.SetTeamColor +
+
+ + + +
+
+ Spring.AssignMouseCursor +
+
+ Changes/creates the cursor of a single CursorCmd. +
+
+ Spring.ReplaceMouseCursor +
+
+ Mass replace all occurrences of the cursor in all CursorCmds. +
+
+ Spring.SetCustomCommandDrawData +
+
+ Register your custom cmd so it gets visible in the unit's cmd queue +
+
+

Mouse

+
+
+ Spring.WarpMouse +
+
+ + + +
+
+ Spring.SetMouseCursor +
+
+ + + +
+
+

LOS Colors

+
+
+ Spring.SetLosViewColors +
+
+ + + +
+
+ Spring.SetNanoProjectileParams +
+
+ + + +
+
+

Engine Config

+
+
+ Spring.SetConfigInt +
+
+ + + +
+
+ Spring.SetConfigFloat +
+
+ + + +
+
+ Spring.SetConfigString +
+
+ + + +
+
+ Spring.Quit +
+
+ Closes the application +
+
+

Unit Group

+
+
+ Spring.SetUnitGroup +
+
+ + + +
+
+

UI

+
+
+ Spring.SendLuaUIMsg +
+
+ + + +
+
+ Spring.SendLuaGaiaMsg +
+
+ + + +
+
+ Spring.SendLuaRulesMsg +
+
+ + + +
+
+ Spring.SendLuaMenuMsg +
+
+ + + +
+
+ Spring.SetLastMessagePosition +
+
+ + + +
+
+

Sharing

+
+
+ Spring.SetShareLevel +
+
+ + + +
+
+ Spring.ShareResources +
+
+ + + +
+
+ Spring.ShareResources +
+
+ + + +
+
+

Markers

+
+
+ Spring.MarkerAddPoint +
+
+ + + +
+
+ Spring.MarkerAddLine +
+
+ + + +
+
+ Spring.MarkerErasePosition +
+
+ + + +
+
+

Sun

+
+
+ Spring.SetAtmosphere +
+
+ It can be used to modify the following atmosphere parameters +
+
+ Spring.SetSunDirection +
+
+ + + +
+
+ Spring.SetSunLighting +
+
+ It can be used to modify the following sun lighting parameters +
+
+ mapRenderingParams +
+
+ Map rendering params +
+
+ Spring.SetMapRenderingParams +
+
+ Allows to change map rendering params at runtime. +
+
+ Spring.ForceTesselationUpdate +
+
+ + + +
+
+

AI

+
+
+ Spring.SendSkirmishAIMessage +
+
+ + + +
+
+

Developers

+
+
+ Spring.SetLogSectionFilterLevel +
+
+ + + +
+
+ Spring.GarbageCollectCtrl +
+
+ + + +
+
+ Spring.SetDrawSky +
+
+ + + +
+
+ Spring.SetDrawWater +
+
+ + + +
+
+ Spring.SetDrawGround +
+
+ + + +
+
+ Spring.SetDrawGroundDeferred +
+
+ + + +
+
+ Spring.SetDrawModelsDeferred +
+
+ + + +
+
+ Spring.SetVideoCapturingMode +
+
+ This doesn't actually record the game in any way, it just regulates the framerate and interpolations. +
+
+ Spring.SetVideoCapturingTimeOffset +
+
+ + + +
+
+ waterParams +
+
+ Water params +
+
+ Spring.SetWaterParams +
+
+ + + +
+
+

Preload

+
+
+ Spring.PreloadUnitDefModel +
+
+ + + +
+
+ Spring.PreloadFeatureDefModel +
+
+ + + +
+
+ Spring.PreloadSoundItem +
+
+ + + +
+
+ Spring.LoadModelTextures +
+
+ + + +
+
+

SDL Text

+
+
+ Spring.SDLSetTextInputRect +
+
+ + + +
+
+ Spring.SDLStartTextInput +
+
+ + + +
+
+ Spring.SDLStopTextInput +
+
+ + + +
+
+

Window Management

+
+
+ Spring.SetWindowGeometry +
+
+ + + +
+
+ Spring.SetWindowMinimized +
+
+ + + +
+
+ Spring.SetWindowMaximized +
+
+ + + +
+
+

Misc

+
+
+ Spring.Reload +
+
+ + + +
+
+ Spring.Restart +
+
+ + + +
+
+ Spring.Start +
+
+ Launches a new Spring instance without terminating the existing one. +
+
+ Spring.SetWMIcon +
+
+ Sets the icon for the process which is seen in the OS task-bar and other places (default: spring-logo). +
+
+ SetWMCaption +
+
+ Sets the window title for the process (default: "Spring "). +
+
+ Spring.ClearWatchDogTimer +
+
+ + + +
+
+ Spring.SetClipboard +
+
+ + + +
+
+ Spring.Yield +
+
+ Relinquish control of the game loading thread and OpenGL context back to the UI (LuaIntro). +
+
+ +

+ Tables +

+ +

+ rgb +

+

Color triple (RGB)

+
+

+ +

+ + +

Fields:

+
    +
  1. + r + number + + + +
    2. +
  2. + g + number + + + +
    3. +
  3. + b + number + + + +
    4. +
+ + + + +
+

+ rgba +

+

Color quadruple (RGBA)

+
+

+ +

+ + +

Fields:

+
    +
  1. + r + number + + + +
    2. +
  2. + g + number + + + +
    3. +
  3. + b + number + + + +
    4. +
  4. + a + number + + + +
    5. +
+ + + + +
+

+ Decals +

+ +

+ +

+

+

+ Spring.CreateGroundDecal() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or number + decalID
    2. +
+ + + +
+

+ Spring.DestroyGroundDecal(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + bool + delSuccess
    2. +
+ + + +
+

+ Spring.SetGroundDecalPosAndDims(decalID[, midPosX=currMidPosX[, midPosZ=currMidPosZ[, sizeX=currSizeX[, sizeZ=currSizeZ[, projCubeHeight=calculateProjCubeHeight]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + midPosX + number + + + + (default currMidPosX) +
    3. +
  3. + midPosZ + number + + + + (default currMidPosZ) +
    4. +
  4. + sizeX + number + + + + (default currSizeX) +
    5. +
  5. + sizeZ + number + + + + (default currSizeZ) +
    6. +
  6. + projCubeHeight + number + + + + (default calculateProjCubeHeight) +
    7. +
+ +

Returns:

+
    +
  1. + bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalQuadPosAndHeight(decalID[, projCubeHeight=currPosTL.x]) +

+

+
+

+ + + Use for non-rectangular decals + +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + projCubeHeight + number + + + + (default calculateProjCubeHeight) +
    3. +
+ +

Returns:

+
    +
  1. + bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalRotation(decalID[, rot=random]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + rot + number + in radians + (default random) +
    3. +
+ +

Returns:

+
    +
  1. + bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalTexture(decalID, textureName[, isMainTex=true]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + textureName + string + The texture has to be on the atlas which seems to mean it's defined as an explosion, unit tracks, or building plate decal on some unit already (no arbitrary textures) +
    3. +
  3. + isMainTex + bool + If false, it sets the normals/glow map + (default true) +
    4. +
+ +

Returns:

+
    +
  1. + nil or bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalTextureParams(decalID, texWrapDistance, texTraveledDistance) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + texWrapDistance + number + [opt=currTexWrapDistance] if non-zero sets the mode to repeat the texture along the left-right direction of the decal every texWrapFactor elmos +
    3. +
  3. + texTraveledDistance + number + [opt=currTexTraveledDistance] shifts the texture repetition defined by texWrapFactor so the texture of a next line in the continuous multiline can start where the previous finished. For that it should collect all elmo lengths of the previously set multiline segments. +
    4. +
+ +

Returns:

+
    +
  1. + nil or bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalAlpha(decalID[, alpha=currAlpha[, alphaFalloff=currAlphaFalloff]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + alpha + number + Between 0 and 1 + (default currAlpha) +
    3. +
  3. + alphaFalloff + number + Between 0 and 1, per second + (default currAlphaFalloff) +
    4. +
+ +

Returns:

+
    +
  1. + bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalNormal(decalID[, normalX=0[, normalY=0[, normalZ=0]]]) +

+

+
+

+ + Sets projection cube normal to orient in 3D space. + In case the normal (0,0,0) then normal is picked from the terrain +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + normalX + number + + + + (default 0) +
    3. +
  3. + normalY + number + + + + (default 0) +
    4. +
  4. + normalZ + number + + + + (default 0) +
    5. +
+ +

Returns:

+
    +
  1. + bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalTint(decalID[, tintColR=curTintColR[, tintColG=curTintColG[, tintColB=curTintColB[, tintColA=curTintColA]]]]) +

+

+
+

+ + Sets the tint of the ground decal. Color = 2 * textureColor * tintColor + Respectively a color of (0.5, 0.5, 0.5, 0.5) is effectively no tint +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + tintColR + number + + + + (default curTintColR) +
    3. +
  3. + tintColG + number + + + + (default curTintColG) +
    4. +
  4. + tintColB + number + + + + (default curTintColB) +
    5. +
  5. + tintColA + number + + + + (default curTintColA) +
    6. +
+ +

Returns:

+
    +
  1. + bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalMisc(decalID[, dotElimExp=curValue[, refHeight=curValue[, minHeight=curValue[, maxHeight=curValue[, forceHeightMode=curValue]]]]]) +

+

+
+

+ + Sets varios secondary parameters of a decal +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + dotElimExp + number + pow(max(dot(decalProjVector, SurfaceNormal), 0.0), dotElimExp), used to reduce decal artifacts on surfaces non-collinear with the projection vector + (default curValue) +
    3. +
  3. + refHeight + number + + + + (default curValue) +
    4. +
  4. + minHeight + number + + + + (default curValue) +
    5. +
  5. + maxHeight + number + + + + (default curValue) +
    6. +
  6. + forceHeightMode + number + in case forceHeightMode==1.0 ==> force relative height: midPoint.y = refHeight + clamp(midPoint.y - refHeight, minHeight); forceHeightMode==2.0 ==> force absolute height: midPoint.y = midPoint.y, clamp(midPoint.y, minHeight, maxHeight); other forceHeightMode values do not enforce the height of the center position + (default curValue) +
    7. +
+ +

Returns:

+
    +
  1. + bool + decalSet
    2. +
+ + + +
+

+ Spring.SetGroundDecalCreationFrame(decalID[, creationFrameMin=currCreationFrameMin[, creationFrameMax=currCreationFrameMax]]) +

+

+
+

+ + + Use separate min and max for "gradient" style decals such as tank tracks + +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + creationFrameMin + number + + + + (default currCreationFrameMin) +
    3. +
  3. + creationFrameMax + number + + + + (default currCreationFrameMax) +
    4. +
+ +

Returns:

+
    +
  1. + bool + decalSet
    2. +
+ + + +
+

+ Give Order +

+ +

Options can also be a bitmask; e.g. 0 instead of an empty table (can avoid performance hit on table creation) + See Constants.CMD for relevant constants.

+

+ cmdOpts +

+

Command Options params

+
+

+ + + Can be specified as a table, or as an array containing any of the keys + below. + +

+ + +

Fields:

+
    +
  1. + right + bool + Right mouse key pressed +
    2. +
  2. + alt + bool + Alt key pressed +
    3. +
  3. + ctrl + bool + Ctrl key pressed +
    4. +
  4. + shift + bool + Shift key pressed +
    5. +
  5. + meta + bool + Meta (windows/mac/mod4) key pressed +
    6. +
+ + + + +
+

+ Spring.GiveOrder(cmdID, params, options) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cmdID + number + + + +
    2. +
  2. + params + table + + + +
    3. +
  3. + options + cmdOpts + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil or true + + +
    2. +
+ + + +
+

+ Spring.GiveOrderToUnit(unitID, cmdID, params, options) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + cmdID + number + + + +
    3. +
  3. + params + table + + + +
    4. +
  4. + options + cmdOpts + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil or true + + +
    2. +
+ + + +
+

+ Spring.GiveOrderToUnitMap(unitMap, cmdID, params, options) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitMap + table + { [unitID] = arg1, ... } +
    2. +
  2. + cmdID + number + + + +
    3. +
  3. + params + table + + + +
    4. +
  4. + options + cmdOpts + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil or true + + +
    2. +
+ + + +
+

+ Spring.GiveOrderToUnitArray(unitArray, cmdID, params, options) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitArray + {number,...} + array of unit ids +
    2. +
  2. + cmdID + number + + + +
    3. +
  3. + params + table + + + +
    4. +
  4. + options + cmdOpts + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil or true + + +
    2. +
+ + + +
+

+ cmdSpec +

+

Command spec

+
+

+ + + Used when assigning multiple commands at once + +

+ + +

Fields:

+
    +
  1. + cmdID + number + + + +
    2. +
  2. + params + table + + + +
    3. +
  3. + options + cmdOpts + + + +
    4. +
+ + + + +
+

+ Spring.GiveOrderArrayToUnit(unitID, cmdArray) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + cmdArray + {cmdSpec,...} + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + ordersGiven
    2. +
+ + + +
+

+ Spring.GiveOrderArrayToUnitMap(unitMap, cmdArray) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitMap + table + { [unitID] = arg1, ... } +
    2. +
  2. + cmdArray + {cmdSpec,...} + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + ordersGiven
    2. +
+ + + +
+

+ Spring.GiveOrderArrayToUnitArray(unitArray, cmdArray[, pairwise=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitArray + {number,...} + array of unit ids +
    2. +
  2. + cmdArray + {cmdSpec,...} + + + +
    3. +
  3. + pairwise + bool + When false, assign all commands to each unit.

    + +

    When true, assign commands according to index between units and cmds arrays.

    + +

    If len(unitArray) < len(cmdArray) only the first len(unitArray) commands + will be assigned, and vice-versa. + (default false) +

    4. +
+ +

Returns:

+
    +
  1. + nil or bool + + +
    2. +
+ + + +
+

+ Spring.SetBuildSpacing(spacing) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + spacing + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetBuildFacing(facing) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + facing + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Ingame Console +

+ +

+ +

+

+

+ Spring.Ping(pingTag) +

+

Send a ping request to the server

+
+

+ +

+ + +

Parameters:

+
    +
  1. + pingTag + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.Echo(arg1[, arg2[, argn]]) +

+

Useful for debugging.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + arg1 + + + +
    2. +
  2. + arg2 + + + + (optional) +
    3. +
  3. + argn + Prints values in the spring chat console. + Hint: the default print() writes to STDOUT. + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.Log(section, logLevel, logMessage1[, logMessage2[, logMessagen]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + section + string + + + +
    2. +
  2. + logLevel + number or string + + +

    Possible values for logLevel are:

    +
    "debug"   | LOG.DEBUG
+"info"    | LOG.INFO
+"notice"  | LOG.NOTICE (engine default)
+"warning" | LOG.WARNING
+"error"   | LOG.ERROR
+"fatal"   | LOG.FATAL
+
    + +
    3. +
  3. + logMessage1 + string + + + +
    4. +
  4. + logMessage2 + string + + + + (optional) +
    5. +
  5. + logMessagen + string + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SendCommands(command1, command2) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + command1 + string or table + | { command1, command 2, ...} +
    2. +
  2. + command2 + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetMapShader(standardShaderID, deferredShaderID) +

+

+
+

+ + + The ID's must refer to valid programs returned by `gl.CreateShader`. + Passing in a value of 0 will cause the respective shader to revert back to its engine default. + Custom map shaders that declare a uniform ivec2 named "texSquare" can sample from the default diffuse texture(s), which are always bound to TU 0. + +

+ + +

Parameters:

+
    +
  1. + standardShaderID + number + + + +
    2. +
  2. + deferredShaderID + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetMapSquareTexture(texSqrX, texSqrY, luaTexName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + texSqrX + number + + + +
    2. +
  2. + texSqrY + number + + + +
    3. +
  3. + luaTexName + string + + + +
    4. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetMapShadingTexture(texType, texName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + texType + string + + + +
    2. +
  2. + texName + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +

Usage:

+
    + 
  • Spring.SetMapShadingTexture("$ssmf_specular", "name_of_my_shiny_texture")
    • +
+
+

+ Spring.SetSkyBoxTexture(texName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + texName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Messages +

+ +

+ +

+

+

+ Spring.SendMessage(message) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + message + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SendMessageToSpectators(message) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + message + string + <PLAYER#> (with # being a playerid) inside the string will be replaced with the players name - i.e. : Spring.SendMessage ("<PLAYER1> did something") might display as "ProRusher did something" +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SendMessageToPlayer(playerID, message) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + message + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SendMessageToTeam(teamID, message) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + message + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SendMessageToAllyTeam(allyID, message) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyID + number + + + +
    2. +
  2. + message + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Sounds +

+ +

+ +

+

+

+ Spring.LoadSoundDef(soundfile) +

+

Loads a SoundDefs file, the format is the same as in `gamedata/sounds.lua`.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + soundfile + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + success
    2. +
+ + + +
+

+ Spring.PlaySoundFile(soundfile[, volume=1.0[, posx[, posy[, posz[, speedx[, speedy[, speedz[, channel]]]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + soundfile + string + + + +
    2. +
  2. + volume + number + + + + (default 1.0) +
    3. +
  3. + posx + number + + + + (optional) +
    4. +
  4. + posy + number + + + + (optional) +
    5. +
  5. + posz + number + + + + (optional) +
    6. +
  6. + speedx + number + + + + (optional) +
    7. +
  7. + speedy + number + + + + (optional) +
    8. +
  8. + speedz + number + + + + (optional) +
    9. +
  9. + channel + number or string + + +
    Possible arguments for channel argument:
+"general" || 0 || nil (default)
+"battle" || "sfx" | 1
+"unitreply" || "voice" || 2
+"userinterface" || "ui" || 3
+
    + + + (optional) +
    10. +
+ +

Returns:

+
    +
  1. + nil or bool + playSound
    2. +
+ + + +
+

+ Spring.PlaySoundStream(oggfile[, volume=1.0[, enqueue]]) +

+

Allows to play an Ogg Vorbis (.OGG) and mp3 compressed sound file.

+
+

+ + + Multiple sound streams may be played at once. + +

+ + +

Parameters:

+
    +
  1. + oggfile + string + + + +
    2. +
  2. + volume + number + + + + (default 1.0) +
    3. +
  3. + enqueue + bool + + + + (optional) +
    4. +
+ +

Returns:

+
    +
  1. + nil or bool + success
    2. +
+ + + +
+

+ Spring.StopSoundStream() +

+

Terminates any SoundStream currently running.

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.PauseSoundStream() +

+

Pause any SoundStream currently running.

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetSoundStreamVolume(volume) +

+

Set volume for SoundStream

+
+

+ +

+ + +

Parameters:

+
    +
  1. + volume + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetSoundEffectParams() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.AddWorldIcon(cmdID, posX, posY, posZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cmdID + number + + + +
    2. +
  2. + posX + number + + + +
    3. +
  3. + posY + number + + + +
    4. +
  4. + posZ + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddWorldText(text, posX, posY, posZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + text + string + + + +
    2. +
  2. + posX + number + + + +
    3. +
  3. + posY + number + + + +
    4. +
  4. + posZ + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AddWorldUnit(unitDefID, posX, posY, posZ, teamID, facing) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
  2. + posX + number + + + +
    3. +
  3. + posY + number + + + +
    4. +
  4. + posZ + number + + + +
    5. +
  5. + teamID + number + + + +
    6. +
  6. + facing + number + + + +
    7. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.DrawUnitCommands(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.DrawUnitCommands(units, tableOrArray) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + units + table + array of unit ids +
    2. +
  2. + tableOrArray + bool + [opt=false] when true units is interpreted as a table in the format { [unitID] = arg1, ... } +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Camera +

+ +

+ +

+

+

+ camState +

+

Parameters for camera state

+
+

+ + + Highly dependent on the type of the current camera controller + +

+ + +

Fields:

+
    +
  1. + name + string + "ta"|"spring"|"rot"|"ov"|"free"|"fps"|"dummy" +
    2. +
  2. + mode + number + the camera mode: 0 (fps), 1 (ta), 2 (spring), 3 (rot), 4 (free), 5 (ov), 6 (dummy) +
    3. +
  3. + fov + number + + + +
    4. +
  4. + px + number + Position X of the ground point in screen center +
    5. +
  5. + py + number + Position Y of the ground point in screen center +
    6. +
  6. + pz + number + Position Z of the ground point in screen center +
    7. +
  7. + dx + number + Camera direction vector X +
    8. +
  8. + dy + number + Camera direction vector Y +
    9. +
  9. + dz + number + Camera direction vector Z +
    10. +
  10. + rx + number + Camera rotation angle on X axis (spring) +
    11. +
  11. + ry + number + Camera rotation angle on Y axis (spring) +
    12. +
  12. + rz + number + Camera rotation angle on Z axis (spring) +
    13. +
  13. + angle + number + Camera rotation angle on X axis (aka tilt/pitch) (ta) +
    14. +
  14. + flipped + number + -1 for when south is down, 1 for when north is down (ta) +
    15. +
  15. + dist + number + Camera distance from the ground (spring) +
    16. +
  16. + height + number + Camera distance from the ground (ta) +
    17. +
  17. + oldHeight + number + Camera distance from the ground, cannot be changed (rot) +
    18. +
+ + + + +
+

+ Spring.SetCameraTarget(x, y, z[, transTime]) +

+

For Spring Engine XZ represents horizontal, from north west corner of map and Y vertical, from water level and rising.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
  4. + transTime + number + + + + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetCameraTarget(px, py, pz, tx, ty, tz) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + px + number + [opt=0] +
    2. +
  2. + py + number + [opt=0] +
    3. +
  3. + pz + number + [opt=0] +
    4. +
  4. + tx + number + [opt=0] +
    5. +
  5. + ty + number + [opt=0] +
    6. +
  6. + tz + number + [opt=0] +
    7. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetCameraState(camState[, transitionTime=0[, transitionTimeFactor[, transitionTimeExponent]]]) +

+

Sets camera state

+
+

+ + + The fields in `camState` must be consistent with the name/mode and current/new camera mode + +

+ + +

Parameters:

+
    +
  1. + camState + camState + + + +
    2. +
  2. + transitionTime + number + in nanoseconds + (default 0) +
    3. +
  3. + transitionTimeFactor + number + multiplicative factor applied to this and all subsequent transition times for + this camera mode.

    + +

    Defaults to "CamTimeFactor" springsetting unless set previously. + (optional) +

    4. +
  4. + transitionTimeExponent + number + tween factor applied to this and all subsequent transitions for this camera + mode.

    + +

    Defaults to "CamTimeExponent" springsetting unless set previously. + (optional) +

    5. +
+ +

Returns:

+
    +
  1. + bool + set
    2. +
+ + + +
+

+ Unit Selection +

+ +

+ +

+

+

+ Spring.SelectUnit(unitID[, append=false]) +

+

Selects a single unit

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + or nil +
    2. +
  2. + append + bool + append to current selection + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.DeselectUnit(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.DeselectUnitArray(unitID) +

+

Deselects multiple units.

+
+

+ Accepts a table with unitIDs as values + +

+ + +

Parameters:

+
    +
  1. + unitID + {[any] + , ...} unitIDs +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.DeselectUnitMap(any) +

+

Deselects multiple units.

+
+

+ Accepts a table with unitIDs as keys + +

+ + +

Parameters:

+
    +
  1. + any + {[unitID] + , ...} unitMap where keys are unitIDs +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SelectUnitArray(unitID[, append=false]) +

+

Selects multiple units, or appends to selection.

+
+

+ Accepts a table with unitIDs as values + +

+ + +

Parameters:

+
    +
  1. + unitID + {[any] + , ...} unitIDs +
    2. +
  2. + append + bool + append to current selection + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SelectUnitMap(any[, append=false]) +

+

Selects multiple units, or appends to selection.

+
+

+ Accepts a table with unitIDs as keys + +

+ + +

Parameters:

+
    +
  1. + any + {[unitID] + , ...} unitMap where keys are unitIDs +
    2. +
  2. + append + bool + append to current selection + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Lighting +

+ +

+ +

+

+

+ lightParams +

+

Parameters for lighting

+
+

+ +

+ + +

Fields:

+
    +
  1. position + + +
      +
    • + px + number + + + +
      • +
    • + py + number + + + +
      • +
    • + pz + number + + + +
      • +
    +
  2. direction + + +
      +
    • + dx + number + + + +
      • +
    • + dy + number + + + +
      • +
    • + dz + number + + + +
      • +
    +
  3. ambientColor + + +
      +
    • + red + number + + + +
      • +
    • + green + number + + + +
      • +
    • + blue + number + + + +
      • +
    +
  4. diffuseColor + + +
      +
    • + red + number + + + +
      • +
    • + green + number + + + +
      • +
    • + blue + number + + + +
      • +
    +
  5. specularColor + + +
      +
    • + red + number + + + +
      • +
    • + green + number + + + +
      • +
    • + blue + number + + + +
      • +
    +
  6. intensityWeight + + +
      +
    • + ambientWeight + number + + + +
      • +
    • + diffuseWeight + number + + + +
      • +
    • + specularWeight + number + + + +
      • +
    +
  7. ambientDecayRate per-frame decay of ambientColor (spread over TTL frames) +
      +
    • + ambientRedDecay + number + + + +
      • +
    • + ambientGreenDecay + number + + + +
      • +
    • + ambientBlueDecay + number + + + +
      • +
    +
  8. diffuseDecayRate per-frame decay of diffuseColor (spread over TTL frames) +
      +
    • + diffuseRedDecay + number + + + +
      • +
    • + diffuseGreenDecay + number + + + +
      • +
    • + diffuseBlueDecay + number + + + +
      • +
    +
  9. specularDecayRate per-frame decay of specularColor (spread over TTL frames) +
      +
    • + specularRedDecay + number + + + +
      • +
    • + specularGreenDecay + number + + + +
      • +
    • + specularBlueDecay + number + + + +
      • +
    +
  10. decayFunctionType *DecayType = 0.0 -> interpret *DecayRate values as linear, else as exponential +
      +
    • + ambientDecayType + number + + + +
      • +
    • + diffuseDecayType + number + + + +
      • +
    • + specularDecayType + number + + + +
      • +
    +
  11. + radius + number + + + +
    12. +
  12. + fov + number + + + +
    13. +
  13. + ttl + number + + + +
    14. +
  14. + priority + number + + + +
    15. +
  15. + ignoreLOS + bool + + + +
    16. +
+ + + + +
+

+ Spring.AddMapLight(lightParams) +

+

+
+

+ + + requires MaxDynamicMapLights > 0 + +

+ + +

Parameters:

+
    +
  1. + lightParams + lightParams + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + lightHandle
    2. +
+ + + +
+

+ Spring.AddModelLight(lightParams) +

+

+
+

+ + + requires MaxDynamicMapLights > 0 + +

+ + +

Parameters:

+
    +
  1. + lightParams + lightParams + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + lightHandle
    2. +
+ + + +
+

+ Spring.UpdateMapLight(lightHandle, lightParams) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + lightHandle + number + + + +
    2. +
  2. + lightParams + lightParams + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.UpdateModelLight(lightHandle, lightParams) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + lightHandle + number + + + +
    2. +
  2. + lightParams + lightParams + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.AddLightTrackingTarget() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.SetMapLightTrackingState(lightHandle, unitOrProjectileID, enableTracking, unitOrProjectile) +

+

Set a map-illuminating light to start/stop tracking the position of a moving object (unit or projectile)

+
+

+ +

+ + +

Parameters:

+
    +
  1. + lightHandle + number + + + +
    2. +
  2. + unitOrProjectileID + number + + + +
    3. +
  3. + enableTracking + bool + + + +
    4. +
  4. + unitOrProjectile + bool + + + +
    5. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Spring.SetModelLightTrackingState(lightHandle, unitOrProjectileID, enableTracking, unitOrProjectile) +

+

Set a model-illuminating light to start/stop tracking the position of a moving object (unit or projectile)

+
+

+ +

+ + +

Parameters:

+
    +
  1. + lightHandle + number + + + +
    2. +
  2. + unitOrProjectileID + number + + + +
    3. +
  3. + enableTracking + bool + + + +
    4. +
  4. + unitOrProjectile + bool + + + +
    5. +
+ +

Returns:

+
    +
  1. + bool + success
    2. +
+ + + +
+

+ Unit custom rendering +

+ +

+ +

+

+

+ Spring.SetUnitNoDraw(unitID, noDraw) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + noDraw + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitEngineDrawMask(unitID, drawMask) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + drawMask + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitAlwaysUpdateMatrix(unitID, alwaysUpdateMatrix) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + alwaysUpdateMatrix + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitNoMinimap(unitID, unitNoMinimap) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitNoMinimap + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitNoSelect(unitID, unitNoSelect) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitNoSelect + bool + whether unit can be selected or not +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitLeaveTracks(unitID, unitLeaveTracks) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + unitLeaveTracks + bool + whether unit leaves tracks on movement +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitSelectionVolumeData(unitID, featureID, scaleX, scaleY, scaleZ, offsetX, offsetY, offsetZ, vType, tType, Axis) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + featureID + number + + + +
    3. +
  3. + scaleX + number + + + +
    4. +
  4. + scaleY + number + + + +
    5. +
  5. + scaleZ + number + + + +
    6. +
  6. + offsetX + number + + + +
    7. +
  7. + offsetY + number + + + +
    8. +
  8. + offsetZ + number + + + +
    9. +
  9. + vType + number + + + +
    10. +
  10. + tType + number + + + +
    11. +
  11. + Axis + number + + + +
    12. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Features +

+ +

+ +

+

+

+ Spring.SetFeatureNoDraw(featureID, noDraw) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + noDraw + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureEngineDrawMask(featureID, engineDrawMask) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + engineDrawMask + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureAlwaysUpdateMatrix(featureID, alwaysUpdateMat) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + alwaysUpdateMat + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureFade(featureID, allow) +

+

Control whether a feature will fade or not when zoomed out.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + allow + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetFeatureSelectionVolumeData(featureID, scaleX, scaleY, scaleZ, offsetX, offsetY, offsetZ, vType, tType, Axis) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
  2. + scaleX + number + + + +
    3. +
  3. + scaleY + number + + + +
    4. +
  4. + scaleZ + number + + + +
    5. +
  5. + offsetX + number + + + +
    6. +
  6. + offsetY + number + + + +
    7. +
  7. + offsetZ + number + + + +
    8. +
  8. + vType + number + + + +
    9. +
  9. + tType + number + + + +
    10. +
  10. + Axis + number + + + +
    11. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Unit Icons +

+ +

+ +

+

+

+ Spring.AddUnitIcon(iconName, texFile[, size[, dist[, radAdjust]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + iconName + string + + + +
    2. +
  2. + texFile + string + + + +
    3. +
  3. + size + number + + + + (optional) +
    4. +
  4. + dist + number + + + + (optional) +
    5. +
  5. + radAdjust + number + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil or bool + added
    2. +
+ + + +
+

+ Spring.FreeUnitIcon(iconName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + iconName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + freed
    2. +
+ + + +
+

+ Spring.UnitIconSetDraw(unitID, drawIcon) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + drawIcon + bool + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitDefIcon(unitDefID, iconName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
  2. + iconName + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetUnitDefImage(unitDefID, image) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
  2. + image + string + luaTexture|texFile +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Virtual File System +

+ +

+ + +

Prefer using VFS whenever possible

+
+

+

+ Spring.ExtractModArchiveFile(modfile) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + modfile + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + bool + extracted
    2. +
+ + + +
+

+ Spring.CreateDir(path) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + path + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + dirCreated
    2. +
+ + + +
+

+ Spring.AllocateTable(narr, nrec) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + narr + number + hint for count of array elements +
    2. +
  2. + nrec + number + hint for count of record elements +
    3. +
+ +

Returns:

+
    +
  1. + table + + +
    2. +
+ + + +
+

+ GUI +

+ +

+ +

+

+

+ Spring.SetActiveCommand(action[, actionExtra]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + action + string + + + +
    2. +
  2. + actionExtra + string + + + + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + nil or bool + commandSet
    2. +
+ + + +
+

+ Spring.SetActiveCommand(cmdIndex[, button=1][, leftClick], rightClick, alt, ctrl, meta, shift) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cmdIndex + number + + + +
    2. +
  2. + button + number + + + + (default 1) +
    3. +
  3. + leftClick + bool + + + + (optional) +
    4. +
  4. + rightClick + optional bool + + + +
    5. +
  5. + alt + optional bool + + + +
    6. +
  6. + ctrl + optional bool + + + +
    7. +
  7. + meta + optional bool + + + +
    8. +
  8. + shift + optional bool + + + +
    9. +
+ +

Returns:

+
    +
  1. + nil or bool + commandSet
    2. +
+ + + +
+

+ Spring.LoadCmdColorsConfig(config) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + config + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.LoadCtrlPanelConfig(config) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + config + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ForceLayoutUpdate() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetDrawSelectionInfo(enable) +

+

Disables the "Selected Units x" box in the GUI.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + enable + bool + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetBoxSelectionByEngine(state) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + state + bool + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetTeamColor(teamID, r, g, b) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + r + number + + + +
    3. +
  3. + g + number + + + +
    4. +
  4. + b + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.AssignMouseCursor(cmdName, iconFileName[, overwrite=true[, hotSpotTopLeft=false]]) +

+

Changes/creates the cursor of a single CursorCmd.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cmdName + string + + + +
    2. +
  2. + iconFileName + string + +

    not the full filename, instead it is like this:

    +
     Wanted filename: Anims/cursorattack_0.bmp
+ => iconFileName: cursorattack
+
    + +
    3. +
  3. + overwrite + bool + + + + (default true) +
    4. +
  4. + hotSpotTopLeft + bool + + + + (default false) +
    5. +
+ +

Returns:

+
    +
  1. + nil or bool + assigned
    2. +
+ + + +
+

+ Spring.ReplaceMouseCursor(oldFileName, newFileName[, hotSpotTopLeft=false]) +

+

Mass replace all occurrences of the cursor in all CursorCmds.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + oldFileName + string + + + +
    2. +
  2. + newFileName + string + + + +
    3. +
  3. + hotSpotTopLeft + bool + + + + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + nil or bool + assigned
    2. +
+ + + +
+

+ Spring.SetCustomCommandDrawData(cmdID[, cmdReference]) +

+

Register your custom cmd so it gets visible in the unit's cmd queue

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cmdID + number + + + +
    2. +
  2. + cmdReference + string or number + iconname | cmdID_cloneIcon + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + nil or bool + assigned
    2. +
+ + + +
+

+ Mouse +

+ +

+ +

+

+

+ Spring.WarpMouse(x, y) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetMouseCursor(cursorName[, cursorScale=1.0]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cursorName + string + + + +
    2. +
  2. + cursorScale + number + + + + (default 1.0) +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ LOS Colors +

+ +

+ +

+

+

+ Spring.SetLosViewColors(always, LOS, radar, jam, radar2) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + always + table + {r,g,b} +
    2. +
  2. + LOS + table + = {r,g,b} +
    3. +
  3. + radar + table + = {r,g,b} +
    4. +
  4. + jam + table + = {r,g,b} +
    5. +
  5. + radar2 + table + = {r,g,b} +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetNanoProjectileParams([rotVal=0[, rotVel=0[, rotAcc=0[, rotValRng=0[, rotVelRng=0[, rotAccRng=0]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + rotVal + number + in degrees + (default 0) +
    2. +
  2. + rotVel + number + in degrees + (default 0) +
    3. +
  3. + rotAcc + number + in degrees + (default 0) +
    4. +
  4. + rotValRng + number + in degrees + (default 0) +
    5. +
  5. + rotVelRng + number + in degrees + (default 0) +
    6. +
  6. + rotAccRng + number + in degrees + (default 0) +
    7. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Engine Config +

+ +

+ + +

The following functions read the engine configs saved in Springsettings.cfg, a version-ed instance of these or a custom file supplied on the command line.

+
+

+

+ Spring.SetConfigInt(name, value[, useOverlay=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + name + string + + + +
    2. +
  2. + value + number + + + +
    3. +
  3. + useOverlay + bool + the value will only be set in memory, and not be restored for the next game. + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetConfigFloat(name, value[, useOverla=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + name + string + + + +
    2. +
  2. + value + number + + + +
    3. +
  3. + useOverla + bool + the value will only be set in memory, and not be restored for the next game.y + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetConfigString(name, value[, useOverlay=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + name + string + + + +
    2. +
  2. + value + number + + + +
    3. +
  3. + useOverlay + bool + the value will only be set in memory, and not be restored for the next game. + (default false) +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.Quit() +

+

Closes the application

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Unit Group +

+ +

+ +

+

+

+ Spring.SetUnitGroup(unitID, groupID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + groupID + number + the group number to be assigned, or -1 for deassignment +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ UI +

+ +

+ +

Very important! (allows synced inter-lua-enviroment communications)

+
+

+

+ Spring.SendLuaUIMsg(message, mode) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + message + string + + + +
    2. +
  2. + mode + string + "s"/"specs" | "a"/"allies" +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SendLuaGaiaMsg(message) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + message + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SendLuaRulesMsg(message) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + message + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SendLuaMenuMsg(msg) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + msg + string + + + +
    2. +
+ + + + +
+

+ Spring.SetLastMessagePosition(x, y, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Sharing +

+ +

+ +

+

+

+ Spring.SetShareLevel(resource, shareLevel) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + resource + string + metal | energy +
    2. +
  2. + shareLevel + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ShareResources(teamID, units) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + units + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ShareResources(teamID, resource, amount) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
  2. + resource + string + metal | energy +
    3. +
  3. + amount + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Markers +

+ +

+ +

+

+

+ Spring.MarkerAddPoint(x, y, z[, text=""[, localOnly]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
  4. + text + string + + + + (default "") +
    5. +
  5. + localOnly + bool + + + + (optional) +
    6. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.MarkerAddLine(x1, y1, z1, x2, y2, z2[, localOnly=false[, playerId]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x1 + number + + + +
    2. +
  2. + y1 + number + + + +
    3. +
  3. + z1 + number + + + +
    4. +
  4. + x2 + number + + + +
    5. +
  5. + y2 + number + + + +
    6. +
  6. + z2 + number + + + +
    7. +
  7. + localOnly + bool + + + + (default false) +
    8. +
  8. + playerId + number + + + + (optional) +
    9. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.MarkerErasePosition(x, y, z, noop[, localOnly=false[, playerId[, alwaysErase=false]]]) +

+

+
+

+ + + Issue an erase command for markers on the map. + +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
  4. + noop + + + +
    5. +
  5. + localOnly + bool + do not issue a network message, erase only for the current player + (default false) +
    6. +
  6. + playerId + number + when not specified it uses the issuer playerId + (optional) +
    7. +
  7. + alwaysErase + bool + erase any marker when localOnly and current player is spectating. Allows spectators to erase players markers locally + (default false) +
    8. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Sun +

+ +

+ +

+

+

+ Spring.SetAtmosphere(params) +

+

It can be used to modify the following atmosphere parameters

+
+

+ +

+ + +

Parameters:

+
    +
  1. params + + +
      +
    • + fogStart + number + + + +
      • +
    • + fogEnd + number + + + +
      • +
    • + sunColor + rgb + + + +
      • +
    • + skyColor + rgb + + + +
      • +
    • + cloudColor + rgb + + + +
      • +
    +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +

Usage:

+
    + 
  • Spring.SetAtmosphere({ fogStart = 0, fogEnd = 0.5, fogColor = { 0.7, 0.2, 0.2, 1 }})
    • +
+
+

+ Spring.SetSunDirection(dirX, dirY, dirZ[, intensity=true]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + dirX + number + + + +
    2. +
  2. + dirY + number + + + +
    3. +
  3. + dirZ + number + + + +
    4. +
  4. + intensity + number + + + + (default true) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetSunLighting(params) +

+

It can be used to modify the following sun lighting parameters

+
+

+ +

+ + +

Parameters:

+
    +
  1. params + + +
      +
    • + groundAmbientColor + rgb + + + +
      • +
    • + groundDiffuseColor + rgb + + + +
      • +
    +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +

Usage:

+
    + 
  • Spring.SetSunLighting({groundAmbientColor = {1, 0.1, 1}, groundDiffuseColor = {1, 0.1, 1} })
    • +
+
+

+ mapRenderingParams +

+

Map rendering params

+
+

+ +

+ + +

Fields:

+
    +
  1. + splatTexMults + rgba + + + +
    2. +
  2. + splatTexScales + rgba + + + +
    3. +
  3. + voidWater + bool + + + +
    4. +
  4. + voidGround + bool + + + +
    5. +
  5. + splatDetailNormalDiffuseAlpha + bool + + + +
    6. +
+ + + + +
+

+ Spring.SetMapRenderingParams(params) +

+

Allows to change map rendering params at runtime.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + params + mapRenderingParams + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ForceTesselationUpdate([normal=true[, shadow=false]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + normal + bool + + + + (default true) +
    2. +
  2. + shadow + bool + + + + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + bool + updated
    2. +
+ + + +
+

+ AI +

+ +

+ +

+

+

+ Spring.SendSkirmishAIMessage(aiTeam, message) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + aiTeam + number + + + +
    2. +
  2. + message + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil or bool + ai_processed
    2. +
+ + + +
+

+ Developers +

+ +

+ +

+

+

+ Spring.SetLogSectionFilterLevel(sectionName, logLevel) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + sectionName + string + + + +
    2. +
  2. + logLevel + string or number + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.GarbageCollectCtrl([itersPerBatch[, numStepsPerIter[, minStepsPerIter[, maxStepsPerIter[, minLoopRunTime[, maxLoopRunTime[, baseRunTimeMult[, baseMemLoadMult]]]]]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + itersPerBatch + int + + + + (optional) +
    2. +
  2. + numStepsPerIter + int + + + + (optional) +
    3. +
  3. + minStepsPerIter + int + + + + (optional) +
    4. +
  4. + maxStepsPerIter + int + + + + (optional) +
    5. +
  5. + minLoopRunTime + number + + + + (optional) +
    6. +
  6. + maxLoopRunTime + number + + + + (optional) +
    7. +
  7. + baseRunTimeMult + number + + + + (optional) +
    8. +
  8. + baseMemLoadMult + number + + + + (optional) +
    9. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetDrawSky(drawSky) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + drawSky + bool + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetDrawWater(drawWater) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + drawWater + bool + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetDrawGround(drawGround) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + drawGround + bool + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetDrawGroundDeferred(drawGroundDeferred[, drawGroundForward]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + drawGroundDeferred + bool + + + +
    2. +
  2. + drawGroundForward + bool + allows disabling of the forward pass + treturn nil + (optional) +
    3. +
+ + + + +
+

+ Spring.SetDrawModelsDeferred(drawUnitsDeferred, drawFeaturesDeferred[, drawUnitsForward[, drawFeaturesForward]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + drawUnitsDeferred + bool + + + +
    2. +
  2. + drawFeaturesDeferred + bool + + + +
    3. +
  3. + drawUnitsForward + bool + allows disabling of the respective forward passes + (optional) +
    4. +
  4. + drawFeaturesForward + bool + allows disabling of the respective forward passes + (optional) +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetVideoCapturingMode(allowCaptureMode) +

+

This doesn't actually record the game in any way, it just regulates the framerate and interpolations.

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allowCaptureMode + bool + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetVideoCapturingTimeOffset(timeOffset) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + timeOffset + bool + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ waterParams +

+

Water params

+
+

+ +

+ + +

Fields:

+
    +
  1. + absorb + rgb + + + +
    2. +
  2. + baseColor + rgb + + + +
    3. +
  3. + minColor + rgb + + + +
    4. +
  4. + surfaceColor + rgb + + + +
    5. +
  5. + diffuseColor + rgb + + + +
    6. +
  6. + specularColor + rgb + + + +
    7. +
  7. + planeColor + rgb + + + +
    8. +
  8. + texture + string + file +
    9. +
  9. + foamTexture + string + file +
    10. +
  10. + normalTexture + string + file +
    11. +
  11. + damage + number + + + +
    12. +
  12. + repeatX + number + + + +
    13. +
  13. + repeatY + number + + + +
    14. +
  14. + surfaceAlpha + number + + + +
    15. +
  15. + ambientFactor + number + + + +
    16. +
  16. + diffuseFactor + number + + + +
    17. +
  17. + specularFactor + number + + + +
    18. +
  18. + specularPower + number + + + +
    19. +
  19. + fresnelMin + number + + + +
    20. +
  20. + fresnelMax + number + + + +
    21. +
  21. + fresnelPower + number + + + +
    22. +
  22. + reflectionDistortion + number + + + +
    23. +
  23. + blurBase + number + + + +
    24. +
  24. + blurExponent + number + + + +
    25. +
  25. + perlinStartFreq + number + + + +
    26. +
  26. + perlinLacunarity + number + + + +
    27. +
  27. + perlinAmplitude + number + + + +
    28. +
  28. + numTiles + number + + + +
    29. +
  29. + shoreWaves + bool + + + +
    30. +
  30. + forceRendering + bool + + + +
    31. +
  31. + hasWaterPlane + bool + + + +
    32. +
+ + + + +
+

+ Spring.SetWaterParams(waterParams) +

+

+
+

+ + + Does not need cheating enabled. + Allows to change water params (mostly BumpWater ones) at runtime. You may want to set BumpWaterUseUniforms in your springrc to 1, then you don't even need to restart BumpWater via `/water 4`. + +

+ + +

Parameters:

+
    +
  1. + waterParams + waterParams + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Preload +

+ +

+ +

+

+

+ Spring.PreloadUnitDefModel(unitDefID) +

+

+
+

+ + + Allow the engine to load the unit's model (and texture) in a background thread. + Wreckages and buildOptions of a unit are automatically preloaded. + +

+ + +

Parameters:

+
    +
  1. + unitDefID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.PreloadFeatureDefModel(featureDefID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureDefID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.PreloadSoundItem(name) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + name + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.LoadModelTextures(modelName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + modelName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + success
    2. +
+ + + +
+

+ SDL Text +

+ +

+ +

+

+

+ Spring.SDLSetTextInputRect(x, y, width, height) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + width + number + + + +
    4. +
  4. + height + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SDLStartTextInput() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SDLStopTextInput() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Window Management +

+ +

+ +

+

+

+ Spring.SetWindowGeometry(displayIndex, winRelPosX, winRelPosY, winSizeX, winSizeY, fullScreen, borderless) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + displayIndex + number + + + +
    2. +
  2. + winRelPosX + number + + + +
    3. +
  3. + winRelPosY + number + + + +
    4. +
  4. + winSizeX + number + + + +
    5. +
  5. + winSizeY + number + + + +
    6. +
  6. + fullScreen + bool + + + +
    7. +
  7. + borderless + bool + + + +
    8. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetWindowMinimized() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + minimized
    2. +
+ + + +
+

+ Spring.SetWindowMaximized() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + maximized
    2. +
+ + + +
+

+ Misc +

+ +

+ +

+

+

+ Spring.Reload(startScript) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + startScript + string + the CONTENT of the script.txt spring should use to start. +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.Restart(commandline_args, startScript) +

+

+
+

+ + + If this call returns, something went wrong + +

+ + +

Parameters:

+
    +
  1. + commandline_args + string + commandline arguments passed to spring executable. +
    2. +
  2. + startScript + string + + + +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.Start(commandline_args, startScript) +

+

Launches a new Spring instance without terminating the existing one.

+
+

+ + + If this call returns, something went wrong + +

+ + +

Parameters:

+
    +
  1. + commandline_args + string + commandline arguments passed to spring executable. +
    2. +
  2. + startScript + string + the CONTENT of the script.txt spring should use to start (if empty, no start-script is added, you can still point spring to your custom script.txt when you add the file-path to commandline_args. +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetWMIcon(iconFileName) +

+

Sets the icon for the process which is seen in the OS task-bar and other places (default: spring-logo).

+
+

+ + + Note: has to be 24bit or 32bit. + Note: on windows, it has to be 32x32 pixels in size (recommended for cross-platform) + Note: *.bmp images have to be in BGR format (default for m$ ones). + Note: *.ico images are not supported. + +

+ + +

Parameters:

+
    +
  1. + iconFileName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ SetWMCaption(title[, titleShort=title]) +

+

Sets the window title for the process (default: "Spring ").

+
+

+ + + The shortTitle is displayed in the OS task-bar (default: "Spring "). + + NOTE: shortTitle is only ever possibly used under X11 (Linux & OS X), but not with QT (KDE) and never under Windows. + +

+ + +

Parameters:

+
    +
  1. + title + string + + + +
    2. +
  2. + titleShort + string + + + + (default title) +
    3. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ClearWatchDogTimer([threadName=main]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + threadName + string + + + + (default main) +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.SetClipboard(text) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + text + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.Yield() +

+

Relinquish control of the game loading thread and OpenGL context back to the UI (LuaIntro).

+
+

+ + + Should be called after each widget/unsynced gadget is loaded in widget/gadget handler. Use it to draw screen updates and process windows events. + +

+ + + +

Returns:

+
    +
  1. + bool + when true caller should continue calling Spring.Yield during the widgets/gadgets load, when false it shouldn't call it any longer.
    2. +
+ + + +

Usage:

+
    + 
  • local wantYield = Spring.Yield and Spring.Yield() -- nil check: not present in synced
+for wupget in pairs(wupgetsToLoad) do
+  loadWupget(wupget)
+  wantYield = wantYield and Spring.Yield()
+end
    • +
+
+ +{% endraw %} diff --git a/ldoc/modules/UnsyncedRead.html b/ldoc/modules/UnsyncedRead.html new file mode 100644 index 0000000000..2a792f8f28 --- /dev/null +++ b/ldoc/modules/UnsyncedRead.html @@ -0,0 +1,7120 @@ +--- +layout: default +title: UnsyncedRead +permalink: ldoc/modules/UnsyncedRead.html +description: Callouts to get state +parent: Lua API +table: 0x55953a3b20c0 +--- + +{% raw %} +

Module UnsyncedRead

+

Callouts to get state

+

+ +

+

+

See also:

+ + +

Decals

+
+
+ Spring.GetAllGroundDecals +
+
+ + + +
+
+ Spring.GetGroundDecalMiddlePos +
+
+ + + +
+
+ Spring.GetDecalQuadPos +
+
+ + + +
+
+ Spring.GetGroundDecalSizeAndHeight +
+
+ + + +
+
+ Spring.GetGroundDecalRotation +
+
+ + + +
+
+ Spring.GetGroundDecalTexture +
+
+ + + +
+
+ Spring.GetDecalTextures +
+
+ + + +
+
+ Spring.SetGroundDecalTextureParams +
+
+ + + +
+
+ Spring.GetGroundDecalAlpha +
+
+ + + +
+
+ Spring.GetGroundDecalNormal +
+
+ + + +
+
+ Spring.GetGroundDecalTint +
+
+ + + +
+
+ Spring.GetGroundDecalMisc +
+
+ + + +
+
+ Spring.GetGroundDecalCreationFrame +
+
+ + + +
+
+ Spring.GetGroundDecalOwner +
+
+ + + +
+
+ Spring.GetGroundDecalType +
+
+ + + +
+
+

Misc

+
+
+ Spring.GetUnitTransformMatrix +
+
+ + + +
+
+ Spring.GetFeatureTransformMatrix +
+
+ + + +
+
+ Spring.GetSyncedGCInfo +
+
+ + + +
+
+

Replay

+
+
+ Spring.IsReplay +
+
+ + + +
+
+ Spring.GetReplayLength +
+
+ + + +
+
+

Game/Menu Name

+
+
+ Spring.GetGameName +
+
+ + + +
+
+ Spring.GetMenuName +
+
+ + + +
+
+

Profiling

+
+
+ Spring.GetProfilerTimeRecord +
+
+ + + +
+
+ Spring.GetProfilerRecordNames +
+
+ + + +
+
+ Spring.GetLuaMemUsage +
+
+ + + +
+
+ Spring.GetVidMemUsage +
+
+ + + +
+
+

Class Timer

+
+
+ Spring.GetTimer +
+
+ Get a timer with millisecond resolution +
+
+ Spring.GetTimerMicros +
+
+ Get a timer with microsecond resolution +
+
+ Spring.GetFrameTimer +
+
+ Get a timer for the start of the frame +
+
+ Spring.DiffTimers +
+
+ + + +
+
+

Screen/Rendering Info

+
+
+ Spring.GetNumDisplays +
+
+ + + +
+
+ Spring.GetViewGeometry +
+
+ Get main view geometry (map and game rendering) +
+
+ Spring.GetDualViewGeometry +
+
+ Get dual view geometry (minimap when enabled) +
+
+ Spring.GetWindowGeometry +
+
+ Get main window geometry +
+
+ Spring.GetWindowDisplayMode +
+
+ Get main window display mode +
+
+ Spring.GetScreenGeometry +
+
+ Get screen geometry +
+
+ Spring.GetMiniMapGeometry +
+
+ Get minimap geometry +
+
+ Spring.GetMiniMapRotation +
+
+ Get minimap rotation +
+
+ Spring.GetMiniMapDualScreen +
+
+ + + +
+
+ Spring.GetSelectionBox +
+
+ Get vertices from currently active selection box +
+
+ Spring.GetDrawSelectionInfo +
+
+ + + +
+
+ Spring.IsAboveMiniMap +
+
+ + + +
+
+ Spring.GetDrawFrame +
+
+ + + +
+
+ Spring.GetFrameTimeOffset +
+
+ + + +
+
+ Spring.GetLastUpdateSeconds +
+
+ + + +
+
+ Spring.GetVideoCapturingMode +
+
+ + + +
+
+

Unit attributes

+
+
+ Spring.IsUnitAllied +
+
+ + + +
+
+ Spring.IsUnitSelected +
+
+ + + +
+
+ Spring.GetUnitLuaDraw +
+
+ + + +
+
+ Spring.GetUnitNoDraw +
+
+ + + +
+
+ Spring.GetUnitEngineDrawMask +
+
+ + + +
+
+ Spring.GetUnitAlwaysUpdateMatrix +
+
+ + + +
+
+ Spring.GetUnitDrawFlag +
+
+ + + +
+
+ Spring.GetUnitNoMinimap +
+
+ + + +
+
+ Spring.GetUnitNoSelect +
+
+ + + +
+
+ Spring.UnitIconGetDraw +
+
+ + + +
+
+ Spring.GetUnitSelectionVolumeData +
+
+ + + +
+
+

Feature attributes

+
+
+ Spring.GetFeatureLuaDraw +
+
+ + + +
+
+ Spring.GetFeatureNoDraw +
+
+ + + +
+
+ Spring.GetFeatureEngineDrawMask +
+
+ + + +
+
+ Spring.GetFeatureAlwaysUpdateMatrix +
+
+ + + +
+
+ Spring.GetFeatureDrawFlag +
+
+ + + +
+
+ Spring.GetFeatureSelectionVolumeData +
+
+ + + +
+
+

Inview

+
+
+ Spring.IsUnitInView +
+
+ + + +
+
+ Spring.IsUnitVisible +
+
+ + + +
+
+ Spring.IsUnitIcon +
+
+ + + +
+
+ Spring.IsAABBInView +
+
+ + + +
+
+ Spring.IsSphereInView +
+
+ + + +
+
+ Spring.GetUnitViewPosition +
+
+ + + +
+
+ Spring.GetVisibleUnits +
+
+ + + +
+
+ Spring.GetVisibleFeatures +
+
+ + + +
+
+ Spring.GetVisibleProjectiles +
+
+ + + +
+
+ Spring.GetRenderUnits +
+
+ + + +
+
+ Spring.GetRenderUnitsDrawFlagChanged +
+
+ + + +
+
+ Spring.GetRenderFeatures +
+
+ + + +
+
+ Spring.GetRenderFeaturesDrawFlagChanged +
+
+ + + +
+
+ Spring.ClearUnitsPreviousDrawFlag +
+
+ + + +
+
+ Spring.ClearFeaturesPreviousDrawFlag +
+
+ + + +
+
+ Spring.GetUnitsInScreenRectangle +
+
+ Get units inside a rectangle area on the map +
+
+ Spring.GetFeaturesInScreenRectangle +
+
+ Get features inside a rectangle area on the map +
+
+ Spring.GetLocalPlayerID +
+
+ + + +
+
+ Spring.GetLocalTeamID +
+
+ + + +
+
+ Spring.GetLocalAllyTeamID +
+
+ + + +
+
+ Spring.GetSpectatingState +
+
+ + + +
+
+ Spring.GetSelectedUnits +
+
+ + + +
+
+ Spring.GetSelectedUnitsSorted +
+
+ Get selected units aggregated by unitDefID +
+
+ Spring.GetSelectedUnitsCounts +
+
+ Get an aggregate count of selected units per unitDefID +
+
+ Spring.GetSelectedUnitsCount +
+
+ Returns the amount of selected units +
+
+ Spring.GetBoxSelectionByEngine +
+
+ Get if selection box is handled by engine +
+
+ Spring.IsGUIHidden +
+
+ + + +
+
+ Spring.HaveShadows +
+
+ + + +
+
+ Spring.HaveAdvShading +
+
+ + + +
+
+ Spring.GetWaterMode +
+
+ + + +
+
+ Spring.GetMapDrawMode +
+
+ + + +
+
+ Spring.GetMapSquareTexture +
+
+ + + +
+
+ rgb +
+
+ Color triple (RGB) +
+
+ Spring.GetLosViewColors +
+
+ + + +
+
+ Spring.GetNanoProjectileParams +
+
+ + + +
+
+ Spring.GetCameraNames +
+
+ Get available cameras +
+
+ camState +
+
+ Parameters for camera state +
+
+ Spring.GetCameraState +
+
+ + + +
+
+ Spring.GetCameraPosition +
+
+ + + +
+
+ Spring.GetCameraDirection +
+
+ + + +
+
+ Spring.GetCameraRotation +
+
+ + + +
+
+ Spring.GetCameraFOV +
+
+ + + +
+
+ xyz +
+
+ Cartesian triple (XYZ) +
+
+ Spring.GetCameraVectors +
+
+ + + +
+
+ Spring.WorldToScreenCoords +
+
+ + + +
+
+ Spring.TraceScreenRay +
+
+ Get information about a ray traced from screen to world position +
+
+ Spring.GetPixelDir +
+
+ + + +
+
+ Spring.GetTeamColor +
+
+ + + +
+
+ Spring.GetTeamOrigColor +
+
+ + + +
+
+ Spring.GetDrawSeconds +
+
+ + + +
+
+

Sound

+
+
+ Spring.GetSoundStreamTime +
+
+ + + +
+
+ Spring.GetSoundEffectParams +
+
+ + + +
+
+

Game Speed

+
+
+ Spring.GetFPS +
+
+ + + +
+
+ Spring.GetGameSpeed +
+
+ + + +
+
+ Spring.GetGameState +
+
+ + + +
+
+

Commands

+
+
+ Spring.GetActiveCommand +
+
+ + + +
+
+ Spring.GetDefaultCommand +
+
+ + + +
+
+ cmdDesc +
+
+ Command Description +
+
+ Spring.GetActiveCmdDescs +
+
+ + + +
+
+ Spring.GetActiveCmdDesc +
+
+ + + +
+
+ Spring.GetCmdDescIndex +
+
+ + + +
+
+ Spring.GetBuildFacing +
+
+ + + +
+
+ Spring.GetBuildSpacing +
+
+ + + +
+
+ Spring.GetGatherMode +
+
+ + + +
+
+ Spring.GetActivePage +
+
+ + + +
+
+

Mouse State

+
+
+ Spring.GetMouseState +
+
+ + + +
+
+ Spring.GetMouseCursor +
+
+ + + +
+
+ Spring.GetMouseStartPosition +
+
+ + + +
+
+

Text

+
+
+ Spring.GetClipboard +
+
+ + + +
+
+ Spring.IsUserWriting +
+
+ + + +
+
+

Console

+
+
+ Spring.GetLastMessagePositions +
+
+ + + +
+
+ Spring.GetConsoleBuffer +
+
+ + + +
+
+ Spring.GetCurrentTooltip +
+
+ + + +
+
+

Key Input

+
+
+ Spring.GetKeyFromScanSymbol +
+
+ + + +
+
+ Spring.GetKeyState +
+
+ + + +
+
+ Spring.GetModKeyState +
+
+ + + +
+
+ Spring.GetPressedKeys +
+
+ + + +
+
+ Spring.GetPressedScans +
+
+ + + +
+
+ Spring.GetInvertQueueKey +
+
+ + + +
+
+ Spring.GetKeyCode +
+
+ + + +
+
+ Spring.GetKeySymbol +
+
+ + + +
+
+ Spring.GetScanSymbol +
+
+ + + +
+
+ keybindingSpec +
+
+ Keybinding spec +
+
+ Spring.GetKeyBindings +
+
+ + + +
+
+ Spring.GetActionHotKeys +
+
+ + + +
+
+

Unit Groups

+
+
+ Spring.GetGroupList +
+
+ + + +
+
+ Spring.GetSelectedGroup +
+
+ + + +
+
+ Spring.GetUnitGroup +
+
+ + + +
+
+ Spring.GetGroupUnits +
+
+ + + +
+
+ Spring.GetGroupUnitsSorted +
+
+ + + +
+
+ Spring.GetGroupUnitsCounts +
+
+ + + +
+
+ Spring.GetGroupUnitsCount +
+
+ + + +
+
+

Team/Player Info

+
+
+ rosterSpec +
+
+ Roster spec +
+
+ Spring.GetPlayerRoster +
+
+ + + +
+
+ Spring.GetPlayerTraffic +
+
+ + + +
+
+ Spring.GetPlayerStatistics +
+
+ + + +
+
+

Configuration

+
+
+ configSpec +
+
+ Configuration spec +
+
+ Spring.GetConfigParams +
+
+ + + +
+
+ Spring.GetConfigInt +
+
+ + + +
+
+ Spring.GetConfigFloat +
+
+ + + +
+
+ Spring.GetConfigString +
+
+ + + +
+
+ Spring.GetLogSections +
+
+ + + +
+
+ +

+ Decals +

+ +

+ +

+

+

+ Spring.GetAllGroundDecals() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[number],...} + decalIDs
    2. +
+ + + +
+

+ Spring.GetGroundDecalMiddlePos(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + posX
    2. +
  2. + number + posZ
    3. +
+ + + +
+

+ Spring.GetDecalQuadPos(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + posTL.x
    2. +
  2. + number + posTL.z
    3. +
  3. + number + posTR.x
    4. +
  4. + number + posTR.z
    5. +
  5. + number + posBR.x
    6. +
  6. + number + posBR.z
    7. +
  7. + number + posBL.x
    8. +
  8. + number + posBL.z
    9. +
+ + + +
+

+ Spring.GetGroundDecalSizeAndHeight(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + sizeX
    2. +
  2. + number + sizeY
    3. +
  3. + number + projCubeHeight
    4. +
+ + + +
+

+ Spring.GetGroundDecalRotation(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + rotation in radians
    2. +
+ + + +
+

+ Spring.GetGroundDecalTexture(decalID[, isMainTex=true]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
  2. + isMainTex + bool + If false, it gets the normals/glow map + (default true) +
    3. +
+ +

Returns:

+
    +
  1. + nil or string + texture
    2. +
+ + + +
+

+ Spring.GetDecalTextures([isMainTex=true]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + isMainTex + bool + If false, it gets the texture for normals/glow maps + (default true) +
    2. +
+ +

Returns:

+
    +
  1. + {[string],...} + textureNames All textures on the atlas and available for use in SetGroundDecalTexture
    2. +
+ + + +
+

+ Spring.SetGroundDecalTextureParams(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + texWrapDistance if non-zero sets the mode to repeat the texture along the left-right direction of the decal every texWrapFactor elmos
    2. +
  2. + number + texTraveledDistance shifts the texture repetition defined by texWrapFactor so the texture of a next line in the continuous multiline can start where the previous finished. For that it should collect all elmo lengths of the previously set multiline segments.
    3. +
+ + + +
+

+ Spring.GetGroundDecalAlpha(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + alpha Between 0 and 1
    2. +
  2. + number + alphaFalloff Between 0 and 1, per second
    3. +
+ + + +
+

+ Spring.GetGroundDecalNormal(decalID) +

+

+
+

+ + + If all three equal 0, the decal follows the normals of ground at midpoint + +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + normal.x
    2. +
  2. + number + normal.y
    3. +
  3. + number + normal.z
    4. +
+ + + +
+

+ Spring.GetGroundDecalTint(decalID) +

+

+
+

+ + Gets the tint of the ground decal. + A color of (0.5, 0.5, 0.5, 0.5) is effectively no tint +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + tintR
    2. +
  2. + number + tintG
    3. +
  3. + number + tintB
    4. +
  4. + number + tintA
    5. +
+ + + +
+

+ Spring.GetGroundDecalMisc(decalID) +

+

+
+

+ + Returns less important parameters of a ground decal +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + dotElimExp
    2. +
  2. + number + refHeight
    3. +
  3. + number + minHeight
    4. +
  4. + number + maxHeight
    5. +
  5. + number + forceHeightMode
    6. +
+ + + +
+

+ Spring.GetGroundDecalCreationFrame(decalID) +

+

+
+

+ + + Min can be not equal to max for "gradient" style decals, e.g. unit tracks + +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + creationFrameMin
    2. +
  2. + number + creationFrameMax
    3. +
+ + + +
+

+ Spring.GetGroundDecalOwner(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + unitID|number featureID(+MAX_UNITS)
    2. +
+ + + +
+

+ Spring.GetGroundDecalType(decalID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + decalID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or string + type "explosion"|"plate"|"lua"|"track"|"unknown"
    2. +
+ + + +
+

+ Misc +

+ +

+ +

+

+

+ Spring.GetUnitTransformMatrix(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number or nil + m11 nil when unitID cannot be parsed
    2. +
  2. + number + m12
    3. +
  3. + number + m13
    4. +
  4. + number + m14
    5. +
  5. + number + m21
    6. +
  6. + number + m22
    7. +
  7. + number + m23
    8. +
  8. + number + m24
    9. +
  9. + number + m31
    10. +
  10. + number + m32
    11. +
  11. + number + m33
    12. +
  12. + number + m34
    13. +
  13. + number + m41
    14. +
  14. + number + m42
    15. +
  15. + number + m43
    16. +
  16. + number + m44
    17. +
+ + + +
+

+ Spring.GetFeatureTransformMatrix(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number or nil + m11 nil when featureID cannot be parsed
    2. +
  2. + number + m12
    3. +
  3. + number + m13
    4. +
  4. + number + m14
    5. +
  5. + number + m21
    6. +
  6. + number + m22
    7. +
  7. + number + m23
    8. +
  8. + number + m24
    9. +
  9. + number + m31
    10. +
  10. + number + m32
    11. +
  11. + number + m33
    12. +
  12. + number + m34
    13. +
  13. + number + m41
    14. +
  14. + number + m42
    15. +
  15. + number + m43
    16. +
  16. + number + m44
    17. +
+ + + +
+

+ Spring.GetSyncedGCInfo([collectGC=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + collectGC + bool + collect before returning metric + (default false) +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + GC values are expressed in Kbytes: #bytes/2^10
    2. +
+ + + +
+

+ Replay +

+ +

+ +

+

+

+ Spring.IsReplay() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or bool + isReplay
    2. +
+ + + +
+

+ Spring.GetReplayLength() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or number + timeInSeconds
    2. +
+ + + +
+

+ Game/Menu Name +

+ +

+ +

+

+

+ Spring.GetGameName() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + string + name
    2. +
+ + + +
+

+ Spring.GetMenuName() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + string + name name .. version from Modinfo.lua. E.g. "Spring: 1944 test-5640-ac2d15b".
    2. +
+ + + +
+

+ Profiling +

+ +

+ +

+

+

+ Spring.GetProfilerTimeRecord(profilerName[, frameData=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + profilerName + string + + + +
    2. +
  2. + frameData + bool + + + + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + number + total in ms
    2. +
  2. + number + current in ms
    3. +
  3. + number + max_dt
    4. +
  4. + number + time_pct
    5. +
  5. + number + peak_pct
    6. +
  6. + nil or {[number]=number,...} + frameData where key is the frame index and value is duration
    7. +
+ + + +
+

+ Spring.GetProfilerRecordNames() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {string,...} + profilerNames
    2. +
+ + + +
+

+ Spring.GetLuaMemUsage() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + luaHandleAllocedMem in kilobytes
    2. +
  2. + number + luaHandleNumAllocs divided by 1000
    3. +
  3. + number + luaGlobalAllocedMem in kilobytes
    4. +
  4. + number + luaGlobalNumAllocs divided by 1000
    5. +
  5. + number + luaUnsyncedGlobalAllocedMem in kilobytes
    6. +
  6. + number + luaUnsyncedGlobalNumAllocs divided by 1000
    7. +
  7. + number + luaSyncedGlobalAllocedMem in kilobytes
    8. +
  8. + number + luaSyncedGlobalNumAllocs divided by 1000
    9. +
+ + + +
+

+ Spring.GetVidMemUsage() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + usedMem in MB
    2. +
  2. + number + availableMem in MB
    3. +
+ + + +
+

+ Class Timer +

+ +

+ Spring.GetTimer() +

+

Get a timer with millisecond resolution

+
+

+ +

+ + + +

Returns:

+
    +
  1. + Timer + + +
    2. +
+ + + +
+

+ Spring.GetTimerMicros() +

+

Get a timer with microsecond resolution

+
+

+ +

+ + + +

Returns:

+
    +
  1. + Timer + + +
    2. +
+ + + +
+

+ Spring.GetFrameTimer([lastFrameTime=false]) +

+

Get a timer for the start of the frame

+
+

+ + + This should give better results for camera interpolations + +

+ + +

Parameters:

+
    +
  1. + lastFrameTime + bool + whether to use last frame time instead of last frame start + (default false) +
    2. +
+ +

Returns:

+
    +
  1. + Timer + + +
    2. +
+ + + +
+

+ Spring.DiffTimers(endTimer, startTimer[, returnMs=false[, fromMicroSecs=false]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + endTimer + Timer + + + +
    2. +
  2. + startTimer + Timer + + + +
    3. +
  3. + returnMs + bool + whether to return timeAmount in milliseconds as opposed to seconds + (default false) +
    4. +
  4. + fromMicroSecs + bool + whether timers are in microseconds instead of milliseconds + (default false) +
    5. +
+ +

Returns:

+
    +
  1. + number + timeAmount
    2. +
+ + + +
+

+ Screen/Rendering Info +

+ +

+ +

+

+

+ Spring.GetNumDisplays() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + numDisplays as returned by SDL_GetNumVideoDisplays
    2. +
+ + + +
+

+ Spring.GetViewGeometry() +

+

Get main view geometry (map and game rendering)

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + viewSizeX in px
    2. +
  2. + number + viewSizeY in px
    3. +
  3. + number + viewPosX offset from leftmost screen left border in px
    4. +
  4. + number + viewPosY offset from bottommost screen bottom border in px
    5. +
+ + + +
+

+ Spring.GetDualViewGeometry() +

+

Get dual view geometry (minimap when enabled)

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + dualViewSizeX in px
    2. +
  2. + number + dualViewSizeY in px
    3. +
  3. + number + dualViewPosX offset from leftmost screen left border in px
    4. +
  4. + number + dualViewPosY offset from bottommost screen bottom border in px
    5. +
+ + + +
+

+ Spring.GetWindowGeometry() +

+

Get main window geometry

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + winSizeX in px
    2. +
  2. + number + winSizeY in px
    3. +
  3. + number + winPosX in px
    4. +
  4. + number + winPosY in px
    5. +
  5. + number + windowBorderTop in px
    6. +
  6. + number + windowBorderLeft in px
    7. +
  7. + number + windowBorderBottom in px
    8. +
  8. + number + windowBorderRight in px
    9. +
+ + + +
+

+ Spring.GetWindowDisplayMode() +

+

Get main window display mode

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + width in px
    2. +
  2. + number + height in px
    3. +
  3. + number + bits per pixel
    4. +
  4. + number + refresh rate in Hz
    5. +
+ + + +
+

+ Spring.GetScreenGeometry([displayIndex=-1[, queryUsable=false]]) +

+

Get screen geometry

+
+

+ +

+ + +

Parameters:

+
    +
  1. + displayIndex + number + + + + (default -1) +
    2. +
  2. + queryUsable + bool + + + + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + number + screenSizeX in px
    2. +
  2. + number + screenSizeY in px
    3. +
  3. + number + screenPosX in px
    4. +
  4. + number + screenPosY in px
    5. +
  5. + number + windowBorderTop in px
    6. +
  6. + number + windowBorderLeft in px
    7. +
  7. + number + windowBorderBottom in px
    8. +
  8. + number + windowBorderRight in px
    9. +
  9. + nil or number + screenUsableSizeX in px
    10. +
  10. + nil or number + screenUsableSizeY in px
    11. +
  11. + nil or number + screenUsablePosX in px
    12. +
  12. + nil or number + screenUsablePosY in px
    13. +
+ + + +
+

+ Spring.GetMiniMapGeometry() +

+

Get minimap geometry

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + minimapPosX in px
    2. +
  2. + number + minimapPosY in px
    3. +
  3. + number + minimapSizeX in px
    4. +
  4. + number + minimapSizeY in px
    5. +
  5. + bool + minimized
    6. +
  6. + bool + maximized
    7. +
+ + + +
+

+ Spring.GetMiniMapRotation() +

+

Get minimap rotation

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + amount in radians
    2. +
+ + + +
+

+ Spring.GetMiniMapDualScreen() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + string or false + position "left"|"right" when dual screen is enabled, false when not
    2. +
+ + + +
+

+ Spring.GetSelectionBox() +

+

Get vertices from currently active selection box

+
+

+ + + Returns nil when selection box is inactive + +

+ + + +

Returns:

+
    +
  1. + nil or number + left
    2. +
  2. + nil or number + top
    3. +
  3. + nil or number + right
    4. +
  4. + nil or number + bottom
    5. +
+ + +

See also:

+ + +
+

+ Spring.GetDrawSelectionInfo() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ Spring.IsAboveMiniMap(x, y) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + bool + isAbove
    2. +
+ + + +
+

+ Spring.GetDrawFrame() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + low_16bit
    2. +
  2. + number + high_16bit
    3. +
+ + + +
+

+ Spring.GetFrameTimeOffset() +

+

+
+

+ + + Ideally, when running 30hz sim, and 60hz rendering, the draw frames should + have and offset of either 0.0 frames, or 0.5 frames. + + When draw frames are not integer multiples of sim frames, some interpolation + happens, and this timeoffset shows how far along it is. + +

+ + + +

Returns:

+
    +
  1. + nil or number + offset of the current draw frame from the last sim frame, expressed in fractions of a frame
    2. +
+ + + +
+

+ Spring.GetLastUpdateSeconds() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or number + lastUpdateSeconds
    2. +
+ + + +
+

+ Spring.GetVideoCapturingMode() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + allowRecord
    2. +
+ + + +
+

+ Unit attributes +

+ +

+ +

+

+

+ Spring.IsUnitAllied(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + isAllied nil with unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.IsUnitSelected(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + isSelected nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetUnitLuaDraw(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + draw nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetUnitNoDraw(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetUnitEngineDrawMask(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetUnitAlwaysUpdateMatrix(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetUnitDrawFlag(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetUnitNoMinimap(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetUnitNoSelect(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.UnitIconGetDraw(unitID, nil) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + nil + nil or bool + when unitID is invalid +
    3. +
+ + + + +
+

+ Spring.GetUnitSelectionVolumeData(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number or nil + scaleX nil when unitID cannot be parsed
    2. +
  2. + number + scaleY
    3. +
  3. + number + scaleZ
    4. +
  4. + number + offsetX
    5. +
  5. + number + offsetY
    6. +
  6. + number + offsetZ
    7. +
  7. + number + volumeType
    8. +
  8. + number + useContHitTest
    9. +
  9. + number + getPrimaryAxis
    10. +
  10. + bool + ignoreHits
    11. +
+ + + +
+

+ Feature attributes +

+ +

+ +

+

+

+ Spring.GetFeatureLuaDraw(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when featureID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetFeatureNoDraw(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when featureID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetFeatureEngineDrawMask(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when featureID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetFeatureAlwaysUpdateMatrix(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + nil when featureID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetFeatureDrawFlag(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + nil when featureID cannot be parsed
    2. +
+ + + +
+

+ Spring.GetFeatureSelectionVolumeData(featureID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + featureID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number or nil + scaleX nil when unitID cannot be parsed
    2. +
  2. + number + scaleY
    3. +
  3. + number + scaleZ
    4. +
  4. + number + offsetX
    5. +
  5. + number + offsetY
    6. +
  6. + number + offsetZ
    7. +
  7. + number + volumeType
    8. +
  8. + number + useContHitTest
    9. +
  9. + number + getPrimaryAxis
    10. +
  10. + bool + ignoreHits
    11. +
+ + + +
+

+ Inview +

+ +

+ +

+

+

+ Spring.IsUnitInView(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + inView nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.IsUnitVisible(unitID[, radius], checkIcon) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + radius + number + unitRadius when not specified + (optional) +
    3. +
  3. + checkIcon + bool + + + +
    4. +
+ +

Returns:

+
    +
  1. + nil or bool + isVisible nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.IsUnitIcon(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or bool + isUnitIcon nil when unitID cannot be parsed
    2. +
+ + + +
+

+ Spring.IsAABBInView(minX, minY, minZ, maxX, maxY, maxZ) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + minX + number + + + +
    2. +
  2. + minY + number + + + +
    3. +
  3. + minZ + number + + + +
    4. +
  4. + maxX + number + + + +
    5. +
  5. + maxY + number + + + +
    6. +
  6. + maxZ + number + + + +
    7. +
+ +

Returns:

+
    +
  1. + bool + inView
    2. +
+ + + +
+

+ Spring.IsSphereInView(posX, posY, posZ[, radius=0]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + posX + number + + + +
    2. +
  2. + posY + number + + + +
    3. +
  3. + posZ + number + + + +
    4. +
  4. + radius + number + + + + (default 0) +
    5. +
+ +

Returns:

+
    +
  1. + bool + inView
    2. +
+ + + +
+

+ Spring.GetUnitViewPosition(unitID[, midPos=false]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
  2. + midPos + bool + + + + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + number or nil + x nil when unitID cannot be parsed
    2. +
  2. + number + y
    3. +
  3. + number + z
    4. +
+ + + +
+

+ Spring.GetVisibleUnits([teamID=-1[, radius=30[, icons=true]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + + (default -1) +
    2. +
  2. + radius + number + + + + (default 30) +
    3. +
  3. + icons + bool + + + + (default true) +
    4. +
+ +

Returns:

+
    +
  1. + nil or {[number],...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetVisibleFeatures([teamID=-1[, radius=30[, icons=true[, geos=true]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + + (default -1) +
    2. +
  2. + radius + number + + + + (default 30) +
    3. +
  3. + icons + bool + + + + (default true) +
    4. +
  4. + geos + bool + + + + (default true) +
    5. +
+ +

Returns:

+
    +
  1. + nil or {[number],...} + featureIDs
    2. +
+ + + +
+

+ Spring.GetVisibleProjectiles([allyTeamID=-1[, addSyncedProjectiles=true[, addWeaponProjectiles=true[, addPieceProjectiles=true]]]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + allyTeamID + number + + + + (default -1) +
    2. +
  2. + addSyncedProjectiles + bool + + + + (default true) +
    3. +
  3. + addWeaponProjectiles + bool + + + + (default true) +
    4. +
  4. + addPieceProjectiles + bool + + + + (default true) +
    5. +
+ +

Returns:

+
    +
  1. + nil or {[number],...} + projectileIDs
    2. +
+ + + +
+

+ Spring.GetRenderUnits() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.GetRenderUnitsDrawFlagChanged() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.GetRenderFeatures() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.GetRenderFeaturesDrawFlagChanged() +

+

+
+

+ +

+ + + + + + +
+

+ Spring.ClearUnitsPreviousDrawFlag() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.ClearFeaturesPreviousDrawFlag() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil + + +
    2. +
+ + + +
+

+ Spring.GetUnitsInScreenRectangle(left, top, right, bottom[, allegiance=-1]) +

+

Get units inside a rectangle area on the map

+
+

+ +

+ + +

Parameters:

+
    +
  1. + left + number + + + +
    2. +
  2. + top + number + + + +
    3. +
  3. + right + number + + + +
    4. +
  4. + bottom + number + + + +
    5. +
  5. + allegiance + number + teamID when > 0, when < 0 one of AllUnits = -1, MyUnits = -2, AllyUnits = -3, EnemyUnits = -4 + (default -1) +
    6. +
+ +

Returns:

+
    +
  1. + nil or {[number],...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetFeaturesInScreenRectangle(left, top, right, bottom) +

+

Get features inside a rectangle area on the map

+
+

+ +

+ + +

Parameters:

+
    +
  1. + left + number + + + +
    2. +
  2. + top + number + + + +
    3. +
  3. + right + number + + + +
    4. +
  4. + bottom + number + + + +
    5. +
+ +

Returns:

+
    +
  1. + nil or {[number],...} + featureIDs
    2. +
+ + + +
+

+ Spring.GetLocalPlayerID() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + playerID
    2. +
+ + + +
+

+ Spring.GetLocalTeamID() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + teamID
    2. +
+ + + +
+

+ Spring.GetLocalAllyTeamID() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + allyTeamID
    2. +
+ + + +
+

+ Spring.GetSpectatingState() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + spectating
    2. +
  2. + bool + spectatingFullView
    3. +
  3. + bool + spectatingFullSelect
    4. +
+ + + +
+

+ Spring.GetSelectedUnits() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[number],...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetSelectedUnitsSorted() +

+

Get selected units aggregated by unitDefID

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[number]={number,...},...} + where keys are unitDefIDs and values are unitIDs
    2. +
  2. + n + the number of unitDefIDs
    3. +
+ + + +
+

+ Spring.GetSelectedUnitsCounts() +

+

Get an aggregate count of selected units per unitDefID

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[number]=number,...} + unitsCounts where keys are unitDefIDs and values are counts
    2. +
  2. + n + the number of unitDefIDs
    3. +
+ + + +
+

+ Spring.GetSelectedUnitsCount() +

+

Returns the amount of selected units

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + selectedUnitsCount
    2. +
+ + + +
+

+ Spring.GetBoxSelectionByEngine() +

+

Get if selection box is handled by engine

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + when true engine won't select units inside selection box when released
    2. +
+ + +

See also:

+ + +
+

+ Spring.IsGUIHidden() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ Spring.HaveShadows() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + shadowsLoaded + + +
    2. +
+ + + +
+

+ Spring.HaveAdvShading() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + useAdvShading
    2. +
  2. + bool + groundUseAdvShading
    3. +
+ + + +
+

+ Spring.GetWaterMode() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + waterRendererID
    2. +
  2. + string + waterRendererName
    3. +
+ + +

See also:

+ + +
+

+ Spring.GetMapDrawMode() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or string + "normal"|"height"|"metal"|"pathTraversability"|"los"
    2. +
+ + + +
+

+ Spring.GetMapSquareTexture(texSquareX, texSquareY, lodMin, luaTexName[, lodMax=lodMin]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + texSquareX + number + + + +
    2. +
  2. + texSquareY + number + + + +
    3. +
  3. + lodMin + number + + + +
    4. +
  4. + luaTexName + string + + + +
    5. +
  5. + lodMax + number + + + + (default lodMin) +
    6. +
+ +

Returns:

+
    +
  1. + nil or bool + success
    2. +
+ + + +
+

+ rgb +

+

Color triple (RGB)

+
+

+ +

+ + +

Fields:

+
    +
  1. + r + number + + + +
    2. +
  2. + g + number + + + +
    3. +
  3. + b + number + + + +
    4. +
+ + + + +
+

+ Spring.GetLosViewColors() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + { + always=rgb, LOS=rgb, radar=rgb, jam=rgb, radar2=rgb }
    2. +
+ + + +
+

+ Spring.GetNanoProjectileParams() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + rotVal in degrees
    2. +
  2. + number + rotVel in degrees
    3. +
  3. + number + rotAcc in degrees
    4. +
  4. + number + rotValRng in degrees
    5. +
  5. + number + rotVelRng in degrees
    6. +
  6. + number + rotAccRng in degrees
    7. +
+ + + +
+

+ Spring.GetCameraNames() +

+

Get available cameras

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[string] + = number} where keys are names and values are indices
    2. +
+ + + +
+

+ camState +

+

Parameters for camera state

+
+

+ + + Highly dependent on the type of the current camera controller + +

+ + +

Fields:

+
    +
  1. + name + string + "ta"|"spring"|"rot"|"ov"|"free"|"fps"|"dummy" +
    2. +
  2. + mode + number + the camera mode: 0 (fps), 1 (ta), 2 (spring), 3 (rot), 4 (free), 5 (ov), 6 (dummy) +
    3. +
  3. + fov + number + + + +
    4. +
  4. + px + number + Position X of the ground point in screen center +
    5. +
  5. + py + number + Position Y of the ground point in screen center +
    6. +
  6. + pz + number + Position Z of the ground point in screen center +
    7. +
  7. + dx + number + Camera direction vector X +
    8. +
  8. + dy + number + Camera direction vector Y +
    9. +
  9. + dz + number + Camera direction vector Z +
    10. +
  10. + rx + number + Camera rotation angle on X axis (spring) +
    11. +
  11. + ry + number + Camera rotation angle on Y axis (spring) +
    12. +
  12. + rz + number + Camera rotation angle on Z axis (spring) +
    13. +
  13. + angle + number + Camera rotation angle on X axis (aka tilt/pitch) (ta) +
    14. +
  14. + flipped + number + -1 for when south is down, 1 for when north is down (ta) +
    15. +
  15. + dist + number + Camera distance from the ground (spring) +
    16. +
  16. + height + number + Camera distance from the ground (ta) +
    17. +
  17. + oldHeight + number + Camera distance from the ground, cannot be changed (rot) +
    18. +
+ + + + +
+

+ Spring.GetCameraState([useReturns=true]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + useReturns + bool + when true return multiple values instead of table + (default true) +
    2. +
+ +

Returns:

+
    +
  1. + any or camState + ret1
    2. +
  2. + any or nil + ret2
    3. +
  3. + any or nil + retn
    4. +
+ + + +
+

+ Spring.GetCameraPosition() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + posX + + +
    2. +
  2. + posY + + +
    3. +
  3. + posZ + + +
    4. +
+ + + +
+

+ Spring.GetCameraDirection() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + dirX + + +
    2. +
  2. + dirY + + +
    3. +
  3. + dirZ + + +
    4. +
+ + + +
+

+ Spring.GetCameraRotation() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + rotX + in radians
    2. +
  2. + rotY + in radians
    3. +
  3. + rotZ + in radians
    4. +
+ + + +
+

+ Spring.GetCameraFOV() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + vFOV
    2. +
  2. + number + hFOV
    3. +
+ + + +
+

+ xyz +

+

Cartesian triple (XYZ)

+
+

+ +

+ + +

Fields:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
+ + + + +
+

+ Spring.GetCameraVectors() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + { + forward = xyz, up = xyz, right = xyz, topFrustumPlane = xyz, botFrustumPlane = xyz, lftFrustumPlane = xyz, rgtFrustumPlane = xyz }
    2. +
+ + + +
+

+ Spring.WorldToScreenCoords(x, y, z) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
  3. + z + number + + + +
    4. +
+ +

Returns:

+
    +
  1. + viewPortX + + +
    2. +
  2. + viewPortY + + +
    3. +
  3. + viewPortZ + + +
    4. +
+ + + +
+

+ Spring.TraceScreenRay(screenX, screenY[, onlyCoords=false[, useMinimap=false[, includeSky=false[, ignoreWater=false[, heightOffset=0]]]]]) +

+

Get information about a ray traced from screen to world position

+
+

+ + + Extended to allow a custom plane, parameters are (0, 1, 0, D=0) where D is the offset D can be specified in the third argument (if all the bools are false) or in the seventh (as shown). + + Intersection coordinates are returned in t[4],t[5],t[6] when the ray goes offmap and includeSky is true), or when no unit or feature is hit (or onlyCoords is true). + + This will only work for units & objects with the default collission sphere. Per Piece collission and custom collission objects are not supported. + + The unit must be selectable, to appear to a screen trace ray. + +

+ + +

Parameters:

+
    +
  1. + screenX + number + position on x axis in mouse coordinates (origin on left border of view) +
    2. +
  2. + screenY + number + position on y axis in mouse coordinates (origin on top border of view) +
    3. +
  3. + onlyCoords + bool + return only description (1st return value) and coordinates (2nd return value) + (default false) +
    4. +
  4. + useMinimap + bool + if position arguments are contained by minimap, use the minimap corresponding world position + (default false) +
    5. +
  5. + includeSky + bool + + + + (default false) +
    6. +
  6. + ignoreWater + bool + + + + (default false) +
    7. +
  7. + heightOffset + number + + + + (default 0) +
    8. +
+ +

Returns:

+
    +
  1. + nil or string + description of traced position
    2. +
  2. + nil, number, string or xyz + unitID or feature, position triple when onlyCoords=true
    3. +
  3. + nil, number or string + featureID or ground
    4. +
  4. + nil or xyz + coords
    5. +
+ + + +
+

+ Spring.GetPixelDir(x, y) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + x + number + + + +
    2. +
  2. + y + number + + + +
    3. +
+ +

Returns:

+
    +
  1. + dirX + + +
    2. +
  2. + dirY + + +
    3. +
  3. + dirZ + + +
    4. +
+ + + +
+

+ Spring.GetTeamColor(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + r factor from 0 to 1
    2. +
  2. + nil or number + g factor from 0 to 1
    3. +
  3. + nil or number + b factor from 0 to 1
    4. +
  4. + nil or number + a factor from 0 to 1
    5. +
+ + + +
+

+ Spring.GetTeamOrigColor(teamID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + teamID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + r factor from 0 to 1
    2. +
  2. + nil or number + g factor from 0 to 1
    3. +
  3. + nil or number + b factor from 0 to 1
    4. +
  4. + nil or number + a factor from 0 to 1
    5. +
+ + + +
+

+ Spring.GetDrawSeconds() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + time + in seconds
    2. +
+ + + +
+

+ Sound +

+ +

+ +

+

+

+ Spring.GetSoundStreamTime() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + playTime
    2. +
  2. + number + time
    3. +
+ + + +
+

+ Spring.GetSoundEffectParams() +

+

+
+

+ +

+ + + + + + +
+

+ Game Speed +

+ +

+ +

+

+

+ Spring.GetFPS() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + fps
    2. +
+ + + +
+

+ Spring.GetGameSpeed() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + wantedSpeedFactor
    2. +
  2. + number + speedFactor
    3. +
  3. + bool + paused
    4. +
+ + + +
+

+ Spring.GetGameState([maxLatency=500]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + maxLatency + number + used for isSimLagging return parameter + (default 500) +
    2. +
+ +

Returns:

+
    +
  1. + bool + doneLoading
    2. +
  2. + bool + isSavedGame
    3. +
  3. + bool + isClientPaused
    4. +
  4. + bool + isSimLagging
    5. +
+ + + +
+

+ Commands +

+ +

+ +

+

+

+ Spring.GetActiveCommand() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or number + cmdIndex
    2. +
  2. + nil or number + cmdID
    3. +
  3. + nil or number + cmdType
    4. +
  4. + nil or string + cmdName
    5. +
+ + + +
+

+ Spring.GetDefaultCommand() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or number + cmdIndex
    2. +
  2. + nil or number + cmdID
    3. +
  3. + nil or number + cmdType
    4. +
  4. + nil or string + cmdName
    5. +
+ + + +
+

+ cmdDesc +

+

Command Description

+
+

+ + + Contains data about a command + +

+ + +

Fields:

+
    +
  1. + id + number + + + +
    2. +
  2. + type + number + + + +
    3. +
  3. + name + string + + + +
    4. +
  4. + action + string + + + +
    5. +
  5. + tooltip + string + + + +
    6. +
  6. + texture + string + + + +
    7. +
  7. + cursor + string + + + +
    8. +
  8. + queueing + bool + + + +
    9. +
  9. + hidden + bool + + + +
    10. +
  10. + disabled + bool + + + +
    11. +
  11. + showUnique + bool + + + +
    12. +
  12. + onlyTexture + bool + + + +
    13. +
  13. + params + {[string],...} + + + +
    14. +
+ + + + +
+

+ Spring.GetActiveCmdDescs() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[cmdDesc],...} + cmdDescs
    2. +
+ + + +
+

+ Spring.GetActiveCmdDesc(cmdIndex) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cmdIndex + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or cmdDesc + + +
    2. +
+ + + +
+

+ Spring.GetCmdDescIndex(cmdID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + cmdID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + cmdDescIndex
    2. +
+ + + +
+

+ Spring.GetBuildFacing() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + buildFacing
    2. +
+ + + +
+

+ Spring.GetBuildSpacing() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + buildSpacing
    2. +
+ + + +
+

+ Spring.GetGatherMode() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + gatherMode
    2. +
+ + + +
+

+ Spring.GetActivePage() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + activePage
    2. +
  2. + number + maxPage
    3. +
+ + + +
+

+ Mouse State +

+ +

+ +

+

+

+ Spring.GetMouseState() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + x
    2. +
  2. + number + y
    3. +
  3. + number + lmbPressed left mouse button pressed
    4. +
  4. + number + mmbPressed middle mouse button pressed
    5. +
  5. + number + rmbPressed right mouse button pressed
    6. +
  6. + bool + offscreen
    7. +
  7. + bool + mmbScroll
    8. +
+ + + +
+

+ Spring.GetMouseCursor() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + string + cursorName
    2. +
  2. + number + cursorScale
    3. +
+ + + +
+

+ Spring.GetMouseStartPosition(button) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + button + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + x
    2. +
  2. + number + y
    3. +
  3. + number + camPosX
    4. +
  4. + number + camPosY
    5. +
  5. + number + camPosZ
    6. +
  6. + number + dirX
    7. +
  7. + number + dirY
    8. +
  8. + number + dirZ
    9. +
+ + + +
+

+ Text +

+ +

+ +

+

+

+ Spring.GetClipboard() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + string + text
    2. +
+ + + +
+

+ Spring.IsUserWriting() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + + +
    2. +
+ + + +
+

+ Console +

+ +

+ +

+

+

+ Spring.GetLastMessagePositions() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {xyz,...} + message positions
    2. +
+ + + +
+

+ Spring.GetConsoleBuffer(maxLines) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + maxLines + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {{text=string,priority=number},...} + pair array of (text, priority)
    2. +
+ + + +
+

+ Spring.GetCurrentTooltip() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + string + tooltip
    2. +
+ + + +
+

+ Key Input +

+ +

+ +

+

+

+ Spring.GetKeyFromScanSymbol(scanSymbol) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + scanSymbol + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + string + keyName
    2. +
+ + + +
+

+ Spring.GetKeyState(keyCode) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + keyCode + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + bool + pressed
    2. +
+ + + +
+

+ Spring.GetModKeyState() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + bool + alt
    2. +
  2. + bool + ctrl
    3. +
  3. + bool + meta
    4. +
  4. + bool + shift
    5. +
+ + + +
+

+ Spring.GetPressedKeys() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[number or string]=true,...} + where keys are keyCodes or key names
    2. +
+ + + +
+

+ Spring.GetPressedScans() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[number or string]=true,...} + where keys are scanCodes or scan names
    2. +
+ + + +
+

+ Spring.GetInvertQueueKey() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or number + queueKey
    2. +
+ + + +
+

+ Spring.GetKeyCode(keySym) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + keySym + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + number + keyCode
    2. +
+ + + +
+

+ Spring.GetKeySymbol(keyCode) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + keyCode + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + string + keyCodeName
    2. +
  2. + string + keyCodeDefaultName name when there are not aliases
    3. +
+ + + +
+

+ Spring.GetScanSymbol(scanCode) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + scanCode + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + string + scanCodeName
    2. +
  2. + string + scanCodeDefaultName name when there are not aliases
    3. +
+ + + +
+

+ keybindingSpec +

+

Keybinding spec

+
+

+ + + Contains data about a keybinding + +

+ + +

Fields:

+
    +
  1. + command + string + + + +
    2. +
  2. + extra + string + + + +
    3. +
  3. + boundWith + string + + + +
    4. +
+ + + + +
+

+ Spring.GetKeyBindings([keySet1[, keySet2]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + keySet1 + string + filters keybindings bound to this keyset + (optional) +
    2. +
  2. + keySet2 + string + OR bound to this keyset + (optional) +
    3. +
+ +

Returns:

+
    +
  1. + {[keybindingSpec],...} + + +
    2. +
+ + + +
+

+ Spring.GetActionHotKeys(actionName) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + actionName + string + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[string],...} + hotkeys
    2. +
+ + + +
+

+ Unit Groups +

+ +

+ +

+

+

+ Spring.GetGroupList() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + nil or {[number]=number,...} + where keys are groupIDs and values are counts
    2. +
+ + + +
+

+ Spring.GetSelectedGroup() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + number + groupID -1 when no group selected
    2. +
+ + + +
+

+ Spring.GetUnitGroup(unitID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + unitID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + groupID
    2. +
+ + + +
+

+ Spring.GetGroupUnits(groupID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + groupID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[number],...} + unitIDs
    2. +
+ + + +
+

+ Spring.GetGroupUnitsSorted(groupID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + groupID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[number]={[number],...},...} + where keys are unitDefIDs and values are unitIDs
    2. +
+ + + +
+

+ Spring.GetGroupUnitsCounts(groupID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + groupID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or {[number]=number,...} + where keys are unitDefIDs and values are counts
    2. +
+ + + +
+

+ Spring.GetGroupUnitsCount(groupID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + groupID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + groupSize
    2. +
+ + + +
+

+ Team/Player Info +

+ +

+ +

+

+

+ rosterSpec +

+

Roster spec

+
+

+ + + Contains data about a player + +

+ + +

Fields:

+
    +
  1. + name + string + + + +
    2. +
  2. + playerID + number + + + +
    3. +
  3. + teamID + number + + + +
    4. +
  4. + allyTeamID + number + + + +
    5. +
  5. + spectator + bool + + + +
    6. +
  6. + cpuUsage + number + in order to find the progress, use: cpuUsage&0x1 if it's PC or BO, cpuUsage& 0xFE to get path res, (cpuUsage>>8)*1000 for the progress +
    7. +
  7. + pingTime + number + if -1, the player is pathfinding +
    8. +
+ + + + +
+

+ Spring.GetPlayerRoster([sortType[, showPathingPlayers=false]]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + sortType + number + return unsorted if unspecified. Disabled = 0, Allies = 1, TeamID = 2, PlayerName = 3, PlayerCPU = 4, PlayerPing = 5 + (optional) +
    2. +
  2. + showPathingPlayers + bool + + + + (default false) +
    3. +
+ +

Returns:

+
    +
  1. + nil or {[rosterSpec],...} + playerTable
    2. +
+ + + +
+

+ Spring.GetPlayerTraffic(playerID, packetID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
  2. + packetID + number + [opt] +
    3. +
+ +

Returns:

+
    +
  1. + number + traffic
    2. +
+ + + +
+

+ Spring.GetPlayerStatistics(playerID) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + playerID + number + + + +
    2. +
+ +

Returns:

+
    +
  1. + nil or number + mousePixels nil when invalid playerID
    2. +
  2. + number + mouseClicks
    3. +
  3. + number + keyPresses
    4. +
  4. + number + numCommands
    5. +
  5. + number + unitCommands
    6. +
+ + + +
+

+ Configuration +

+ +

+ +

+

+

+ configSpec +

+

Configuration spec

+
+

+ + + Contains data about a configuration, only name and type are guaranteed + +

+ + +

Fields:

+
    +
  1. + name + string + + + +
    2. +
  2. + type + string + + + +
    3. +
  3. + description + string + + + +
    4. +
  4. + defaultValue + string + + + +
    5. +
  5. + minimumValue + string + + + +
    6. +
  6. + maximumValue + string + + + +
    7. +
  7. + safemodeValue + string + + + +
    8. +
  8. + declarationFile + string + + + +
    9. +
  9. + declarationLine + string + + + +
    10. +
  10. + readOnly + bool + + + +
    11. +
+ + + + +
+

+ Spring.GetConfigParams() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[configSpec],...} + + +
    2. +
+ + + +
+

+ Spring.GetConfigInt(name[, default=0]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + name + string + + + +
    2. +
  2. + default + number or nil + + + + (default 0) +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + configInt
    2. +
+ + + +
+

+ Spring.GetConfigFloat(name[, default=0]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + name + string + + + +
    2. +
  2. + default + number or nil + + + + (default 0) +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + configFloat
    2. +
+ + + +
+

+ Spring.GetConfigString(name[, default=""]) +

+

+
+

+ +

+ + +

Parameters:

+
    +
  1. + name + string + + + +
    2. +
  2. + default + string or nil + + + + (default "") +
    3. +
+ +

Returns:

+
    +
  1. + nil or number + configString
    2. +
+ + + +
+

+ Spring.GetLogSections() +

+

+
+

+ +

+ + + +

Returns:

+
    +
  1. + {[string]=number,...} + sections where keys are names and loglevel are values. E.g. { "KeyBindings" = LOG.INFO, "Font" = LOG.INFO, "Sound" = LOG.WARNING, ... }
    2. +
+ + + +
+ +{% endraw %} diff --git a/ldoc/modules/VFS.html b/ldoc/modules/VFS.html new file mode 100644 index 0000000000..0de5344993 --- /dev/null +++ b/ldoc/modules/VFS.html @@ -0,0 +1,24 @@ +--- +layout: default +title: VFS +permalink: ldoc/modules/VFS.html +description: Virtual File System +parent: Lua API +table: 0x55953a348360 +--- + +{% raw %} +

Module VFS

+

Virtual File System

+

+ +

+

+

See also:

+ + + + +{% endraw %}