Spring - User contributions [en]

Lua OpenGL Api

2011-04-10T06:06:31Z

Freezerburn: /* Textures */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Spring =
'''gl.GetSun'''
() -> number sunPosX, number sunPosY, number sunPosZ
( "pos" ) -> number sunPosX, number sunPosY, number sunPosZ
( "shadowDensity" [, "unit"] ) -> number shadowDensity
( "diffuse" [, "unit"] ) -> nil | number r, number g, number b
( "ambient" [, "unit"] ) -> nil | number r, number g, number b
( "specular" ) -> nil | number r, number g, number b

'''gl.ConfigScreen''' used for Unit LODs
( number screenWidth, number screenDistance ) -> nil

'''gl.DrawMiniMap''' argument new in 0.82+
( boolean tansform = true ) -> nil

'''gl.SlaveMiniMap'''
( boolean mode ) -> nil

'''gl.ConfigMiniMap'''
( int px, int py, int sx, int sy ) -> nil

'''gl.GetViewSizes'''
( ) -> number x, number y

= Matrices & Viewport =
'''gl.Viewport'''
( number x, number y, number w, number h ) -> nil

'''gl.PushMatrix'''
() -> nil

'''gl.PopMatrix'''
() -> nil

'''gl.Translate'''
(number x, number y, number z) -> nil

'''gl.Scale'''
( number x, number y, number z ) -> nil

'''gl.Rotate'''
( number angle, number x, number y, number z ) -> nil

'''gl.Billboard'''
( ) -> nil
Use this to draw 2d primitives in DrawWorld().
To render a 2D billboarded quad in the gameworld at world position x,y,z, you do the following (at a minimum; I am skipping blending / depthtesting) here:
gl.PushMatrix()
gl.Texture(read what you need here)
gl.Translate(x,y,z)
gl.Billboard()
gl.TexRect(x1,y1,x2,y2)
gl.PopMatrix()

