mapcycler: misc. improvements (#305)

* mapcycler: improve settings definitions for admin panel

* mapcycler: add hibernate_when_empty option

When set to "true", the server will wait until a player joins to cycle maps if it is empty. This is ignored if the cycle mode is "vote" due to a limitation in votemanager (votes cannot be held without a player present).

Author: jlillis

[managers]/mapcycler/mapcycler.lua

@@ -17,17 +17,28 @@ addEventHandler("onResourceStart", thisResourceRoot,
 	end
 )
 
-addEvent "onRoundFinished"
+addEvent("onRoundFinished")
 
 remainingRounds = 0
 
 function roundCounter()
 	remainingRounds = remainingRounds - 1
 	if remainingRounds == 0 then
-		cyclerFunction()
+		-- if no players are present, wait until a player joins to cycle
+		if #getElementsByType("player") == 0 and (get("*hibernate_when_empty") == "true" or cycleMode == "vote") then
+			addEventHandler("onPlayerJoin", root, cycleOnJoin)
+			outputDebugString("mapcycler: server empty; hibernating until a player joins")
+		else
+			cyclerFunction()
+		end
 	end
 end
 
+function cycleOnJoin()
+	cyclerFunction()
+	removeEventHandler("onPlayerJoin", root, cycleOnJoin)
+end
+
 function outputCycler(message, toElement)
 	local r, g, b = getColorFromString(string.upper(get("color")))
 	outputChatBox(message, toElement or getRootElement(), r, g, b)

[managers]/mapcycler/meta.xml

@@ -7,8 +7,37 @@
 	<script src="vote_mode.lua" type="server"/>
 	<script src="random_mode.lua" type="server"/>
 	<settings>
-		<setting name="*mode" value="vote" />
-		<setting name="*vote_rounds" value="[1]" />
-		<setting name="*random_rounds" value="[1]" />
+		<setting
+			name="*mode"
+			value="vote"
+			friendlyname="Cycler mode"
+			group="Map Cycler"
+			accept="vote,list,random"
+			desc="Map cycler mode. 'vote' mode will launch a vote at the end of the round. 'list' mode will use the list defined in mapcycle.xml. 'random' mode will choose a map at random."
+		/>
+		<setting
+			name="*vote_rounds"
+			value="[1]" 
+			friendlyname="Rounds between votes"
+			group="Map Cycler"
+			accept="1-65535"
+			desc="Number of rounds between map votes. Only effective if cycler mode is set to 'vote'."
+		/>
+		<setting
+			name="*random_rounds"
+			value="[1]" 
+			friendlyname="Rounds between random selections"
+			group="Map Cycler"
+			accept="1-65535"
+			desc="Number of rounds between random map selections. Only effective if cycler mode is set to 'random'."
+		/>
+		<setting
+			name="*hibernate_when_empty"
+			value="true" 
+			friendlyname="Hibernate when server is empty"
+			group="Map Cycler"
+			accept="true,false"
+			desc="If true, the server will wait until a player joins to cycle maps. Only effective if cycler mode is set to 'list' or 'random'."
+		/>
 	</settings>
 </meta>