Ccw: Reverted edits by Bonzo (talk) to last revision by Vincent

2016-04-01T03:05:49Z

Reverted edits by Bonzo (talk) to last revision by Vincent

Show changes

Bonzo: Blanked the page

2016-03-31T16:13:44Z

Blanked the page

Show changes

Vincent: /* onPollEnd */

2012-07-04T14:39:31Z

onPollEnd

← Older revision		Revision as of 14:39, 4 July 2012
Line 111:		Line 111:
	===onPollEnd===		===onPollEnd===
	<syntaxhighlight lang="lua">void onPollEnd ( chosenOption )</syntaxhighlight>		<syntaxhighlight lang="lua">void onPollEnd ( chosenOption )</syntaxhighlight>
	Срабатывает по окончании опроса. Отмена не дает никакого эффекта.		Срабатывает по окончании опроса. Отмена не дает никакого эффекта.<br />
	'''chosenOption''': Возвращает номер выбранной опции.		'''chosenOption''': Возвращает номер выбранной опции.

Vincent at 14:39, 4 July 2012

2012-07-04T14:39:11Z

← Older revision		Revision as of 14:39, 4 July 2012
Line 110:		Line 110:

	===onPollEnd===		===onPollEnd===
	<syntaxhighlight lang="lua">void onPollEnd ( )</syntaxhighlight>		<syntaxhighlight lang="lua">void onPollEnd ( chosenOption )</syntaxhighlight>
	Срабатывает по окончании опроса. Отмена не дает никакого эффекта.		Срабатывает по окончании опроса. Отмена не дает никакого эффекта.
			'''chosenOption''': Возвращает номер выбранной опции.

	===onPollDraw===		===onPollDraw===

Vincent at 20:16, 18 May 2012

2012-05-18T20:16:36Z

Show changes

D0lph1n: new page

2009-04-12T07:13:38Z

new page

New page

{{RU/Resource page}}
__NOTOC__
This script manages any kind of poll with multiple options. '''votemap''', '''votekick''', '''votekill''' and '''voteban''' are built in.
==Built-in polls==

'''votemap''' (starts a vote between a random list of up to 9 maps compatible with the current gamemode, if one is running)

'''votemap gamemode''' (starts a vote between a random list of up to 9 maps compatible with the specified gamemode)

'''votemap gamemode map''' (starts a vote to launch the specified gamemode with the specified map)

'''votemap map gamemode''' (same as previous one)

'''votemap map''' (starts a vote to change to another map for the current gamemode, if one is running)

'''votemode''' (starts a vote between a random list of up to 9 gamemodes. once the vote is done and a new gamemode is picked, automatically starts 'votemap gamemode')

'''votekick player''' (starts a vote to kick the specified player)

'''votekill player''' (starts a vote to kill the specified player)

'''voteban player''' (starts a vote to ban the specified player)

==Serverside functions==
===startPoll===
<syntaxhighlight lang="lua">bool, int startPoll ( table pollData )</syntaxhighlight>
Creates a poll. Returns ''true'' if the poll was created successfully, ''false'' and an error code otherwise (see the source for error codes).

* '''pollData''' is a table containing poll settings and an array of ''at least two'' options. Each option comes in the form:
<syntaxhighlight lang="lua">
{
string optionName,
string eventToTrigger,
[element triggerFrom = getRootElement()],
default = [bool isDefaultOption = false],
var argument1,
var argument2,
...
}
</syntaxhighlight>
The chosen option will trigger eventToTrigger from the triggerFrom element with ''arguments...'' as parameters when the poll ends.

If there's not enough votes, the default option will be executed if there's one.

Example:
<syntaxhighlight lang="lua">
local playerToKill = getRandomPlayer()
local notEnoughVotesMessage = "Not enough votes to kill "..getPlayerName(playerToKill).."."
startPoll {
--start settings (dictionary part)
title="Kill "..getPlayerName(playerToKill).."?",
percentage=75,
timeout=30,
allowchange=false,
maxnominations=3,
visibleTo=getRootElement(),
--start options (array part)
[1]={"Yes", "doKillPlayer", playerToKill},
[2]={"No", "doOutputChatBox", notEnoughVotesMessage, getRootElement(), vR, vG, vB; default=true},
}
</syntaxhighlight>
*'''title''' (required): the poll title which will be seen by clients on the manager GUI
*'''percentage''' (optional, defaults to default.percentage): percentage needed for an option to pass
*'''timeout''' (optional, defaults to default.timeout): poll timeout in seconds
*'''allowchange''' (optional, defaults to default.allowchange): specifies if changing your vote is allowed
*'''maxnominations''' (optional, defaults to default.maxnominations): specifies the max number of nominations in case there's a draw
*'''visibleTo''' (optional, defaults to [[getRootElement]]()): a table or players that will be able to see the poll, OR an element that contains the players.
If it is root, new players joining the server will be able to vote.

