Difference between revisions of "CommandLua"

From Baloogan Campaign Wiki
Jump to: navigation, search
Line 8: Line 8:
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_SetWeather|ScenEdit_SetWeather]]'''
 
| '''[[LuaApi:ScenEdit_SetWeather|ScenEdit_SetWeather]]'''
 +
| Set temperature, rainfall, cloud percentage and sea state.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_AddAircraft|ScenEdit_AddAircraft]]'''
 
| '''[[LuaApi:ScenEdit_AddAircraft|ScenEdit_AddAircraft]]'''
 +
| Creates a new aircraft in flight.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_AddShip|ScenEdit_AddShip]]'''
 
| '''[[LuaApi:ScenEdit_AddShip|ScenEdit_AddShip]]'''
 +
| Creates a new ship.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_AddSubmarine|ScenEdit_AddSubmarine]]'''
 
| '''[[LuaApi:ScenEdit_AddSubmarine|ScenEdit_AddSubmarine]]'''
 +
| Creates a new submarine.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_AddFacility|ScenEdit_AddFacility]]'''
 
| '''[[LuaApi:ScenEdit_AddFacility|ScenEdit_AddFacility]]'''
 +
| Creates a new facility.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_AssignUnitToMission|ScenEdit_AssignUnitToMission]]'''
 
| '''[[LuaApi:ScenEdit_AssignUnitToMission|ScenEdit_AssignUnitToMission]]'''
 +
| Assigns a unit to a specified mission.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_SetSidePosture|ScenEdit_SetSidePosture]]'''
 
| '''[[LuaApi:ScenEdit_SetSidePosture|ScenEdit_SetSidePosture]]'''
 +
| Sets the posture between two sides.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_SetEMCON|ScenEdit_SetEMCON]]'''
 
| '''[[LuaApi:ScenEdit_SetEMCON|ScenEdit_SetEMCON]]'''
 +
| Sets the state of the EMCON inheritable settings for a side, a missions, a group or a unit.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_RunScript|ScenEdit_RunScript]]'''
 
| '''[[LuaApi:ScenEdit_RunScript|ScenEdit_RunScript]]'''
 +
| Runs a script in your Lua directory.
 
|-
 
|-
| '''[[LuaApi:ScenEdit_SetKeyValue|ScenEdit_GetKeyValue]]'''
+
| '''[[LuaApi:ScenEdit_SetKeyValue|ScenEdit_SetKeyValue]]'''
 +
| Saves a variable into the scenario file.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_GetKeyValue|ScenEdit_GetKeyValue]]'''
 
| '''[[LuaApi:ScenEdit_GetKeyValue|ScenEdit_GetKeyValue]]'''
 +
| Retrieves a variable from the scenario file.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_AddUnit|ScenEdit_AddUnit]]'''
 
| '''[[LuaApi:ScenEdit_AddUnit|ScenEdit_AddUnit]]'''
 +
| Adds a unit.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_SetUnit|ScenEdit_SetUnit]]'''
 
| '''[[LuaApi:ScenEdit_SetUnit|ScenEdit_SetUnit]]'''
 +
| Modifies a unit.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_DeleteUnit|ScenEdit_DeleteUnit]]'''
 
| '''[[LuaApi:ScenEdit_DeleteUnit|ScenEdit_DeleteUnit]]'''
 +
| Deletes a unit.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_AddReferencePoint|ScenEdit_AddReferencePoint]]'''
 
| '''[[LuaApi:ScenEdit_AddReferencePoint|ScenEdit_AddReferencePoint]]'''
 +
| Adds a reference point.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_SetReferencePoint|ScenEdit_SetReferencePoint]]'''
 
| '''[[LuaApi:ScenEdit_SetReferencePoint|ScenEdit_SetReferencePoint]]'''
 +
| Modifies a reference point.
 
|-
 
|-
 
| '''[[LuaApi:ScenEdit_DeleteReferencePoint|ScenEdit_DeleteReferencePoint]]'''
 
| '''[[LuaApi:ScenEdit_DeleteReferencePoint|ScenEdit_DeleteReferencePoint]]'''
 +
| Deletes a reference point.
 
|}
 
|}

Revision as of 09:14, 22 November 2014

Command Lua API
Function Name Description Example
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.