Difference between revisions of "CommandLua"

From Baloogan Campaign Wiki
Jump to: navigation, search
Line 7: Line 7:
  
 
==Ckfinite's Tutorials==
 
==Ckfinite's Tutorials==
* [https://github.com/BenChung/CommandLuaDocs/wiki/Tutorial-1 Tutorial 1]  
+
* [http://commandlua.github.io/tutorials/01-getting-started.md.html Tutorial 1]  
 
* [https://github.com/BenChung/CommandLuaDocs/wiki/Tutorial-2 Tutorial 2]
 
* [https://github.com/BenChung/CommandLuaDocs/wiki/Tutorial-2 Tutorial 2]
 
* [https://github.com/BenChung/CommandLuaDocs/wiki/Tutorial-3 Tutorial 3]
 
* [https://github.com/BenChung/CommandLuaDocs/wiki/Tutorial-3 Tutorial 3]

Revision as of 22:14, 11 December 2014

Welcome to the Command Lua Wiki page. Here a number of useful links and video tutorials have been collected to help explain how to use the Command Lua API in your Command scenarios.


Documentation

Ckfinite's Tutorials

Tomcat's Tutorials

{{#ev:youtube|B4aUjddDHok}} {{#ev:youtube|ayDyeXx79hI}}

Function Examples

Global Functions
Objects Description
Unit Object A Ship/Submarine/Facility/Aircraft.
Reference Point Object A Reference Point.


Global Functions
Function Name Description
ScenEdit_SetWeather Set temperature, rainfall, cloud percentage and sea state.
ScenEdit_AddAircraft Creates a new aircraft in flight.
ScenEdit_AddShip Creates a new ship.
ScenEdit_AddSubmarine Creates a new submarine.
ScenEdit_AddFacility Creates a new facility.
ScenEdit_AssignUnitToMission Assigns a unit to a specified mission.
ScenEdit_SetSidePosture Sets the posture between two sides.
ScenEdit_SetEMCON Sets the state of the EMCON inheritable settings for a side, a missions, a group or a unit.
ScenEdit_RunScript Runs a script in your Lua directory.
ScenEdit_SetKeyValue Saves a variable into the scenario file.
ScenEdit_GetKeyValue Retrieves a variable from the scenario file.
ScenEdit_AddUnit Adds a unit.
ScenEdit_SetUnit Modifies a unit.
ScenEdit_DeleteUnit Deletes a unit.
ScenEdit_AddReferencePoint Adds a reference point.
ScenEdit_SetReferencePoint Modifies a reference point.
ScenEdit_DeleteReferencePoint Deletes a reference point.
print Evaluates an expression and writes it to the console window.
ScenEdit_SetDoctrine Sets a unit's doctrine.
ScenEdit_GetDoctrine Gets a unit's doctrine.
ScenEdit_CurrentTime Gets the time in the scenario.