''voteconfig.xml'' defaults will be used for missing optional settings.

===stopPoll===
<syntaxhighlight lang="lua">bool, int stopPoll ( )</syntaxhighlight>
Stops the running poll. Returns ''true'' if the current poll was stopped successfully, ''false'' and an error code otherwise.

===voteMap===
<syntaxhighlight lang="lua">bool, int voteMap ( string mapName )</syntaxhighlight>
Starts a votemap. Returns ''true'' if it was successfully started, ''false'' and an error code otherwise.

===voteBetweenMaps===
<syntaxhighlight lang="lua">bool, int voteBetweenMaps ( resource map1, resource map2, [ resource map3, ... ] )</syntaxhighlight>
Starts a poll to choose a map. Returns ''true'' if it was successfully started, ''false'' and an error code otherwise.

===voteKick===
<syntaxhighlight lang="lua">bool, int voteKick ( player thePlayer )</syntaxhighlight>
Starts a votekick. Returns ''true'' if it was successfully started, ''false'' and an error code otherwise.

===voteKill===
<syntaxhighlight lang="lua">bool, int voteKill ( player thePlayer )</syntaxhighlight>
Starts a votekill. Returns ''true'' if it was successfully started, ''false'' and an error code otherwise.

===voteBan===
<syntaxhighlight lang="lua">bool, int voteBan ( player thePlayer )</syntaxhighlight>
Starts a voteban. Returns ''true'' if it was successfully started, ''false'' and an error code otherwise.

==Serverside events==
===onPollStart===
<syntaxhighlight lang="lua">void onPollStart ( )</syntaxhighlight>
Fired before a poll starts. Cancelling it aborts the poll.

===onPollStop===
<syntaxhighlight lang="lua">void onPollStop ( )</syntaxhighlight>
Fired before a poll is halted. Cancelling it prevents the poll from being halted.

===onPollEnd===
<syntaxhighlight lang="lua">void onPollEnd ( )</syntaxhighlight>
Fired after a poll finished. Cancelling it has no effect.

===onPollDraw===
<syntaxhighlight lang="lua">void onPollDraw ( )</syntaxhighlight>
Fired when a poll ends in a draw. Cancelling it aborts renominations.

===onClientSendVote===
<syntaxhighlight lang="lua">void onClientSendVote ( int vote )</syntaxhighlight>
Fired when a vote is sent to the server. ''client'' is the client who sent the vote. Cancelling it makes the manager ignore the client's choice.

==Default settings==
<syntaxhighlight lang="xml">
<settings>
<setting name="*color" value="#DF6464" />
<setting name="*log_votes" value="[true]" />

<setting name="*default.timeout" value="[30]"/>
<setting name="*default.allowchange" value="[false]"/>
<setting name="*default.percentage" value="[75]"/>
<setting name="*default.maxnominations" value="[3]"/>

<setting name="*votemap.enabled" value="[true]"/>
<setting name="*votemap.timeout" value="[30]"/>
<setting name="*votemap.locktime" value="[60]"/>
<setting name="*votemap.percentage" value="[70]"/>
<setting name="*votemap.allowchange" value="[true]"/>

<setting name="*votekick.enabled" value="[true]"/>
<setting name="*votekick.timeout" value="[30]"/>
<setting name="*votekick.locktime" value="[120]"/>
<setting name="*votekick.percentage" value="[75]"/>
<setting name="*votekick.allowchange" value="[true]"/>

<setting name="*voteban.enabled" value="[false]"/>
<setting name="*voteban.timeout" value="[30]"/>
<setting name="*voteban.locktime" value="[120]"/>
<setting name="*voteban.percentage" value="[85]"/>
<setting name="*voteban.allowchange" value="[true]"/>

<setting name="*votekill.enabled" value="[true]"/>
<setting name="*votekill.timeout" value="[30]"/>
<setting name="*votekill.locktime" value="[120]"/>
<setting name="*votekill.percentage" value="[75]"/>
<setting name="*votekill.allowchange" value="[true]"/>

</settings>
</syntaxhighlight>

RU/Resource:Votemanager - Revision history

Ccw: Reverted edits by Bonzo (talk) to last revision by Vincent

Bonzo: Blanked the page

Vincent: /* onPollEnd */

Vincent at 14:39, 4 July 2012

Vincent at 20:16, 18 May 2012

D0lph1n: new page