3 * =============================================================================
4 * SourceMod Rock The Vote Plugin
5 * Creates a map vote when the required number of players have requested one.
7 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
8 * =============================================================================
10 * This program is free software; you can redistribute it and/or modify it under
11 * the terms of the GNU General Public License, version 3.0, as published by the
12 * Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License along with
20 * this program. If not, see <http://www.gnu.org/licenses/>.
22 * As a special exception, AlliedModders LLC gives you permission to link the
23 * code of this program (as well as its derivative works) to "Half-Life 2," the
24 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
25 * by the Valve Corporation. You must obey the GNU General Public License in
26 * all respects for all other code used. Additionally, AlliedModders LLC grants
27 * this exception to all derivative works. AlliedModders LLC defines further
28 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
29 * or <http://www.sourcemod.net/license.php>.
38 public Plugin:myinfo =
40 name = "Rock The Vote",
41 author = "AlliedModders LLC",
42 description = "Provides RTV Map Voting",
43 version = SOURCEMOD_VERSION,
44 url = "http://www.sourcemod.net/"
47 new Handle:g_Cvar_Needed = INVALID_HANDLE;
48 new Handle:g_Cvar_File = INVALID_HANDLE;
49 new Handle:g_Cvar_Maps = INVALID_HANDLE;
50 new Handle:g_Cvar_Nominate = INVALID_HANDLE;
51 new Handle:g_Cvar_MinPlayers = INVALID_HANDLE;
53 new Handle:g_MapList = INVALID_HANDLE;
54 new Handle:g_RTVMapList = INVALID_HANDLE;
55 new Handle:g_MapMenu = INVALID_HANDLE;
56 new Handle:g_RetryTimer = INVALID_HANDLE;
59 new bool:g_CanRTV = false; // True if RTV loaded maps and is active.
60 new bool:g_RTVAllowed = false; // True if RTV is available to players. Used to delay rtv votes.
61 new bool:g_RTVStarted = false; // Indicates that the actual map vote has started
62 new bool:g_RTVEnded = false; // Indicates that the actual map vote has concluded
63 new g_Voters = 0; // Total voters connected. Doesn't include fake clients.
64 new g_Votes = 0; // Total number of "say rtv" votes
65 new g_VotesNeeded = 0; // Necessary votes before map vote begins. (voters * percent_needed)
66 new bool:g_Voted[MAXPLAYERS+1] = {false, ...};
67 new bool:g_Nominated[MAXPLAYERS+1] = {false, ...};
69 public OnPluginStart()
71 LoadTranslations("common.phrases");
72 LoadTranslations("rockthevote.phrases");
74 new arraySize = ByteCountToCells(33);
75 g_MapList = CreateArray(arraySize);
76 g_RTVMapList = CreateArray(arraySize);
78 g_Cvar_Needed = CreateConVar("sm_rtv_needed", "0.60", "Percentage of players needed to rockthevote (Def 60%)", 0, true, 0.05, true, 1.0);
79 g_Cvar_File = CreateConVar("sm_rtv_file", "configs/maps.ini", "Map file to use. (Def configs/maps.ini)");
80 g_Cvar_Maps = CreateConVar("sm_rtv_maps", "4", "Number of maps to be voted on. 2 to 6. (Def 4)", 0, true, 2.0, true, 6.0);
81 g_Cvar_Nominate = CreateConVar("sm_rtv_nominate", "1", "Enables nomination system.", 0, true, 0.0, true, 1.0);
82 g_Cvar_MinPlayers = CreateConVar("sm_rtv_minplayers", "0", "Number of players required before RTV will be enabled.", 0, true, 0.0, true, float(MAXPLAYERS));
84 RegConsoleCmd("say", Command_Say);
85 RegConsoleCmd("say_team", Command_Say);
87 RegAdminCmd("sm_rtv_addmap", Command_Addmap, ADMFLAG_CHANGEMAP, "sm_rtv_addmap <mapname> - Forces a map to be on the RTV, and lowers the allowed nominations.");
89 AutoExecConfig(true, "rtv");
104 g_RTVAllowed = false;
107 public OnConfigsExecuted()
109 if (g_RTVMapList != INVALID_HANDLE)
111 ClearArray(g_RTVMapList);
114 if (LoadMaps(g_MapList, g_mapFileTime, g_Cvar_File))
118 CreateTimer(30.0, Timer_DelayRTV);
122 public bool:OnClientConnect(client, String:rejectmsg[], maxlen)
124 if(!g_CanRTV || IsFakeClient(client))
127 g_Voted[client] = false;
128 g_Nominated[client] = false;
131 g_VotesNeeded = RoundToFloor(float(g_Voters) * GetConVarFloat(g_Cvar_Needed));
136 public OnClientDisconnect(client)
138 if(!g_CanRTV || IsFakeClient(client))
148 g_VotesNeeded = RoundToFloor(float(g_Voters) * GetConVarFloat(g_Cvar_Needed));
150 if (g_Votes && g_Voters && g_Votes >= g_VotesNeeded && g_RTVAllowed && !g_RTVStarted)
153 CreateTimer(2.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
157 public Action:Command_Addmap(client, args)
161 ReplyToCommand(client, "[SM] Usage: sm_rtv_addmap <mapname>");
162 return Plugin_Handled;
167 ReplyToCommand(client, "[SM] RockTheVote is not available.");
168 return Plugin_Handled;
171 decl String:mapname[64];
172 GetCmdArg(1, mapname, sizeof(mapname));
174 if (FindStringInArray(g_MapList, mapname) == -1)
176 ReplyToCommand(client, "%t", "Map was not found", mapname);
177 return Plugin_Handled;
180 if (GetArraySize(g_RTVMapList) > 0)
182 if (FindStringInArray(g_RTVMapList, mapname) != -1)
184 ReplyToCommand(client, "%t", "Map Already In Vote", mapname);
185 return Plugin_Handled;
188 ShiftArrayUp(g_RTVMapList, 0);
189 SetArrayString(g_RTVMapList, 0, mapname);
191 while (GetArraySize(g_RTVMapList) > GetConVarInt(g_Cvar_Maps))
193 RemoveFromArray(g_RTVMapList, GetConVarInt(g_Cvar_Maps));
198 PushArrayString(g_RTVMapList, mapname);
201 decl String:item[64];
202 for (new i = 0; i < GetMenuItemCount(g_MapMenu); i++)
204 GetMenuItem(g_MapMenu, i, item, sizeof(item));
205 if (strcmp(item, mapname) == 0)
207 RemoveMenuItem(g_MapMenu, i);
212 ReplyToCommand(client, "%t", "Map Inserted", mapname);
213 LogAction(client, -1, "\"%L\" inserted map \"%s\".", client, mapname);
215 return Plugin_Handled;
218 public Action:Command_Say(client, args)
220 if (!g_CanRTV || !client)
222 return Plugin_Continue;
225 decl String:text[192];
226 if (!GetCmdArgString(text, sizeof(text)))
228 return Plugin_Continue;
232 if(text[strlen(text)-1] == '"')
234 text[strlen(text)-1] = '\0';
238 if (strcmp(text[startidx], "rtv", false) == 0 || strcmp(text[startidx], "rockthevote", false) == 0)
242 PrintToChat(client, "[SM] %t", "RTV Not Allowed");
243 return Plugin_Continue;
248 PrintToChat(client, "[SM] %t", "RTV Ended");
249 return Plugin_Continue;
254 PrintToChat(client, "[SM] %t", "RTV Started");
255 return Plugin_Continue;
258 if (GetClientCount(true) < GetConVarInt(g_Cvar_MinPlayers) && g_Votes == 0) // Should we keep checking g_Votes here?
260 PrintToChat(client, "[SM] %t", "Minimal Players Not Met");
261 return Plugin_Continue;
266 PrintToChat(client, "[SM] %t", "Already Voted");
267 return Plugin_Continue;
271 GetClientName(client, name, sizeof(name));
274 g_Voted[client] = true;
276 PrintToChatAll("[SM] %t", "RTV Requested", name, g_Votes, g_VotesNeeded);
278 if (g_Votes >= g_VotesNeeded)
281 CreateTimer(2.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
284 else if (GetConVarBool(g_Cvar_Nominate) && strcmp(text[startidx], "nominate", false) == 0)
288 PrintToChat(client, "[SM] %t", "RTV Ended");
289 return Plugin_Continue;
294 PrintToChat(client, "[SM] %t", "RTV Started");
295 return Plugin_Continue;
298 if (g_Nominated[client])
300 PrintToChat(client, "[SM] %t", "Already Nominated");
301 return Plugin_Continue;
304 if (GetArraySize(g_RTVMapList) >= GetConVarInt(g_Cvar_Maps))
306 PrintToChat(client, "[SM] %t", "Max Nominations");
307 return Plugin_Continue;
310 DisplayMenu(g_MapMenu, client, MENU_TIME_FOREVER);
313 return Plugin_Continue;
316 public Action:Timer_DelayRTV(Handle:timer)
321 public Action:Timer_StartRTV(Handle:timer)
323 if (timer == g_RetryTimer)
325 g_RetryTimer = INVALID_HANDLE;
328 if (g_RetryTimer != INVALID_HANDLE)
333 if (IsVoteInProgress())
335 // Can't start a vote, try again in 5 seconds.
336 g_RetryTimer = CreateTimer(5.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
340 PrintToChatAll("[SM] %t", "RTV Vote Ready");
342 new Handle:MapVoteMenu = CreateMenu(Handler_MapMapVoteMenu, MenuAction:MENU_ACTIONS_ALL);
343 SetMenuTitle(MapVoteMenu, "Rock The Vote");
345 new Handle:tempMaps = CloneArray(g_MapList);
348 GetCurrentMap(map, sizeof(map));
349 new index = FindStringInArray(tempMaps, map);
352 RemoveFromArray(tempMaps, index);
355 // We assume that g_RTVMapList is within the correct limits, based on the logic for nominations
356 for (new i = 0; i < GetArraySize(g_RTVMapList); i++)
358 GetArrayString(g_RTVMapList, i, map, sizeof(map));
359 AddMenuItem(MapVoteMenu, map, map);
361 index = FindStringInArray(tempMaps, map);
364 RemoveFromArray(tempMaps, index);
368 new limit = GetConVarInt(g_Cvar_Maps) - GetArraySize(g_RTVMapList);
369 if (limit > GetArraySize(tempMaps))
371 limit = GetArraySize(tempMaps);
374 for (new i = 0; i < limit; i++)
376 new b = GetRandomInt(0, GetArraySize(tempMaps) - 1);
377 GetArrayString(tempMaps, b, map, sizeof(map));
378 PushArrayString(g_RTVMapList, map);
379 AddMenuItem(MapVoteMenu, map, map);
380 RemoveFromArray(tempMaps, b);
383 CloseHandle(tempMaps);
385 AddMenuItem(MapVoteMenu, "Don't Change", "Don't Change");
387 SetMenuExitButton(MapVoteMenu, false);
388 VoteMenuToAll(MapVoteMenu, 20);
390 LogMessage("[SM] Rockthevote was successfully started.");
393 public Action:Timer_ChangeMap(Handle:hTimer, Handle:dp)
398 ReadPackString(dp, map, sizeof(map));
400 ServerCommand("changelevel \"%s\"", map);
405 public Handler_MapMapVoteMenu(Handle:menu, MenuAction:action, param1, param2)
414 case MenuAction_Display:
416 decl String:oldTitle[255], String:buffer[255];
417 GetMenuTitle(menu, oldTitle, sizeof(oldTitle));
418 Format(buffer, sizeof(buffer), "%T", oldTitle, param1);
420 new Handle:panel = Handle:param2;
421 SetPanelTitle(panel, buffer);
424 case MenuAction_DisplayItem:
426 if (GetMenuItemCount(menu) - 1 == param2)
428 decl String:buffer[255];
429 Format(buffer, sizeof(buffer), "%T", "Don't Change", param1);
430 return RedrawMenuItem(buffer);
434 // Why am I commented out? Because BAIL hasn't decided yet if
435 // vote notification will be built into the Vote API.
436 /*case MenuAction_Select:
438 decl String:Name[32], String:Map[32];
439 GetClientName(param1, Name, sizeof(Name));
440 GetMenuItem(menu, param2, Map, sizeof(Map));
442 PrintToChatAll("[SM] %s has voted for map '%s'", Name, Map);
445 case MenuAction_VoteCancel:
447 if (param1 == VoteCancel_NoVotes)
449 PrintToChatAll("[SM] %t", "No Votes");
454 case MenuAction_VoteEnd:
458 GetMenuItem(menu, param1, map, sizeof(map));
460 if (GetMenuItemCount(menu) - 1 == param1) // This should always match the "Keep Current" option
462 PrintToChatAll("[SM] %t", "Current Map Stays");
463 LogMessage("[SM] Rockthevote has ended, current map kept.");
467 PrintToChatAll("[SM] %t", "Changing Maps", map);
468 LogMessage("[SM] Rockthevote has ended, changing to map %s.", map);
470 CreateDataTimer(5.0, Timer_ChangeMap, dp);
471 WritePackString(dp, map);
481 public Handler_MapSelectMenu(Handle:menu, MenuAction:action, param1, param2)
485 case MenuAction_Select:
487 if (GetArraySize(g_RTVMapList) >= GetConVarInt(g_Cvar_Maps))
489 PrintToChat(param1, "[SM] %t", "Max Nominations");
493 decl String:map[64], String:name[64];
494 GetMenuItem(menu, param2, map, sizeof(map));
496 if (FindStringInArray(g_RTVMapList, map) != -1)
498 PrintToChat(param1, "[SM] %t", "Map Already Nominated");
502 GetClientName(param1, name, 64);
504 PushArrayString(g_RTVMapList, map);
505 RemoveMenuItem(menu, param2);
507 g_Nominated[param1] = true;
509 PrintToChatAll("[SM] %t", "Map Nominated", name, map);
516 if (g_MapMenu != INVALID_HANDLE)
518 CloseHandle(g_MapMenu);
519 g_MapMenu = INVALID_HANDLE;
522 g_MapMenu = CreateMenu(Handler_MapSelectMenu);
523 SetMenuTitle(g_MapMenu, "%t", "Nominate Title");
526 for (new i = 0; i < GetArraySize(g_MapList); i++)
528 GetArrayString(g_MapList, i, map, sizeof(map));
529 AddMenuItem(g_MapMenu, map, map);
532 SetMenuExitButton(g_MapMenu, false);