Lua UnitRendering

Development < Lua Scripting < Lua UnitRendering

Unit Rendering

Spring.UnitRendering.SetLODCount

 ( number unitID, int lodCount ) -> nil

Spring.UnitRendering.SetLODLength (`lod` is 1-indexed)

 ( number unitID, int lod, number lodLength ) -> nil

Spring.UnitRendering.SetLODDistance (same as SetLODLength(), but adjusted for 45deg FOV + 1024x768)

 (number unitID,  int lod, number lodDistance ) -> nil

Spring.UnitRendering.SetPieceList (displayList=nil reset to default)

 ( number unitID, int lod, int piece [, number displayList = nil ] ) -> nil

Spring.UnitRendering.GetMaterial (creates a material userdata)

 ( string MaterialType, table Material ) -> userdata Material

Spring.UnitRendering.SetMaterial

 ( number unitID, int lod, string MaterialType, userdata Material | table Material ) -> nil

Spring.UnitRendering.SetMaterialLastLOD

 ( number unitID, string MaterialType, int lastLOD ) -> nil

Spring.UnitRendering.SetMaterialDisplayLists

 ( number unitID, int lod, string MaterialType, preDisplayList, postDisplayList ) -> nil

Spring.UnitRendering.SetUnitUniform (unfinished)

 ( number unitID, string MaterialType, int lod, arg1, arg2, ... ) -> nil

Debug

Spring.UnitRendering.Debug (prints some usefull debug informations)

 ( [ number unitID ] ) -> nil

Lua's DrawXYZ-Callin

Spring.UnitRendering.SetUnitLuaDraw (enables the LuaRules' DrawUnit callin)

 ( number unitID, boolean enabled ) -> nil

Spring.UnitRendering.SetFeatureLuaDraw (enables the LuaRules' DrawFeature callin)

 ( number featureID, boolean enabled ) -> nil

MaterialTypes

"alpha"
"opaque"
"alpha_reflect"
"opaque_reflect"
"shadow"

Material UserData

none user accessible methods (yet)

Material Table

 material = {
   ["order"  = number ,]
   ["culling" = number face ,]
   ["shader" = lua_shader | string "3do" | string "s3o" ,]

   ["texunits" = {
       [ [0] = { ["tex" = see gl.Texture ,]
                 ["enable" = boolean true ] }, ]
       [ [3] = see gl.Texture, ]
       (upto [15] and supports holes in it)
     } ,]

   ["texunit0" = see gl.Texture ,]
    ...
   ["texunit7" = see gl.Texture ,]

   ["prelist"   = lua_displaylist ,]
   ["postlist"  = lua_displaylist ,]
   ["usecamera" = boolean ,]
   ["cameraloc" = number uniformLocation,]
   ["cameraposloc" = number uniformLocation,]
   ["camerainvloc"  = number uniformLocation,]
   ["shadowloc"       = number uniformLocation,]
   ["shadowparamsloc" = number uniformLocation,]
 }