'''gl.MatrixMode'''
( number [[Lua_ConstGL#MatrixMode|mode]] ) -> nil

'''gl.LoadIdentity'''
( ) -> nil

'''gl.LoadMatrix'''
( ) -> nil

'''gl.MultMatrix'''
( ?? ) -> ??

'''gl.Ortho'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.Frustum'''
( number left, number right, number bottom, number top, number near, number far ) -> nil

'''gl.PushPopMatrix'''
( ?? ) -> ??

'''gl.ClipPlane'''
( int plane, note: $plane can only be 1 or 2
boolean enable |
number A, number B, number C, number D ) -> nil

= Clear =
'''gl.Clear'''
( GL.DEPTH_BUFFER_BIT [, number cleardepth] ) -> nil
( GL.STENCIL_BUFFER_BIT [, int clearstencil] ) -> nil
( GL.COLOR_BUFFER_BIT | GL.ACCUM_BUFFER_BIT [, number r, number g, number b, number a] ) -> nil

= ResetState/Matrices =
'''gl.ResetState''' DON'T USE IT AS LONG AS YOU KNOW WHAT YOU ARE DOING! each callin has different default states, but this function resets all states no matter what to the states below!
() -> nil

ShadeModel = GL_SMOOTH
Scissor = false
Texture = false
Lighting = false,
ColorMask = true, true, true, true
DepthMask = false
DepthTest = false (GL_LEQUAL)
Culling = false (GL_BACK)
LogicOp = false (GL_INVERT)
AlphaTest = false (GL_GREATER, 0.5f)
Blending = true (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA)


'''gl.ResetMatrices'''
() -> nil

Resets GL_TEXTURE matrix stack
Resets GL_MODELVIEW matrix stack
Resets GL_PROJECTION matrix stack


= Draw Basics =
'''gl.BeginEnd'''
( number [[Lua_ConstGL#Drawing_Primitives|GLType]], function [, arg1,... ] ) -> nil

'''gl.Color'''
( { number r, number g, number b[, number a] } |
number r, number g, number b[, number a] ) -> nil

'''gl.Vertex'''
( { number x, number y [, number z [, number w ]] } |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w ) -> nil

'''gl.Normal'''
( number x, number y, number z |
{ number x, number y, number z } ) -> nil

'''gl.EdgeFlag'''
( boolean enable ) -> nil

'''gl.Rect'''
( number x1, number y1, number x2, number y2 ) -> nil

'''gl.TexRect''' texture rect
( number x1, number y1, number x2, number y2,
[ boolean flip_s, boolean flip_t | number s1, number t1, number s2, number t2 ] ) -> nil

'''gl.Shape'''
( number [[Lua_ConstGL#Drawing_Primitives|GLtype]],
elements = {
[1] = { v | vertex = { number x, number y, number z }, required
n | normal = { number x, number y, number z }, optional
t | texcoord = { number x, number y }, optional
c | color = { number r, number g, number b, number a } optional
},
etc ...
}
) -> nil

'''gl.SecondaryColor'''
( { number r, number g, number b } |
number r, number g, number b ) -> nil

'''gl.FogCoord'''
( number value ) -> nil

= Display Lists =
Display Lists save given vertex attributes in a static buffer, so the GPU can directly read them (without the CPU). Display Lists are a lot faster (10-60x) than standard drawing with glShape/glBeginEnd, so try to use them when ever you can. If you want to learn more about them, g00gle is your friend ;)

'''gl.CreateList'''
( function [,arg1 [,arg2...]] ) -> number listID

'''gl.CallList'''
( number listID ) -> nil

'''gl.DeleteList'''
( number listID ) -> nil

= Text =
'''gl.Text'''
(string "text", number x, number y, number size [, string "options"] )

options are:
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)

http://home.arcor.de/jkei/fontlines.png

'''gl.GetTextWidth'''
(string "text") -> number width (in pixels, with a font size of 1.0)

'''gl.GetTextHeight'''
( string "text" ) -> nil | number height, number descender, number numlines (in pixels, with a font size of 1.0)
further descriptions here: [[GetTextHeight]]

If you have multiple gl.Text calls, then you can bunch them between a gl.BeginText and gl.EndText to speedup the rendering. 
'''gl.BeginText'''
( ) -> nil
'''gl.EndText'''
( ) -> nil

= Unit/Feature Draw Functions =
'''gl.Unit''' (draws an unit; on default it uses LOD, with lod<0 it is turned off, else it defines a specific level)
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitRaw''' (doesn't apply worldspace->unit transformation! only works if rawdraw is true )
( number unitID, [ boolean rawdraw, int lod ] ) -> nil

'''gl.UnitShape'''
( number unitDefID, number teamID ) -> nil

'''gl.Feature'''
( number featureID ) -> nil

'''gl.FeatureShape'''
( number featureDefID, number teamID ) -> nil

'''gl.UnitMultMatrix''' (world space -> unit space)
( number unitID ) -> nil

'''gl.UnitPieceMultMatrix''' (unit space -> piece space)
( number unitID, int piece ) -> nil

'''gl.UnitPiece''' (draws the unit piece)
( number unitID, int piece ) -> nil

'''gl.UnitPieceMatrix''' (use gl.UnitPieceMultMatrix instead!)
( number unitID, int piece ) -> nil

'''gl.DrawListAtUnit'''
( number unitID, number listID, [ boolean midPos,
number scaleX, number scaleY, number scaleZ,
number degrees, number rotX, number rotX, number rotZ ] ) -> nil

'''gl.DrawFuncAtUnit'''
( number unitID, boolean midPos, function [, arg1,... ]) -> nil

= States (Blending,AlphaTest...) =
'''gl.Blending'''
( boolean enable | number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil
( string mode ) -> nil
{| cellpadding="0" cellspacing="0" style="margin-top: -5px; margin-left:5px"
! style="color:#55ee99" | mode maybe:
|-
| style="color:#55ee99" | "add"
| style="color:#55ee99" | = GL_ONE, GL_ONE
|-
| style="color:#55ee99" | "alpha_add"
| style="color:#55ee99" | = GL_SRC_ALPHA, GL_ONE
|-
| style="color:#55ee99" | "alpha"
| style="color:#55ee99" | = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "reset"
| style="color:#55ee99" | = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "color"
| style="color:#55ee99" | = GL_SRC_COLOR, GL_ONE_MINUS_SRC_ALPHA
|-
| style="color:#55ee99" | "modulate"
| style="color:#55ee99" | = GL_DST_COLOR, GL_ZERO
|-
| style="color:#55ee99" | "disable"
| style="color:#55ee99" | = GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA
|}

'''gl.BlendEquation'''
( number mode ) -> nil

'''gl.BlendFunc'''
( number [[Lua_ConstGL#BlendingFactorSrc|srcmode]], number [[Lua_ConstGL#BlendingFactorDest|dstmode]] ) -> nil

'''gl.BlendEquationSeparate''' (needs openGL2.0!)
( number modeRGB, number modeAlpha ) -> nil

'''gl.BlendFuncSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#BlendingFactorSrc|srcRGB]], number [[Lua_ConstGL#BlendingFactorDest|dstRGB]], number [[Lua_ConstGL#BlendingFactorSrc|srcAlpha]], number [[Lua_ConstGL#BlendingFactorDest|dstAlpha]] ) -> nil

'''gl.AlphaTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]], number threshold ) -> nil

'''gl.DepthTest'''
( boolean enable | number [[Lua_ConstGL#AlphaFunction and DepthFunction|func]] ) -> nil

'''gl.Culling'''
( boolean enable | number [[Lua_ConstGL#Culling|face]] ) -> nil

'''gl.DepthClamp''' not always available, needs GL_NV_depth_clamp!
( boolean enable ) -> nil

'''gl.DepthMask'''
( boolean enable ) -> nil

'''gl.ColorMask'''
( boolean ) -> nil
( boolean r, boolean g, boolean b, boolean a ) -> nil

'''gl.LogicOp'''
( boolean enable | number [[Lua_ConstGL#LogicOp|func]] ) -> nil

'''gl.Fog'''
( boolean enable ) -> nil

'''gl.Smoothing'''
( (boolean enable | number POINT),
(boolean enable | number LINE),
(boolean enable | number POLYGON) ) -> nil

'''gl.EdgeFlag'''
( boolean enable ) -> nil

'''gl.Scissor'''
( boolean ) -> nil
( int x, int y, int w, int h ) -> nil

'''gl.LineStipple'''
( string any ) -> nil (use springs default line stipple)
( boolean enable ) -> nil
( int factor, number pattern ) -> nil

'''gl.PolygonMode'''
( number [[Lua_ConstGL#Culling|face]], number [[Lua_ConstGL#PolygonMode|mode]] ) -> nil

'''gl.PolygonOffset'''
( boolean enable | number factor, number units ) -> nil

'''gl.PushAttrib'''
( [ number [[Lua_ConstGL#glPushAttrib.28.29_bits|attrib]] ] ) -> nil

'''gl.PopAttrib'''
() -> nil

= Stencil =
'''gl.StencilTest'''
( boolean enable ) -> nil
'''gl.StencilMask'''
( number mask ) -> nil
'''gl.StencilFunc'''
( number func, number ref, number mask ) -> nil
'''gl.StencilOp'''
( number fail, number zfail, number zpass ) -> nil

'''gl.StencilMaskSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number mask ) -> nil
'''gl.StencilFuncSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number func, number ref, number mask ) -> nil
'''gl.StencilOpSeparate''' (needs openGL2.0!)
( number [[Lua_ConstGL#Culling|face]], number fail, number zfail, number zpass ) -> nil

= LineWidth & PointSize =
'''gl.LineWidth'''
( number width ) -> nil

'''gl.PointSize''' (values != 1 can break severely on ATI cards, see http://springrts.com/mantis/view.php?id=2390)
( number size ) -> nil

'''gl.PointSprite''' (needs openGL2.0!)
( boolean enable, [boolean coord_replace, boolean coord_origin_upper] ) -> nil

'''gl.PointParameter''' (needs openGL2.0!)
( number v1, number v2, number v3,
[ number sizeMin, number sizeMax, number sizeFade ] ) -> nil

= Textures =
'''gl.Texture'''
( [ number texNum, ] boolean enable | string name ) -> nil | boolean loaded
This is the only call-out that is needed to load and draw any texture in a Lua script. All you have to do is pass it a valid path to a valid png and it will use that image for drawing any subsequent textured rectangles. This is shown in the last line of the following list of valid strings for the name parameter.


{| cellpadding="0" cellspacing="0" style="margin-top: -5px; margin-left:5px"
! style="color:#55ee99; text-align:left" |`name` maybe:
|-
| style="color:#55ee99" | #12
| style="color:#55ee99" | = unitDef 12 buildpic
|-
| style="color:#55ee99" | %34:1
| style="color:#55ee99" | = unitDef 34 s3o tex2 (:0->tex1,:1->tex2)
|-
| style="color:#55ee99" | %-102:0
| style="color:#55ee99" | = featureDef 102 s3o tex1
|-
| style="color:#55ee99" | !56
| style="color:#55ee99" | = lua generated texture 56 (= return value of gl.CreateTexture)
|-
| style="color:#55ee99" | $units
| style="color:#55ee99" | = 3do textureatlas tex1
|-
| style="color:#55ee99" | $units1
| style="color:#55ee99" | = 3do textureatlas tex1
|-
| style="color:#55ee99" | $units2
| style="color:#55ee99" | = 3do textureatlas tex2
|-
| style="color:#55ee99" | $shadow
| style="color:#55ee99" | = shadowmap
|-
| style="color:#55ee99" | $specular
| style="color:#55ee99" | = specular cube map
|-
| style="color:#55ee99" | $reflection
| style="color:#55ee99" | = reflection cube map
|-
| style="color:#55ee99" | $shading
| style="color:#55ee99" | = ground shading texture
|-
| style="color:#55ee99" | $grass
| style="color:#55ee99" | = grass shading texture
|-
| style="color:#55ee99" | $heightmap
| style="color:#55ee99" | = heightmap (needs HeightMapTexture=1 set in spring config)
|-
| style="color:#55ee99" | ${opt}:/LuaUI/images/image.png
| style="color:#55ee99" | = load a texture from the VFS
|}

possible ${opt}'s are:
'n' = nearest
'l' = linear
'a' = aniso
'i' = invert
'g' = greyed
'c' = clamped
'b' = border
't%r,%g,%b' = tint
'r%width,%height' = resize

example: ":iac:/LuaUI/images/image.png"
example: ":cr16,16:/LuaUI/images/image.png"
example2: ":t1.0,0.5,0:/LuaUI/images/image.png" (orange tint)


'''gl.CreateTexture'''
( int xsize, int ysize,
[ {
[target = number,] (like GL_TEXTURE_1D,GL_TEXTURE_2D,...)
[format = number,]
[min_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[mag_filter = [[Lua_ConstGL#Texture_Filtering|number]],]
[wrap_s = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_t = [[Lua_ConstGL#Texture_Clamping|number]],]
[wrap_r = [[Lua_ConstGL#Texture_Clamping|number]],]
[aniso = number,]
[border = boolean,]
[fbo = boolean,] (needs GLEW_EXT_framebuffer_object!)
[fboDepth = boolean] (needs GLEW_EXT_framebuffer_object!)
} ]
) -> string

'''gl.DeleteTexture'''
( string texture ) -> boolean

'''gl.DeleteTextureFBO''' (needs GLEW_EXT_framebuffer_object!)
( string texture ) -> boolean

'''gl.TextureInfo'''
( string texture ) -> nil | {
xsize = number,
ysize = number,
alpha = boolean, //not used yet
type = number, //not used yet
}

the format of the texture string is the same as in gl.Texture()


'''gl.TexCoord'''
( number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.MultiTexCoord'''
( int texNum,
number x |
number x, number y |
number x, number y, number z |
number x, number y, number z, number w |
{ number x [, number y [, number z [, number w ]]] } ) -> nil

'''gl.TexEnv'''
( number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.MultiTexEnv'''
( int texNum, number [[Lua_ConstGL#Texture_Environment|target]], number [[Lua_ConstGL#Texture_Environment|pname]],
number [[Lua_ConstGL#Texture_Environment|value]] |
number var1, number var2, number var3 ) -> nil

'''gl.TexGen'''
( number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.MultiTexGen'''
( int texNum, number [[Lua_ConstGL#Texture_Generation|target]],
boolean state |
number [[Lua_ConstGL#Texture_Generation|pname]], number value |
number [[Lua_ConstGL#Texture_Generation|pname]], number var1, number var2, number var3 ) -> nil

'''gl.CopyToTexture'''
(string texture, int xoff, int yoff, int x, int y, int w, int h
[,number target,number level])->nil

'''gl.RenderToTexture''' (needs GLEW_EXT_framebuffer_object!)
( string fbotexture, lua_func ) -> nil

'''gl.GenerateMipmap''' (needs glGenerateMipmapEXT!)
( string texture ) -> boolean

= PixelReadback =
'''gl.SaveImage'''
( number x, number y, number w, number h,
string filename [, table {alpha=boolean, yflip=boolean} ] ) -> nil | boolean success

'''gl.ReadPixels'''
( number x, number y, number w, number h [, number format = GL_RGBA ] )
-> nil | number r,[g,[b,[a]]] | table { { {1 = number r, 2 = number g, 3 = number b, 4 = number a}, ... }, ... }

= Lights =
'''gl.Lighting'''
( boolean enable ) -> nil

'''gl.ShadeModel'''
( number [[Lua_ConstGL#ShadeModel|mode]] ) -> nil

'''gl.Light'''
( int light,
boolean enable |
number [[Lua_ConstGL#Light_Specification|pname]], number param |
number [[Lua_ConstGL#Light_Specification|pname]], number param1, number param2, number param3 ) -> nil

'''gl.Material'''
({
ambient = {number r, number g, number b[, number a]},
diffuse = {number r, number g, number b[, number a]},
ambidiff = {number r, number g, number b[, number a]},
emission = {number r, number g, number b[, number a]},
specular = {number r, number g, number b[, number a]},
shininess = number specularExponent
}) -> nil

= Hardware relevant =
'''gl.HasExtension'''
( string extname ) -> boolean

'''gl.GetNumber'''
( number ext, int count ) -> number [, number, number, ... #count ]

'''gl.GetString'''
( number ext ) -> string

= DrawGroundPrimitives =
'''gl.DrawGroundCircle'''
( number x, number y, number z, number radius, number divs [, number slope ] ) -> nil
Note: number divs is the number of sides the circle will have. the higher the smoother the circle (and more GPU intensive) 

'''gl.DrawGroundQuad''' Note: x1,z1,x2 & z2 are rounded, so don't use it for very small or moving objects. x and z are correspond to the coordinates displayed by the tooltip 
( number x1, number z1, number x2, number z2,
[ boolean useNorm, (does nothing!)
[ number tu1, number tv1, number tu2, number tv2 |
boolean useTextureCoord ] ] ) -> nil

= Queries =
'''gl.CreateQuery''' needs >=OpengGL2.0!
( ) -> nil | userdata query
'''gl.DeleteQuery''' needs >=OpengGL2.0!
( userdata query ) -> nil
'''gl.RunQuery''' needs >=OpengGL2.0!
( userdata query, function, arg1, arg2, ... ) -> nil
'''gl.GetQuery''' needs >=OpengGL2.0!
( userdata query ) -> nil | number renderedFragments

= Extended =
'''gl.ActiveTexture'''
( int texNum, function [, arg1,... ] ) -> nil

'''gl.GetGlobalTexNames'''
() -> { [1] = string texture, etc ... }

'''gl.GetGlobalTexCoords''' gets the texcoord of a 3do texture in the 3do texture atlas
( string 3doTextureName ) -> number xstart, number ystart, number xend, number yend

'''gl.UnsafeState'''
( number state [, boolean disable_state ], function, arg1, arg2, ... ) -> nil
Calls glEnable(state) or glDisable(state) (if disable_state==true) and then calls the lua_function and afterwards reverts the state.

'''gl.GetShadowMapParams'''
() -> number xmid, number ymid, number p17, number p18

'''gl.GetMatrixData'''
( GL.PROJECTION [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.MODELVIEW [, int i] ) -> nil | number, etc.. | number Matrix[i]
( GL.TEXTURE [, int i] ) -> nil | number, etc.. | number Matrix[i]
( "shadow" ) -> nil | number, etc..
( "camera" ) -> nil | number, etc..
( "caminv" ) -> nil | number, etc..
( "camprj" ) -> nil | number, etc..
( "billboard" ) -> nil | number, etc..

'''gl.Flush'''
() -> nil

'''gl.Finish'''
() -> nil

= Shaders (GLSL) =
[[Lua_GLSL_Api]]

[[category: Lua]]

LuaCallinReturn

2011-04-10T05:56:37Z

Freezerburn: /* Commands, general-purpose: */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

===Lua Call-Ins, with parameters===

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, label"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button" 
button parameter values: left - 1, middle - 2, right - 3

MouseRelease() --> "x, y, button" 
Please note that in order to have Spring call MouseRelease, you need to have a MousePress call-in in the same widget that returns true.

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, labeltext"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID, builderID"

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID?"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams"

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

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

* DrawWorld() --> none.

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

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameOver() --> "[ [1] = allyTeamID1, [2] = allyTeamID2, ... ]", a list of winning allyteams, if empty the game result was undecided ( like when dropping from an host ) Will return nil in pre 0.83.x

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID"

ProjectileDestroyed() --> "proID"

[[category: Lua]]

LuaCallinReturn

2011-04-10T05:53:33Z

Freezerburn: /* Commands, general-purpose: */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

===Lua Call-Ins, with parameters===

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, label"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button" 
Please note that in order to have Spring call MouseRelease, you need to have a MousePress call-in in the same widget that returns true.

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

MapDrawCmd() --> "playerID, cmdType, px, py, pz, labeltext"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID, builderID"

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID?"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams"

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

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

* DrawWorld() --> none.

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

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameOver() --> "[ [1] = allyTeamID1, [2] = allyTeamID2, ... ]", a list of winning allyteams, if empty the game result was undecided ( like when dropping from an host ) Will return nil in pre 0.83.x

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID"

ProjectileDestroyed() --> "proID"

[[category: Lua]]