Validmaps.lua - Revision history

Flozi: Game development -> Game Dev

2013-03-25T20:18:09Z

Game development -> Game Dev

← Older revision		Revision as of 21:18, 25 March 2013
Line 135:		Line 135:
	'''Alpha Lobby''' - ?<br>		'''Alpha Lobby''' - ?<br>

	[[Category:Game ~~development~~]]		[[Category:Game Dev]]

Knorke: /* Map names */ del

2012-01-18T13:29:37Z

Map names: del

← Older revision		Revision as of 14:29, 18 January 2012
Line 21:		Line 21:
	<font color="red">		<font color="red">
	'''=>'''don't know, please add		'''=>'''don't know, please add
	~~</font>~~

	~~==Map names==~~
	~~<font color="red">~~
	~~'''=>'''not sure if map names must contain .smf or not!~~
	</font>		</font>

Knorke: mapnames without .smf

2012-01-18T13:23:14Z

mapnames without .smf

← Older revision		Revision as of 14:23, 18 January 2012
Line 29:		Line 29:

	==Simple Example==		==Simple Example==
	~~from: http://springrts.com/phpbb/viewtopic.php?f=11&t=19495 by zwzsg<br>~~
	Just returning a table of map names is the easiest example:		Just returning a table of map names is the easiest example:

	<pre>		<pre>
	return {		return {
	"~~Spring Racers Track 01.smf~~",		"DesertCliffsV1",
	"~~Spring Racers Track 02.smf",~~		"Eye_Of_Horus_v2",
	~~"Spring Racers Track 03.smf",~~
	~~"Spring Racers Track 04.smf",~~
	~~"Spring Racers Track 05.smf",~~
	~~"Spring Racers Track 06.smf",~~
	~~"Spring Racers Track 07.smf",~~
	~~"Spring Racers Track 08.smf",~~
	~~"Spring Racers Track 09.smf",~~
	~~"Spring Racers Track 10.smf",~~
	~~"Spring Racers Track 11.smf",~~
	~~"Spring Racers Track 12.smf~~",
	}		}
	</pre>		</pre>

			'''Note:''' Use mapnames as returned by [[Lua_ConstGame\|Game.mapName]]

	===Example to filter maps by various aspects===		===Example to filter maps by various aspects===

Flozi: /* Compatible Lobbies */

2011-04-04T18:44:15Z

Compatible Lobbies

← Older revision		Revision as of 19:44, 4 April 2011
Line 144:		Line 144:
	</font>		</font>
	'''TASClient''' - yes (?) Satirik: ''just fixed it in tasclient'' http://springrts.com/phpbb/viewtopic.php?f=11&t=19495 <br>		'''TASClient''' - yes (?) Satirik: ''just fixed it in tasclient'' http://springrts.com/phpbb/viewtopic.php?f=11&t=19495 <br>
	'''Spring Lobby''' - No<br>		'''Spring Lobby''' - No, _koshi_: ''yeah, we actually can build a list of valid maps, it's just not used in the frontend''
			<br>
	'''zeroK Lobby''' - ?<br>		'''zeroK Lobby''' - ?<br>
	'''Alpha Lobby''' - ?<br>		'''Alpha Lobby''' - ?<br>

	[[Category:Game development]]		[[Category:Game development]]

Flozi: /* Compatible Lobbies */

2011-04-04T18:30:53Z

Compatible Lobbies

← Older revision		Revision as of 19:30, 4 April 2011
Line 144:		Line 144:
	</font>		</font>
	'''TASClient''' - yes (?) Satirik: ''just fixed it in tasclient'' http://springrts.com/phpbb/viewtopic.php?f=11&t=19495 <br>		'''TASClient''' - yes (?) Satirik: ''just fixed it in tasclient'' http://springrts.com/phpbb/viewtopic.php?f=11&t=19495 <br>
	'''Spring Lobby''' - ?<br>		'''Spring Lobby''' - No<br>
	'''zeroK Lobby''' - ?<br>		'''zeroK Lobby''' - ?<br>
	'''Alpha Lobby''' - ?<br>		'''Alpha Lobby''' - ?<br>

	[[Category:Game development]]		[[Category:Game development]]

Knorke: created page. gtg so couldnt finish+test. red text = missing info

2011-04-04T12:33:04Z

created page. gtg so couldnt finish+test. red text = missing info

New page

==Location==
validmaps.lua is a file in the root folder of a Spring game.

==Purpose==
from http://springrts.com/wiki/The_Talking_Changelog
<pre>
Valid maps are listed in the mod's "ValidMaps.lua" file
A valid map count of 0 means that any map can be used with the mod
This can be used in concert with LuaRules to setup multi-player scenarios and tutorials
</pre>
Basically this means that a Spring game can create a whitelist of maps and the lobbies will only display these maps in their selection menu. In the end it depends on the lobby how maps are listed.
All map names that are returned are playabe.

To block a certain map, validmaps.lua has to loop through all maps to build a table of mapnames, not inserting the unwanted map, and then return that table. 

'''=>'''is it that correct? Or is there an easy way, ie returning a second table of unvalid maps or is there an unvalidmaps.lua?


==Source==

'''=>'''don't know, please add


==Map names==

'''=>'''not sure if map names must contain .smf or not!


==Simple Example==
from: http://springrts.com/phpbb/viewtopic.php?f=11&t=19495 by zwzsg 
Just returning a table of map names is the easiest example:

<pre>
return {
"Spring Racers Track 01.smf",
"Spring Racers Track 02.smf",
"Spring Racers Track 03.smf",
"Spring Racers Track 04.smf",
"Spring Racers Track 05.smf",
"Spring Racers Track 06.smf",
"Spring Racers Track 07.smf",
"Spring Racers Track 08.smf",
"Spring Racers Track 09.smf",
"Spring Racers Track 10.smf",
"Spring Racers Track 11.smf",
"Spring Racers Track 12.smf",
}
</pre>

===Example to filter maps by various aspects===
http://code.google.com/p/zero-k/source/browse/trunk/mods/zk/ValidMaps.lua by det
If I understand this correctly this not a working example (it is disabled with ''if (false)'' anyway) but more a reference:
<pre>
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--
-- ValidMaps.lua
--
-- This file can be added to a mod to dictate which maps
-- can (and can not) be used with it. The map information
-- is the map's default information, and is done before
-- MapOptions.lua can be used by maps.
--
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--
-- Map specific call-outs:
--
-- Spring.GetMapList() -> { 'map1.smf', 'map2.smf', 'map3.sm3', etc... }
--
-- Spring.GetMapInfo('map1') -> {
-- author = 'string',
-- desc = 'string',
-- mapX = number,
-- mapY = number,
-- tidal = number,
-- gravity = number,
-- metal = number,
-- windMin = number,
-- windMax = number,
-- extractorRadius = number,
-- startPos = {
-- [1] = { x = number, z = number },
-- [2] = { x = number, z = number },
-- [3] = { x = number, z = number },
-- etc ...
-- },
-- }
--
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--
-- Example filtering code
--

if (false) then
local mapList = Spring.GetMapList()
local validMaps = {}
for _, mapName in ipairs(mapList) do
if (mapName:lower():find('metal')) then
local mapInfo = Spring.GetMapInfo(mapName)
local minX = (16 * 512)
local minY = (8 * 512)
if ((mapInfo.mapX >= minX) and
(mapInfo.mapY >= minY)) then
validMaps[#validMaps + 1] = mapName
end
end
end
if (#validMaps == 0) then
return { 'FAKEMAP' }
else
return validMaps
end
end

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------

return {} -- returning an empty table means *ALL MAPS* are valid
-- for *NO MAPS*, return a fake map name, ex: { 'FakeMap' }

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
</pre>

===Working exampe===

'''=>'''would be nice to have one 

<pre>
--this validmaps.lua:
--blocks all "speedmetal" variants by name
--only allows square sized maps
--also allows the map "Derpa Derp"
EXAMPLE SCRIPT
</pre>

==Compatible Lobbies==

'''=>'''What lobbies read and support this? 

'''TASClient''' - yes (?) Satirik: ''just fixed it in tasclient'' http://springrts.com/phpbb/viewtopic.php?f=11&t=19495 
'''Spring Lobby''' - ? 
'''zeroK Lobby''' - ? 
'''Alpha Lobby''' - ? 

[[Category:Game development]]