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-2008 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_Maps = INVALID_HANDLE;
49 new Handle:g_Cvar_Nominate = INVALID_HANDLE;
50 new Handle:g_Cvar_MinPlayers = INVALID_HANDLE;
52 new Handle:g_MapList = INVALID_HANDLE;
53 new Handle:g_RTVMapList = INVALID_HANDLE;
54 new Handle:g_MapMenu = INVALID_HANDLE;
55 new Handle:g_RetryTimer = INVALID_HANDLE;
56 new g_mapFileSerial = -1;
58 new bool:g_CanRTV = false; // True if RTV loaded maps and is active.
59 new bool:g_RTVAllowed = false; // True if RTV is available to players. Used to delay rtv votes.
60 new bool:g_RTVStarted = false; // Indicates that the actual map vote has started
61 new bool:g_RTVEnded = false; // Indicates that the actual map vote has concluded
62 new g_Voters = 0; // Total voters connected. Doesn't include fake clients.
63 new g_Votes = 0; // Total number of "say rtv" votes
64 new g_VotesNeeded = 0; // Necessary votes before map vote begins. (voters * percent_needed)
65 new bool:g_Voted[MAXPLAYERS+1] = {false, ...};
66 new bool:g_Nominated[MAXPLAYERS+1] = {false, ...};
68 public OnPluginStart()
70 LoadTranslations("common.phrases");
71 LoadTranslations("rockthevote.phrases");
73 new arraySize = ByteCountToCells(33);
74 g_MapList = CreateArray(arraySize);
75 g_RTVMapList = CreateArray(arraySize);
77 g_Cvar_Needed = CreateConVar("sm_rtv_needed", "0.60", "Percentage of players needed to rockthevote (Def 60%)", 0, true, 0.05, true, 1.0);
78 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);
79 g_Cvar_Nominate = CreateConVar("sm_rtv_nominate", "1", "Enables nomination system.", 0, true, 0.0, true, 1.0);
80 g_Cvar_MinPlayers = CreateConVar("sm_rtv_minplayers", "0", "Number of players required before RTV will be enabled.", 0, true, 0.0, true, float(MAXPLAYERS));
82 RegConsoleCmd("say", Command_Say);
83 RegConsoleCmd("say_team", Command_Say);
85 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.");
87 AutoExecConfig(true, "rtv");
102 g_RTVAllowed = false;
105 public OnConfigsExecuted()
107 if (g_RTVMapList != INVALID_HANDLE)
109 ClearArray(g_RTVMapList);
112 if (ReadMapList(g_MapList,
115 MAPLIST_FLAG_CLEARARRAY|MAPLIST_FLAG_MAPSFOLDER)
118 if (g_mapFileSerial == -1)
120 LogError("Unable to create a valid map list.");
126 CreateTimer(30.0, Timer_DelayRTV);
129 public bool:OnClientConnect(client, String:rejectmsg[], maxlen)
131 if(!g_CanRTV || IsFakeClient(client))
134 g_Voted[client] = false;
135 g_Nominated[client] = false;
138 g_VotesNeeded = RoundToFloor(float(g_Voters) * GetConVarFloat(g_Cvar_Needed));
143 public OnClientDisconnect(client)
145 if(!g_CanRTV || IsFakeClient(client))
155 g_VotesNeeded = RoundToFloor(float(g_Voters) * GetConVarFloat(g_Cvar_Needed));
157 if (g_Votes && g_Voters && g_Votes >= g_VotesNeeded && g_RTVAllowed && !g_RTVStarted)
160 CreateTimer(2.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
164 public Action:Command_Addmap(client, args)
168 ReplyToCommand(client, "[SM] Usage: sm_rtv_addmap <mapname>");
169 return Plugin_Handled;
174 ReplyToCommand(client, "[SM] RockTheVote is not available.");
175 return Plugin_Handled;
178 decl String:mapname[64];
179 GetCmdArg(1, mapname, sizeof(mapname));
181 if (FindStringInArray(g_MapList, mapname) == -1)
183 ReplyToCommand(client, "%t", "Map was not found", mapname);
184 return Plugin_Handled;
187 if (GetArraySize(g_RTVMapList) > 0)
189 if (FindStringInArray(g_RTVMapList, mapname) != -1)
191 ReplyToCommand(client, "%t", "Map Already In Vote", mapname);
192 return Plugin_Handled;
195 ShiftArrayUp(g_RTVMapList, 0);
196 SetArrayString(g_RTVMapList, 0, mapname);
198 while (GetArraySize(g_RTVMapList) > GetConVarInt(g_Cvar_Maps))
200 RemoveFromArray(g_RTVMapList, GetConVarInt(g_Cvar_Maps));
205 PushArrayString(g_RTVMapList, mapname);
208 decl String:item[64];
209 for (new i = 0; i < GetMenuItemCount(g_MapMenu); i++)
211 GetMenuItem(g_MapMenu, i, item, sizeof(item));
212 if (strcmp(item, mapname) == 0)
214 RemoveMenuItem(g_MapMenu, i);
219 ReplyToCommand(client, "%t", "Map Inserted", mapname);
220 LogAction(client, -1, "\"%L\" inserted map \"%s\".", client, mapname);
222 return Plugin_Handled;
225 public Action:Command_Say(client, args)
227 if (!g_CanRTV || !client)
229 return Plugin_Continue;
232 decl String:text[192];
233 if (!GetCmdArgString(text, sizeof(text)))
235 return Plugin_Continue;
239 if(text[strlen(text)-1] == '"')
241 text[strlen(text)-1] = '\0';
245 if (strcmp(text[startidx], "rtv", false) == 0 || strcmp(text[startidx], "rockthevote", false) == 0)
249 PrintToChat(client, "[SM] %t", "RTV Not Allowed");
250 return Plugin_Continue;
255 PrintToChat(client, "[SM] %t", "RTV Ended");
256 return Plugin_Continue;
261 PrintToChat(client, "[SM] %t", "RTV Started");
262 return Plugin_Continue;
265 if (GetClientCount(true) < GetConVarInt(g_Cvar_MinPlayers) && g_Votes == 0) // Should we keep checking g_Votes here?
267 PrintToChat(client, "[SM] %t", "Minimal Players Not Met");
268 return Plugin_Continue;
273 PrintToChat(client, "[SM] %t", "Already Voted");
274 return Plugin_Continue;
278 GetClientName(client, name, sizeof(name));
281 g_Voted[client] = true;
283 PrintToChatAll("[SM] %t", "RTV Requested", name, g_Votes, g_VotesNeeded);
285 if (g_Votes >= g_VotesNeeded)
288 CreateTimer(2.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
291 else if (GetConVarBool(g_Cvar_Nominate) && strcmp(text[startidx], "nominate", false) == 0)
295 PrintToChat(client, "[SM] %t", "RTV Ended");
296 return Plugin_Continue;
301 PrintToChat(client, "[SM] %t", "RTV Started");
302 return Plugin_Continue;
305 if (g_Nominated[client])
307 PrintToChat(client, "[SM] %t", "Already Nominated");
308 return Plugin_Continue;
311 if (GetArraySize(g_RTVMapList) >= GetConVarInt(g_Cvar_Maps))
313 PrintToChat(client, "[SM] %t", "Max Nominations");
314 return Plugin_Continue;
317 DisplayMenu(g_MapMenu, client, MENU_TIME_FOREVER);
320 return Plugin_Continue;
323 public Action:Timer_DelayRTV(Handle:timer)
326 g_RTVStarted = false;
330 public Action:Timer_StartRTV(Handle:timer)
332 if (timer == g_RetryTimer)
334 g_RetryTimer = INVALID_HANDLE;
337 if (g_RetryTimer != INVALID_HANDLE)
342 if (IsVoteInProgress())
344 // Can't start a vote, try again in 5 seconds.
345 g_RetryTimer = CreateTimer(5.0, Timer_StartRTV, TIMER_FLAG_NO_MAPCHANGE);
349 PrintToChatAll("[SM] %t", "RTV Vote Ready");
351 new Handle:MapVoteMenu = CreateMenu(Handler_MapMapVoteMenu, MenuAction:MENU_ACTIONS_ALL);
352 SetMenuTitle(MapVoteMenu, "Rock The Vote");
354 new Handle:tempMaps = CloneArray(g_MapList);
357 GetCurrentMap(map, sizeof(map));
358 new index = FindStringInArray(tempMaps, map);
361 RemoveFromArray(tempMaps, index);
364 // We assume that g_RTVMapList is within the correct limits, based on the logic for nominations
365 for (new i = 0; i < GetArraySize(g_RTVMapList); i++)
367 GetArrayString(g_RTVMapList, i, map, sizeof(map));
368 AddMenuItem(MapVoteMenu, map, map);
370 index = FindStringInArray(tempMaps, map);
373 RemoveFromArray(tempMaps, index);
377 new limit = GetConVarInt(g_Cvar_Maps) - GetArraySize(g_RTVMapList);
378 if (limit > GetArraySize(tempMaps))
380 limit = GetArraySize(tempMaps);
383 for (new i = 0; i < limit; i++)
385 new b = GetRandomInt(0, GetArraySize(tempMaps) - 1);
386 GetArrayString(tempMaps, b, map, sizeof(map));
387 PushArrayString(g_RTVMapList, map);
388 AddMenuItem(MapVoteMenu, map, map);
389 RemoveFromArray(tempMaps, b);
392 CloseHandle(tempMaps);
394 AddMenuItem(MapVoteMenu, "Don't Change", "Don't Change");
396 SetMenuExitButton(MapVoteMenu, false);
397 VoteMenuToAll(MapVoteMenu, 20);
399 LogMessage("[SM] Rockthevote was successfully started.");
402 public Action:Timer_ChangeMap(Handle:hTimer, Handle:dp)
407 ReadPackString(dp, map, sizeof(map));
409 ServerCommand("changelevel \"%s\"", map);
414 public Handler_MapMapVoteMenu(Handle:menu, MenuAction:action, param1, param2)
423 case MenuAction_Display:
425 decl String:oldTitle[255], String:buffer[255];
426 GetMenuTitle(menu, oldTitle, sizeof(oldTitle));
427 Format(buffer, sizeof(buffer), "%T", oldTitle, param1);
429 new Handle:panel = Handle:param2;
430 SetPanelTitle(panel, buffer);
433 case MenuAction_DisplayItem:
435 if (GetMenuItemCount(menu) - 1 == param2)
437 decl String:buffer[255];
438 Format(buffer, sizeof(buffer), "%T", "Don't Change", param1);
439 return RedrawMenuItem(buffer);
443 // Why am I commented out? Because BAIL hasn't decided yet if
444 // vote notification will be built into the Vote API.
445 /*case MenuAction_Select:
447 decl String:Name[32], String:Map[32];
448 GetClientName(param1, Name, sizeof(Name));
449 GetMenuItem(menu, param2, Map, sizeof(Map));
451 PrintToChatAll("[SM] %s has voted for map '%s'", Name, Map);
454 case MenuAction_VoteCancel:
456 if (param1 == VoteCancel_NoVotes)
458 PrintToChatAll("[SM] %t", "No Votes");
463 case MenuAction_VoteEnd:
467 GetMenuItem(menu, param1, map, sizeof(map));
469 if (GetMenuItemCount(menu) - 1 == param1) // This should always match the "Keep Current" option
471 PrintToChatAll("[SM] %t", "Current Map Stays");
472 LogMessage("[SM] Rockthevote has ended, current map kept.");
476 PrintToChatAll("[SM] %t", "Changing Maps", map);
477 LogMessage("[SM] Rockthevote has ended, changing to map %s.", map);
479 CreateDataTimer(5.0, Timer_ChangeMap, dp);
480 WritePackString(dp, map);
490 public Handler_MapSelectMenu(Handle:menu, MenuAction:action, param1, param2)
494 case MenuAction_Select:
496 if (GetArraySize(g_RTVMapList) >= GetConVarInt(g_Cvar_Maps))
498 PrintToChat(param1, "[SM] %t", "Max Nominations");
502 decl String:map[64], String:name[64];
503 GetMenuItem(menu, param2, map, sizeof(map));
505 if (FindStringInArray(g_RTVMapList, map) != -1)
507 PrintToChat(param1, "[SM] %t", "Map Already Nominated");
511 GetClientName(param1, name, 64);
513 PushArrayString(g_RTVMapList, map);
514 RemoveMenuItem(menu, param2);
516 g_Nominated[param1] = true;
518 PrintToChatAll("[SM] %t", "Map Nominated", name, map);
525 if (g_MapMenu != INVALID_HANDLE)
527 CloseHandle(g_MapMenu);
528 g_MapMenu = INVALID_HANDLE;
531 g_MapMenu = CreateMenu(Handler_MapSelectMenu);
532 SetMenuTitle(g_MapMenu, "%t", "Nominate Title");
535 for (new i = 0; i < GetArraySize(g_MapList); i++)
537 GetArrayString(g_MapList, i, map, sizeof(map));
538 AddMenuItem(g_MapMenu, map, map);
541 SetMenuExitButton(g_MapMenu, false);