EngineOptions.lua

--  Custom Options Definition Table format

--  NOTES:
--  - using an enumerated table lets you specify the options order

--
--  These keywords must be lowercase for LuaParser to read them.
--
--  key:      the string used in the script.txt
--  name:     the displayed name
--  desc:     the description (could be used as a tooltip)
--  type:     the option type
--  def:      the default value
--  min:      minimum value for number options
--  max:      maximum value for number options
--  step:     quantization step, aligned to the def value
--  maxlen:   the maximum string length for string options
--  items:    array of item strings for list options
--  scope:    "all", "player", "team", "allyteam"      <<< not supported yet >>>
--

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--
--  Example EngineOptions.lua 
--

local options = 
{
  {
    key    = "StartingResources",
    name   = "Starting Resources",
    desc   = "Sets storage and amount of resources that players will start with (key = 'StartingResources')",
    type   = "section",
  },
  
  {
    key    = "StartMetal",
    name   = "Starting Command",
    desc   = "Sets the starting Command Point level for all players (key = 'StartMetal')",
    type   = "number",
    section= "StartingResources",
    def    = 1000,
    min    = 0,
    max    = 50000,
    step   = 10,  -- quantization is aligned to the def value
                    -- (step <= 0) means that there is no quantization
  },
  --[[{
    key    = "StartEnergy",
    name   = "Starting Logistics",
    desc   = "Sets the starting Logistics level for all players",
    type   = "number",
    section= "StartingResources",
    def    = 500,
    min    = 0,
    max    = 50000,
    step   = 10,  -- quantization is aligned to the def value
                    -- (step <= 0) means that there is no quantization
  },]]--
  
  {
    key    = "GhostedBuildings",
    name   = "Ghosted buildings",
    desc   = "Once an enemy building will be spotted\n a ghost trail will be placed to memorize location even after the loss of the line of sight (key = 'GhostedBuildings')",
    type   = "bool",
    def    = true,
  },

  {
    key    = "FixedAllies",
    name   = "Fixed ingame alliances",
    desc   = "Disables the possibility of players to dynamically change allies ingame (key = 'FixedAllies')",
    type   = "bool",
    def    = false,
  },

  {
    key    = "LimitSpeed",
    name   = "Speed Restriction",
    desc   = "Limits maximum and minimum speed that the players will be allowed to change to (key = 'LimitSpeed')",
    type   = "section",
  },
  
  {
    key    = "MaxSpeed",
    name   = "Maximum game speed",
    desc   = "Sets the maximum speed that the players will be allowed to change to (key = 'MaxSpeed')",
    type   = "number",
    section= "LimitSpeed",
    def    = 3,
    min    = 0.1,
    max    = 100,
    step   = 0.1,  -- quantization is aligned to the def value
                    -- (step <= 0) means that there is no quantization
  },
  
  {
    key    = "MinSpeed",
    name   = "Minimum game speed",
    desc   = "Sets the minimum speed that the players will be allowed to change to (key = 'MinSpeed')",
    type   = "number",
    section= "LimitSpeed",
    def    = 0.3,
    min    = 0.1,
    max    = 100,
    step   = 0.1,  -- quantization is aligned to the def value
                    -- (step <= 0) means that there is no quantization
  },
  
  {
    key    = "DisableMapDamage",
    name   = "Undeformable map",
    desc   = "Prevents the map shape from being changed by weapons (key = 'DisableMapDamage')",
    type   = "bool",
    def    = false,
  },
--[[
-- the following options can create problems and were never used by interface programs, thus are commented out for the moment
  
  {
    key    = "LuaGaia",
    name   = "Enables gaia",
    desc   = "Enables gaia player",
    type   = "bool",
    def    = true,
  },
  
  {
    key    = "NoHelperAIs",
    name   = "Disable helper AIs",
    desc   = "Disables luaui and group ai usage for all players",
    type   = "bool",
    def    = false,
  },
  
  {
    key    = "LuaRules",
    name   = "Enable LuaRules",
    desc   = "Enable mod usage of LuaRules",
    type   = "bool",
    def    = true,
  },

--]]

}
return options