Difference between revisions of "Left 4 Voting"
DJ Tsunami (talk | contribs) (→How voting works) |
(Updated with events and fixed the order up a bit.) |
||
| Line 2: | Line 2: | ||
== How voting works == | == How voting works == | ||
| − | |||
| − | + | # Server sends a vote_started event | |
| + | # Servers sends a vote_changed event | ||
| + | # Clients use the "Vote" command to register their votes ("Yes" or "No"), after which the server sends a vote_cast_yes or vote_cast_no event, followed by a vote_changed event with updated numbers. | ||
| + | # Server ends the vote by sending vote_ended event, followed by a vote_passed or vote_failed event. | ||
| + | |||
| + | == Console Commands == | ||
| + | |||
| + | === Vote === | ||
| + | |||
| + | {{qnotice|This command is only valid when a vote is ongoing.}}<br /> | ||
| + | {{begin-hl2msg|Vote|string}} | ||
| + | {{hl2msg|string|option|"Yes" or "No"}} | ||
| + | {{end-hl2msg}} | ||
| + | |||
| + | == Events == | ||
| + | {{qnotice|team is -1 when sent to all players)}}<br> | ||
| + | |||
| + | === vote_ended === | ||
| + | {{begin-hl2msg|vote_ended|string}} | ||
| + | {{hl2msg|None|None|}} | ||
| + | {{end-hl2msg}} | ||
| + | |||
| + | === vote_started === | ||
| + | {{begin-hl2msg|vote_started|string}} | ||
| + | {{hl2msg|string|issue|}} | ||
| + | {{hl2msg|string|param1|}} | ||
| + | {{hl2msg|byte|team|}} | ||
| + | {{hl2msg|long|initiator|entity id of the player who initiated the vote}} | ||
| + | {{end-hl2msg}} | ||
| + | |||
| + | === vote_changed === | ||
| + | {{begin-hl2msg|vote_changed|string}} | ||
| + | {{hl2msg|byte|yesVotes|}} | ||
| + | {{hl2msg|byte|noVotes|}} | ||
| + | {{hl2msg|byte|potentialVotes|}} | ||
| + | {{end-hl2msg}} | ||
| + | |||
| + | === vote_passed === | ||
| + | {{begin-hl2msg|vote_passed|string}} | ||
| + | {{hl2msg|string|details|}} | ||
| + | {{hl2msg|string|param1|}} | ||
| + | {{hl2msg|byte|team|}} | ||
| + | {{end-hl2msg}} | ||
| + | |||
| + | === vote_failed === | ||
| + | {{begin-hl2msg|vote_failed|string}} | ||
| + | {{hl2msg|byte|team|}} | ||
| + | {{end-hl2msg}} | ||
| + | |||
| + | === vote_cast_yes === | ||
| + | {{begin-hl2msg|vote_cast_yes|string}} | ||
| + | {{hl2msg|byte|team|}} | ||
| + | {{hl2msg|long|entityid|entity id of the voter}} | ||
| + | {{end-hl2msg}} | ||
| + | |||
| + | === vote_cast_no === | ||
| + | {{begin-hl2msg|vote_cast_no|string}} | ||
| + | {{hl2msg|byte|team|}} | ||
| + | {{hl2msg|long|entityid|entity id of the voter}} | ||
| + | {{end-hl2msg}} | ||
== Example voting plugin == | == Example voting plugin == | ||
Revision as of 09:15, 27 October 2011
Left 4 Dead has a new VGUI voting system, it's controlled by a bunch of events. You can use either a string from the resource file, or L4D_TargetID_Player which will let you create any vote you want.
Contents
How voting works
- Server sends a vote_started event
- Servers sends a vote_changed event
- Clients use the "Vote" command to register their votes ("Yes" or "No"), after which the server sends a vote_cast_yes or vote_cast_no event, followed by a vote_changed event with updated numbers.
- Server ends the vote by sending vote_ended event, followed by a vote_passed or vote_failed event.
Console Commands
Vote
Note: This command is only valid when a vote is ongoing.
| Name: | Vote | |||
| Structure: |
|
Events
Note: team is -1 when sent to all players)
vote_ended
| Name: | vote_ended | |||
| Structure: |
|
vote_started
| Name: | vote_started | ||||||||||||
| Structure: |
|
vote_changed
| Name: | vote_changed | |||||||||
| Structure: |
|
vote_passed
| Name: | vote_passed | |||||||||
| Structure: |
|
vote_failed
| Name: | vote_failed | |||
| Structure: |
|
vote_cast_yes
| Name: | vote_cast_yes | ||||||
| Structure: |
|
vote_cast_no
| Name: | vote_cast_no | ||||||
| Structure: |
|
Example voting plugin
This is a basic plugin that starts a vote, "Is gaben fat?". It does not ensure the same client does not vote multiple times, nor does it actually kick the user.
#include <sourcemod>
new yesvotes;
new novotes;
#define MAX_VOTES 4
public OnPluginStart()
{
RegConsoleCmd("testvote",Callvote_Handler);
RegConsoleCmd("Vote",vote);
}
public Action:Callvote_Handler(client, args)
{
new Handle:msg = CreateEvent("vote_started");
SetEventString(msg,"issue","#L4D_TargetID_Player");
SetEventString(msg,"param1","Is gaben fat?");
SetEventInt(msg,"team",0);
SetEventInt(msg,"initiator",0);
FireEvent(msg);
yesvotes = 0;
novotes = 0;
UpdateVotes();
return Plugin_Handled;
}
public UpdateVotes()
{
new Handle:msg = CreateEvent("vote_changed");
SetEventInt(msg,"yesVotes",yesvotes);
SetEventInt(msg,"noVotes",novotes);
SetEventInt(msg,"potentialVotes",MAX_VOTES);
FireEvent(msg);
if (yesvotes+novotes == MAX_VOTES)
{
PrintToServer("voting complete!");
msg = CreateEvent("vote_ended");
FireEvent(msg);
if (yesvotes > novotes)
{
msg = CreateEvent("vote_passed");
SetEventString(msg,"details","#L4D_TargetID_Player");
SetEventString(msg,"param1","Gaben is fat");
SetEventInt(msg,"team",0);
FireEvent(msg);
}
else
{
msg = CreateEvent("vote_failed");
SetEventInt(msg,"team",0);
FireEvent(msg);
}
}
}
public Action:vote(client, args)
{
new String:arg[8];
GetCmdArg(1,arg,8);
PrintToServer("Got vote %s from %i",arg,client);
if (strcmp(arg,"Yes",true) == 0)
{
yesvotes++;
}
else if (strcmp(arg,"No",true) == 0)
{
novotes++;
}
UpdateVotes();
return Plugin_Continue;
}
See the following images for examples what this looks like: