Qrow: 1 revision imported

2026-02-24T06:39:03Z

1 revision imported

← Older revision	Revision as of 23:39, 23 February 2026
(No difference)

gamedatainter>Flozi: recat to Gamedata, isn't in the folder, but neither is ModInfo

2013-10-29T18:07:20Z

recat to Gamedata, isn't in the folder, but neither is ModInfo

New page

Note: map options (<code>mapoptions.lua</code>) and game options (<code>modoptions.lua</code>) are basically the same, so one page for both.

==Purpose==
Allow players to set game variables via lobby.

==Reading==
Use [[Lua_SyncedRead#Mod-.2FMap-Options|these functions.]]

To avoid errors '''check modoptions for being nil''', in case the game was not started by a lobby.
Otherwise you get "''attempt to index local 'modOptions' (a nil value)''"

<code><pre>
local lolfactor = 100 --some default value to be used when no modoptions are present
local modOptions = Spring.GetModOptions()
if (modOptions) then
lolfactor = modOptions.lolfactor
else
Spring.Echo ("no modoptions are set")
end
Spring.Echo ("lolfactor = " .. lolfactor)
--do something with lolfactor--</pre></code>

==Examples==
===Some simple example===
Allow players to set start resources.

<code><pre>local opts= {
{
key="startingmetal",
name="Start Metal",
desc="How much metal at start?",
type = 'number',
def = 4000,
min = 1,
max = 40000,
step = 1,
},
return opts</pre></code>

The gadget that gives the start resources reads it like this:
<code><pre>local startingmetal=4000
local modOptions = Spring.GetModOptions()
if (modOptions) then startingmetal = modOptions.startingmetal or 4000 end
Spring.SetTeamResource(teamID, "m", startingmetal)</pre></code>

==links==
zero-K: http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/ModOptions.lua

[[Category:Gamedata]]

Modoptions.lua - Revision history

Qrow: 1 revision imported

gamedatainter>Flozi: recat to Gamedata, isn't in the folder, but neither is ModInfo