Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix #3192, move engineoptions to modoptions
Does not affect the game itself, but makes them available in Chobby UI.
- Loading branch information
Showing
2 changed files
with
56 additions
and
210 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,210 +1,3 @@ | ||
| -- $Id$ | ||
| -- 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 = 'startconds', | ||
| name = 'Starting Conditions', | ||
| desc = 'Set the starting conditions.', | ||
| type = 'section', | ||
| }, | ||
| { | ||
| key = 'modifiers', | ||
| name = 'In-Game Conditions', | ||
| desc = 'Set up ingame conditions.', | ||
| type = 'section', | ||
| }, | ||
| --[[ | ||
| { | ||
| key = 'GameMode', | ||
| name = 'Game end condition', | ||
| desc = 'Determines what condition triggers the defeat of a player', | ||
| type = 'list', | ||
| section= 'modifiers', | ||
| def = '0', | ||
| items = | ||
| { | ||
| { | ||
| key = '0', | ||
| name = 'Kill everything', | ||
| desc = 'The player will lose when all his units have died', | ||
| }, | ||
| { | ||
| key = '1', | ||
| name = 'Commander ends', | ||
| desc = 'The player will lose when his commander dies', | ||
| }, | ||
| { | ||
| key = '2', | ||
| name = 'Commander lineage ends', | ||
| desc = 'This is a stricter form of commander ends\nevery unit will inherit the lineage from the player whom built it\neven if shared, when the commander dies the unit will still die', | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| key = 'StartMetal', | ||
| name = 'Starting metal', | ||
| desc = 'Determines amount of metal and metal storage that each player will start with', | ||
| type = 'number', | ||
| section= 'startconds', | ||
| def = 1000, | ||
| min = 0, | ||
| max = 10000, | ||
| step = 10, -- quantization is aligned to the def value | ||
| -- (step <= 0) means that there is no quantization | ||
| }, | ||
| { | ||
| key = 'StartEnergy', | ||
| name = 'Starting energy', | ||
| desc = 'Determines amount of metal and metal storage that each player will start with', | ||
| type = 'number', | ||
| section= 'StartingResources', | ||
| def = 1000, | ||
| min = 0, | ||
| max = 10000, | ||
| step = 10, -- quantization is aligned to the def value | ||
| -- (step <= 0) means that there is no quantization | ||
| }, | ||
| --]] | ||
| { | ||
| key = 'MaxUnits', | ||
| name = 'Max units', | ||
| desc = 'Determines the ceiling of how many units and buildings a player is allowed to own at the same time (limited by spring to 10000 / (#commanders + 1))', | ||
| type = 'number', | ||
| section= 'modifiers', | ||
| def = 1500, | ||
| min = 10, | ||
| max = 3000, | ||
| step = 10, -- quantization is aligned to the def value | ||
| -- (step <= 0) means that there is no quantization | ||
| }, | ||
| --[[ { | ||
| key = 'LimitDgun', | ||
| name = 'Limit D-Gun range', | ||
| desc = "The commander's D-Gun weapon will be usable only close to the player's starting location", | ||
| type = 'bool', | ||
| section = 'modifiers', | ||
| def = false, | ||
| },]]-- | ||
| --[[ | ||
| { | ||
| 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", | ||
| type = 'bool', | ||
| def = true, | ||
| }, | ||
| --]] | ||
| { | ||
| key = 'diplomacy', | ||
| name = 'Diplomacy Settings', | ||
| desc = 'Configure diplomacy settings.', | ||
| type = 'section', | ||
| }, | ||
| { | ||
| key = 'FixedAllies', | ||
| name = 'Fixed ingame alliances', | ||
| desc = 'Disables the use of the /ally command for ingame ceasefires. \nkey: fixedallies', | ||
| type = 'bool', | ||
| section = 'diplomacy', | ||
| def = false, | ||
| }, | ||
| { | ||
| key = 'MinSpeed', | ||
| name = 'Minimum game speed', | ||
| desc = 'Sets the minimum speed that the players will be allowed to change to', | ||
| type = 'number', | ||
| section= 'modifiers', | ||
| def = 0.5, | ||
| min = 0.1, | ||
| max = 10, | ||
| step = 0.1, -- quantization is aligned to the def value | ||
| -- (step <= 0) means that there is no quantization | ||
| }, | ||
| { | ||
| key = 'MaxSpeed', | ||
| name = 'Maximum game speed', | ||
| desc = 'Sets the maximum speed that the players will be allowed to change to', | ||
| type = 'number', | ||
| section= 'modifiers', | ||
| def = 2, | ||
| min = 0.1, | ||
| max = 10, | ||
| step = 0.1, -- quantization is aligned to the def value | ||
| -- (step <= 0) means that there is no quantization | ||
| }, | ||
| { | ||
| key = 'mapsettings', | ||
| name = 'Map Related Settings', | ||
| desc = 'Configure map related settings.', | ||
| type = 'section', | ||
| }, | ||
| { | ||
| key = 'DisableMapDamage', | ||
| name = 'Disable Map Deformations', | ||
| desc = 'Prevents the map shape from being changed by weapons and terraforming', | ||
| type = 'bool', | ||
| section= 'mapsettings', | ||
| 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 | ||
| --[[ engineoptions moved to modoptions for ease of use/maintenance | ||
| all *options files are for lobby only anyway, no effect on game ]] | ||
| return {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters