2 #include <common/command/_mod.qh>
7 #include "../g_damage.qh"
8 #include "../g_world.qh"
10 #include "../round_handler.qh"
11 #include "../scores.qh"
13 #include "../mutators/_mod.qh"
15 #include <common/constants.qh>
16 #include <common/mapinfo.qh>
17 #include <common/notifications/all.qh>
18 #include <common/playerstats.qh>
19 #include <common/util.qh>
21 // =============================================
22 // Server side voting code, reworked by Samual
23 // Last updated: December 27th, 2011
24 // =============================================
26 // Nagger for players to know status of voting
27 bool Nagger_SendEntity(entity this, entity to, float sendflags)
31 WriteHeader(MSG_ENTITY, ENT_CLIENT_NAGGER);
35 // 2 = player needs to ready up
37 // 8 = player needs to vote
47 if (to.ready == 0) nags |= BIT(1);
52 if (to.vote_selection == 0) nags |= BIT(3);
54 if (warmup_stage) nags |= BIT(4);
56 if (sendflags & BIT(6)) nags |= BIT(6);
58 if (sendflags & BIT(7)) nags |= BIT(7);
60 if (!(nags & 4)) // no vote called? send no string
61 nags &= ~(BIT(6) | BIT(7));
63 WriteByte(MSG_ENTITY, nags);
67 WriteByte(MSG_ENTITY, vote_accept_count);
68 WriteByte(MSG_ENTITY, vote_reject_count);
69 WriteByte(MSG_ENTITY, vote_needed_overall);
70 WriteChar(MSG_ENTITY, to.vote_selection);
73 if (nags & BIT(7)) WriteString(MSG_ENTITY, vote_called_display);
77 for (i = 1; i <= maxclients; i += 8)
79 for (f = 0, e = edict_num(i), b = 1; b < 256; b *= 2, e = nextent(e))
80 if (!IS_REAL_CLIENT(e) || e.ready) f |= b;
81 WriteByte(MSG_ENTITY, f);
90 Net_LinkEntity(nagger = new_pure(nagger), false, 0, Nagger_SendEntity);
93 void Nagger_VoteChanged()
95 if (nagger) nagger.SendFlags |= BIT(7);
98 void Nagger_VoteCountChanged()
100 if (nagger) nagger.SendFlags |= BIT(6);
103 void Nagger_ReadyCounted()
105 if (nagger) nagger.SendFlags |= BIT(0);
108 // If the vote_caller is still here, return their name, otherwise vote_caller_name
109 string OriginalCallerName()
111 if (IS_REAL_CLIENT(vote_caller)) return vote_caller.netname;
112 return vote_caller_name;
115 // =======================
116 // Game logic for voting
117 // =======================
121 FOREACH_CLIENT(true, LAMBDA(it.vote_selection = 0));
125 strunzone(vote_called_command);
126 strunzone(vote_called_display);
127 strunzone(vote_caller_name);
130 vote_called = VOTE_NULL;
132 vote_caller_name = string_null;
135 vote_called_command = string_null;
136 vote_called_display = string_null;
138 vote_parsed_command = string_null;
139 vote_parsed_display = string_null;
141 Nagger_VoteChanged();
144 void VoteStop(entity stopper)
146 bprint("\{1}^2* ^3", GetCallerName(stopper), "^2 stopped ^3", OriginalCallerName(), "^2's vote\n");
147 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vstop:", ftos(stopper.playerid)));
148 // Don't force them to wait for next vote, this way they can e.g. correct their vote.
149 if ((vote_caller) && (stopper == vote_caller)) vote_caller.vote_waittime = time + autocvar_sv_vote_stop;
155 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ^1", vote_called_display, "^2 was accepted\n");
157 if ((vote_called == VOTE_MASTER) && vote_caller) vote_caller.vote_master = 1;
158 else localcmd(strcat(vote_called_command, "\n"));
160 if (vote_caller) vote_caller.vote_waittime = 0; // people like your votes, you don't need to wait to vote again
163 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_ACCEPT);
168 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 was rejected\n");
170 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_FAIL);
175 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 timed out\n");
177 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_FAIL);
180 void VoteSpam(float notvoters, float mincount, string result)
183 strcat("\{1}^2* vote results: ^1", ftos(vote_accept_count)),
184 strcat("^2:^1", ftos(vote_reject_count)),
185 ((mincount >= 0) ? strcat("^2 (^1", ftos(mincount), "^2 needed)") : "^2"),
186 strcat(", ^1", ftos(vote_abstain_count), "^2 didn't care"),
187 strcat(", ^1", ftos(notvoters), strcat("^2 didn't ", ((mincount >= 0) ? "" : "have to "), "vote\n"))));
189 if (autocvar_sv_eventlog)
192 strcat(":vote:v", result, ":", ftos(vote_accept_count)),
193 strcat(":", ftos(vote_reject_count)),
194 strcat(":", ftos(vote_abstain_count)),
195 strcat(":", ftos(notvoters)),
196 strcat(":", ftos(mincount))));
200 void VoteCount(float first_count)
203 vote_accept_count = vote_reject_count = vote_abstain_count = 0;
205 bool spectators_allowed = (!autocvar_sv_vote_nospectators || (autocvar_sv_vote_nospectators == 1 && (warmup_stage || gameover)));
207 float vote_player_count = 0, notvoters = 0;
208 float vote_real_player_count = 0, vote_real_accept_count = 0;
209 float vote_real_reject_count = 0, vote_real_abstain_count = 0;
210 float vote_needed_of_voted, final_needed_votes;
211 float vote_factor_overall, vote_factor_of_voted;
213 Nagger_VoteCountChanged();
215 // add up all the votes from each connected client
216 FOREACH_CLIENT(IS_REAL_CLIENT(it) && IS_CLIENT(it), LAMBDA(
218 if (IS_PLAYER(it)) ++vote_real_player_count;
219 switch (it.vote_selection)
221 case VOTE_SELECT_REJECT:
222 { ++vote_reject_count;
223 { if (IS_PLAYER(it)) ++vote_real_reject_count; } break;
225 case VOTE_SELECT_ACCEPT:
226 { ++vote_accept_count;
227 { if (IS_PLAYER(it)) ++vote_real_accept_count; } break;
229 case VOTE_SELECT_ABSTAIN:
230 { ++vote_abstain_count;
231 { if (IS_PLAYER(it)) ++vote_real_abstain_count; } break;
237 // Check to see if there are enough players on the server to allow master voting... otherwise, vote master could be used for evil.
238 if ((vote_called == VOTE_MASTER) && autocvar_sv_vote_master_playerlimit > vote_player_count)
240 if (vote_caller) vote_caller.vote_waittime = 0;
241 print_to(vote_caller, "^1There are not enough players on this server to allow you to become vote master.");
246 // if spectators aren't allowed to vote and there are players in a match, then only count the players in the vote and ignore spectators.
247 if (!spectators_allowed && (vote_real_player_count > 0))
249 vote_accept_count = vote_real_accept_count;
250 vote_reject_count = vote_real_reject_count;
251 vote_abstain_count = vote_real_abstain_count;
252 vote_player_count = vote_real_player_count;
255 // people who have no opinion in any way :D
256 notvoters = (vote_player_count - vote_accept_count - vote_reject_count - vote_abstain_count);
258 // determine the goal for the vote to be passed or rejected normally
259 vote_factor_overall = bound(0.5, autocvar_sv_vote_majority_factor, 0.999);
260 vote_needed_overall = floor((vote_player_count - vote_abstain_count) * vote_factor_overall) + 1;
262 // if the vote times out, determine the amount of votes needed of the people who actually already voted
263 vote_factor_of_voted = bound(0.5, autocvar_sv_vote_majority_factor_of_voted, 0.999);
264 vote_needed_of_voted = floor((vote_accept_count + vote_reject_count) * vote_factor_of_voted) + 1;
266 // are there any players at all on the server? it could be an admin vote
267 if (vote_player_count == 0 && first_count)
269 VoteSpam(0, -1, "yes"); // no players at all, just accept it
274 // since there ARE players, finally calculate the result of the vote
275 if (vote_accept_count >= vote_needed_overall)
277 VoteSpam(notvoters, -1, "yes"); // there is enough acceptions to pass the vote
282 if (vote_reject_count > vote_player_count - vote_abstain_count - vote_needed_overall)
284 VoteSpam(notvoters, -1, "no"); // there is enough rejections to deny the vote
289 // there is not enough votes in either direction, now lets just calculate what the voters have said
290 if (time > vote_endtime)
292 final_needed_votes = vote_needed_overall;
294 if (autocvar_sv_vote_majority_factor_of_voted)
296 if (vote_accept_count >= vote_needed_of_voted)
298 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "yes");
303 if (vote_accept_count + vote_reject_count > 0)
305 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "no");
310 final_needed_votes = min(vote_needed_overall, vote_needed_of_voted);
313 // it didn't pass or fail, so not enough votes to even make a decision.
314 VoteSpam(notvoters, final_needed_votes, "timeout");
321 if (vote_endtime > 0) // a vote was called
323 if (time > vote_endtime) // time is up
329 // =======================
330 // Game logic for warmup
331 // =======================
333 // Resets the state of all clients, items, weapons, waypoints, ... of the map.
334 void reset_map(bool dorespawn)
336 if (time <= game_starttime && round_handler_IsActive()) round_handler_Reset(game_starttime);
338 MUTATOR_CALLHOOK(reset_map_global);
340 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), {
346 if (it.team_saved) it.team = it.team_saved;
347 if (it.flags & FL_PROJECTILE) delete(it); // remove any projectiles left
350 // Waypoints and assault start come LAST
351 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), {
352 if (it.reset2) it.reset2(it);
355 FOREACH_CLIENT(IS_PLAYER(it) && STAT(FROZEN, it), LAMBDA(Unfreeze(it)));
357 // Moving the player reset code here since the player-reset depends
358 // on spawnpoint entities which have to be reset first --blub
361 if (!MUTATOR_CALLHOOK(reset_map_players))
363 FOREACH_CLIENT(true, LAMBDA(
365 only reset players if a restart countdown is active
366 this can either be due to cvar sv_ready_restart_after_countdown having set
367 restart_mapalreadyrestarted to 1 after the countdown ended or when
368 sv_ready_restart_after_countdown is not used and countdown is still running
370 if (restart_mapalreadyrestarted || (time < game_starttime))
372 // NEW: changed behaviour so that it prevents that previous spectators/observers suddenly spawn as players
375 // PlayerScore_Clear(it);
377 // stop the player from moving so that he stands still once he gets respawned
378 it.velocity = '0 0 0';
379 it.avelocity = '0 0 0';
380 it.movement = '0 0 0';
381 PutClientInServer(it);
389 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
390 void ReadyRestart_think(entity this)
392 restart_mapalreadyrestarted = true;
398 // Forces a restart of the game without actually reloading the map // this is a mess...
399 void ReadyRestart_force()
401 bprint("^1Server is restarting...\n");
405 // clear overtime, we have to decrease timelimit to its original value again.
406 if (checkrules_overtimesadded > 0 && g_race_qualifying != 2)
407 cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime)));
408 checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = 0;
410 readyrestart_happened = true;
411 game_starttime = time + RESTART_COUNTDOWN;
413 // clear player attributes
414 FOREACH_CLIENT(true, LAMBDA(
417 PS_GR_P_ADDVAL(it, PLAYERSTATS_ALIVETIME, -PS_GR_P_ADDVAL(it, PLAYERSTATS_ALIVETIME, 0));
420 restart_mapalreadyrestarted = false; // reset this var, needed when cvar sv_ready_restart_repeatable is in use
422 // disable the warmup global for the server
423 warmup_stage = 0; // once the game is restarted the game is in match stage
425 // reset the .ready status of all players (also spectators)
426 FOREACH_CLIENT(IS_REAL_CLIENT(it), LAMBDA(it.ready = false));
428 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
430 // lock teams with lockonrestart
431 if (autocvar_teamplay_lockonrestart && teamplay)
434 bprint("^1The teams are now locked.\n");
437 // initiate the restart-countdown-announcer entity
438 if (autocvar_sv_ready_restart_after_countdown)
440 entity restart_timer = new_pure(restart_timer);
441 setthink(restart_timer, ReadyRestart_think);
442 restart_timer.nextthink = game_starttime;
445 // after a restart every players number of allowed timeouts gets reset, too
446 if (autocvar_sv_timeout)
448 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), LAMBDA(it.allowed_timeouts = autocvar_sv_timeout_number));
450 // reset map immediately if this cvar is not set
451 if (!autocvar_sv_ready_restart_after_countdown) reset_map(true);
452 if (autocvar_sv_eventlog) GameLogEcho(":restart");
457 // no assault support yet...
458 if (g_assault | gameover | intermission_running | race_completing) localcmd("restart\n");
459 else localcmd("\nsv_hook_gamerestart\n");
461 // Reset ALL scores, but only do that at the beginning of the countdown if sv_ready_restart_after_countdown is off!
462 // Otherwise scores could be manipulated during the countdown.
463 if (!autocvar_sv_ready_restart_after_countdown) Score_ClearAll();
464 ReadyRestart_force();
467 // Count the players who are ready and determine whether or not to restart the match
470 float ready_needed_factor, ready_needed_count;
471 float t_ready = 0, t_players = 0;
473 FOREACH_CLIENT(IS_REAL_CLIENT(it) && (IS_PLAYER(it) || it.caplayer == 1), LAMBDA(
475 if (it.ready) ++t_ready;
478 readycount = t_ready;
480 Nagger_ReadyCounted();
482 ready_needed_factor = bound(0.5, cvar("g_warmup_majority_factor"), 0.999);
483 ready_needed_count = floor(t_players * ready_needed_factor) + 1;
485 if (readycount >= ready_needed_count) ReadyRestart();
489 // ======================================
490 // Supporting functions for VoteCommand
491 // ======================================
493 float Votecommand_check_assignment(entity caller, float assignment)
495 float from_server = (!caller);
497 if ((assignment == VC_ASGNMNT_BOTH)
498 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
499 || (from_server && assignment == VC_ASGNMNT_SERVERONLY))) return true;
504 string VoteCommand_extractcommand(string input, float startpos, float argc)
508 if ((argc - 1) < startpos) output = "";
509 else output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
514 float VoteCommand_checknasty(string vote_command)
516 if ((strstrofs(vote_command, ";", 0) >= 0)
517 || (strstrofs(vote_command, "\n", 0) >= 0)
518 || (strstrofs(vote_command, "\r", 0) >= 0)
519 || (strstrofs(vote_command, "$", 0) >= 0)) return false;
524 float VoteCommand_checkinlist(string vote_command, string list)
526 string l = strcat(" ", list, " ");
528 if (strstrofs(l, strcat(" ", vote_command, " "), 0) >= 0) return true;
533 string ValidateMap(string validated_map, entity caller)
535 validated_map = MapInfo_FixName(validated_map);
539 print_to(caller, "This map is not available on this server.");
543 if (!autocvar_sv_vote_override_mostrecent && caller)
545 if (Map_IsRecent(validated_map))
547 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
552 if (!MapInfo_CheckMap(validated_map))
554 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
558 return validated_map;
561 float VoteCommand_checkargs(float startpos, float argc)
563 float p, q, check, minargs;
564 string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
565 string cmdrestriction = ""; // No we don't.
566 string charlist, arg;
569 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
570 cmdrestriction = cvar_string(cvarname);
572 LOG_INFO("NOTE: ", cvarname, " does not exist, no restrictions will be applied.\n");
574 if (cmdrestriction == "") return true;
576 ++startpos; // skip command name
578 // check minimum arg count
580 // 0 args: argc == startpos
581 // 1 args: argc == startpos + 1
584 minargs = stof(cmdrestriction);
585 if (argc - startpos < minargs) return false;
587 p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
591 // we know that at any time, startpos <= argc - minargs
592 // so this means: argc-minargs >= startpos >= argc, thus
593 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
594 // have been seen already
596 if (startpos >= argc) // all args checked? GOOD
599 if (p < 0) // no more args? FAIL
601 // exception: exactly minargs left, this one included
602 if (argc - startpos == minargs) break;
608 // cut to next semicolon
609 q = strstrofs(cmdrestriction, ";", p + 1); // find next semicolon
610 if (q < 0) charlist = substring(cmdrestriction, p + 1, -1);
611 else charlist = substring(cmdrestriction, p + 1, q - (p + 1));
613 // in case we ever want to allow semicolons in VoteCommand_checknasty
614 // charlist = strreplace("^^", ";", charlist);
618 // verify the arg only contains allowed chars
619 arg = argv(startpos);
620 checkmate = strlen(arg);
621 for (check = 0; check < checkmate; ++check)
622 if (strstrofs(charlist, substring(arg, check, 1), 0) < 0) return false;
623 // not allowed character
624 // all characters are allowed. FINE.
635 float VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, float argc)
637 string first_command;
639 first_command = argv(startpos);
641 /*printf("VoteCommand_parse(): Command: '%s', Length: %f.\n",
642 substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos)),
643 strlen(substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos)))
647 (autocvar_sv_vote_limit > 0)
649 (strlen(substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos))) > autocvar_sv_vote_limit)
652 if (!VoteCommand_checkinlist(first_command, vote_list)) return false;
654 if (!VoteCommand_checkargs(startpos, argc)) return false;
656 switch (first_command) // now go through and parse the proper commands to adjust as needed.
659 case "kickban": // catch all kick/kickban commands
661 entity victim = GetIndexedEntity(argc, (startpos + 1));
662 float accepted = VerifyClientEntity(victim, true, false);
666 string reason = ((argc > next_token) ? substring(vote_command, argv_start_index(next_token), strlen(vote_command) - argv_start_index(next_token)) : "No reason provided");
667 string command_arguments;
669 if (first_command == "kickban") command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
670 else command_arguments = reason;
672 vote_parsed_command = strcat(first_command, " # ", ftos(etof(victim)), " ", command_arguments);
673 vote_parsed_display = strcat("^1", vote_command, " (^7", victim.netname, "^1): ", reason);
675 else { print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n")); return false; }
682 case "gotomap": // re-direct all map selection commands to gotomap
684 vote_command = ValidateMap(argv(startpos + 1), caller);
685 if (!vote_command) return false;
686 vote_parsed_command = strcat("gotomap ", vote_command);
687 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
694 vote_parsed_command = vote_command;
695 vote_parsed_display = strzone(strcat("^1", vote_command));
705 // =======================
706 // Command Sub-Functions
707 // =======================
709 void VoteCommand_abstain(float request, entity caller) // CLIENT ONLY
713 case CMD_REQUEST_COMMAND:
715 if (!vote_called) { print_to(caller, "^1No vote called."); }
716 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
718 print_to(caller, "^1You have already voted.");
721 else // everything went okay, continue changing vote
723 print_to(caller, "^1You abstained from your vote.");
724 caller.vote_selection = VOTE_SELECT_ABSTAIN;
726 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
732 case CMD_REQUEST_USAGE:
734 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
735 print_to(caller, " No arguments required.");
741 void VoteCommand_call(float request, entity caller, float argc, string vote_command) // BOTH
745 case CMD_REQUEST_COMMAND:
747 bool spectators_allowed = (!autocvar_sv_vote_nospectators || (autocvar_sv_vote_nospectators == 1 && (warmup_stage || gameover)));
749 float tmp_playercount = 0;
751 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
753 if (!autocvar_sv_vote_call && caller) { print_to(caller, "^1Vote calling is not allowed."); }
754 else if (!autocvar_sv_vote_gamestart && time < game_starttime)
756 print_to(caller, "^1Vote calling is not allowed before the match has started.");
758 else if (vote_called)
760 print_to(caller, "^1There is already a vote called.");
762 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
764 print_to(caller, "^1Only players can call a vote.");
766 else if (caller && !IS_CLIENT(caller))
768 print_to(caller, "^1Only connected clients can vote.");
770 else if (timeout_status)
772 print_to(caller, "^1You can not call a vote while a timeout is active.");
774 else if (caller && (time < caller.vote_waittime))
776 print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote."));
778 else if (!VoteCommand_checknasty(vote_command))
780 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
782 else if (!VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc))
784 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
787 else // everything went okay, continue with calling the vote
789 vote_caller = caller; // remember who called the vote
790 vote_caller_name = strzone(GetCallerName(vote_caller));
791 vote_called = VOTE_NORMAL;
792 vote_called_command = strzone(vote_parsed_command);
793 vote_called_display = strzone(vote_parsed_display);
794 vote_endtime = time + autocvar_sv_vote_timeout;
798 caller.vote_selection = VOTE_SELECT_ACCEPT;
799 caller.vote_waittime = time + autocvar_sv_vote_wait;
803 FOREACH_CLIENT(IS_REAL_CLIENT(it), LAMBDA(++tmp_playercount));
804 if (tmp_playercount > 1) Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_CALL); // don't announce a "vote now" sound if player is alone
806 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote for ", vote_called_display, "\n");
807 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
808 Nagger_VoteChanged();
809 VoteCount(true); // needed if you are the only one
816 case CMD_REQUEST_USAGE:
818 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call command"));
819 print_to(caller, " Where 'command' is the command to request a vote upon.");
820 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
821 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
827 void VoteCommand_master(float request, entity caller, float argc, string vote_command) // CLIENT ONLY
831 case CMD_REQUEST_COMMAND:
833 if (autocvar_sv_vote_master)
835 switch (strtolower(argv(2)))
839 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
841 if (!caller.vote_master) { print_to(caller, "^1You do not have vote master privelages."); }
842 else if (!VoteCommand_checknasty(vote_command))
844 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
846 else if (!VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc))
848 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
851 else // everything went okay, proceed with command
853 localcmd(strcat(vote_parsed_command, "\n"));
854 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
855 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
856 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display)); }
863 if (autocvar_sv_vote_master_password == "") { print_to(caller, "^1Login to vote master is not allowed."); }
864 else if (caller.vote_master)
866 print_to(caller, "^1You are already logged in as vote master.");
868 else if (autocvar_sv_vote_master_password != argv(3))
870 print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller)));
873 else // everything went okay, proceed with giving this player master privilages
875 caller.vote_master = true;
876 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
877 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
878 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid))); }
883 default: // calling a vote for master
885 bool spectators_allowed = (!autocvar_sv_vote_nospectators || (autocvar_sv_vote_nospectators == 1 && (warmup_stage || gameover)));
887 if (!autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
888 else if (vote_called)
890 print_to(caller, "^1There is already a vote called.");
892 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
894 print_to(caller, "^1Only players can call a vote.");
896 else if (timeout_status)
898 print_to(caller, "^1You can not call a vote while a timeout is active.");
901 else // everything went okay, continue with creating vote
903 vote_caller = caller;
904 vote_caller_name = strzone(GetCallerName(vote_caller));
905 vote_called = VOTE_MASTER;
906 vote_called_command = strzone("XXX");
907 vote_called_display = strzone("^3master");
908 vote_endtime = time + autocvar_sv_vote_timeout;
910 caller.vote_selection = VOTE_SELECT_ACCEPT;
911 caller.vote_waittime = time + autocvar_sv_vote_wait;
913 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote to become ^3master^2.\n");
914 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
915 Nagger_VoteChanged();
916 VoteCount(true); // needed if you are the only one
923 else { print_to(caller, "^1Master control of voting is not allowed."); }
929 case CMD_REQUEST_USAGE:
931 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [action [command | password]]"));
932 print_to(caller, " If action is left blank, it calls a vote for you to become master.");
933 print_to(caller, " Otherwise the actions are either 'do' a command or 'login' as master.");
939 void VoteCommand_no(float request, entity caller) // CLIENT ONLY
943 case CMD_REQUEST_COMMAND:
945 if (!vote_called) { print_to(caller, "^1No vote called."); }
946 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
948 print_to(caller, "^1You have already voted.");
950 else if (((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote)
955 else // everything went okay, continue changing vote
957 print_to(caller, "^1You rejected the vote.");
958 caller.vote_selection = VOTE_SELECT_REJECT;
960 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
966 case CMD_REQUEST_USAGE:
968 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
969 print_to(caller, " No arguments required.");
975 void VoteCommand_status(float request, entity caller) // BOTH
979 case CMD_REQUEST_COMMAND:
981 if (vote_called) print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", OriginalCallerName(), "^7."));
982 else print_to(caller, "^1No vote called.");
988 case CMD_REQUEST_USAGE:
990 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
991 print_to(caller, " No arguments required.");
997 void VoteCommand_stop(float request, entity caller) // BOTH
1001 case CMD_REQUEST_COMMAND:
1003 if (!vote_called) print_to(caller, "^1No vote called.");
1004 else if ((caller == vote_caller) || !caller || caller.vote_master) VoteStop(caller);
1005 else print_to(caller, "^1You are not allowed to stop that vote.");
1010 case CMD_REQUEST_USAGE:
1012 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
1013 print_to(caller, " No arguments required.");
1019 void VoteCommand_yes(float request, entity caller) // CLIENT ONLY
1023 case CMD_REQUEST_COMMAND:
1025 if (!vote_called) { print_to(caller, "^1No vote called."); }
1026 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1028 print_to(caller, "^1You have already voted.");
1031 else // everything went okay, continue changing vote
1033 print_to(caller, "^1You accepted the vote.");
1034 caller.vote_selection = VOTE_SELECT_ACCEPT;
1035 msg_entity = caller;
1036 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
1042 case CMD_REQUEST_USAGE:
1044 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1045 print_to(caller, " No arguments required.");
1051 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1052 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1053 void VoteCommand_(float request)
1057 case CMD_REQUEST_COMMAND:
1064 case CMD_REQUEST_USAGE:
1066 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1067 print_to(caller, " No arguments required.");
1075 // ================================
1076 // Macro system for vote commands
1077 // ================================
1079 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1080 #define VOTE_COMMANDS(request, caller, arguments, command) \
1081 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1082 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1083 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1084 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1085 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1086 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1087 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1088 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1091 void VoteCommand_macro_help(entity caller, float argc)
1093 string command_origin = GetCommandPrefix(caller);
1095 if (argc == 2 || argv(2) == "help") // help display listing all commands
1097 print_to(caller, "\nVoting commands:\n");
1098 #define VOTE_COMMAND(name, function, description, assignment) \
1099 { if (Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
1101 VOTE_COMMANDS(0, caller, 0, "");
1104 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote COMMAND...^7, where possible commands are listed above.\n"));
1105 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help COMMAND"));
1106 print_to(caller, strcat("\n^7You can call a vote for or execute these commands: ^3", autocvar_sv_vote_commands, "^7 and maybe further ^3arguments^7"));
1108 else // usage for individual command
1110 #define VOTE_COMMAND(name, function, description, assignment) \
1111 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(2))) { function; return; } } }
1113 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
1118 float VoteCommand_macro_command(entity caller, float argc, string vote_command)
1120 #define VOTE_COMMAND(name, function, description, assignment) \
1121 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(1))) { function; return true; } } }
1123 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command);
1130 // ======================================
1131 // Main function handling vote commands
1132 // ======================================
1134 void VoteCommand(float request, entity caller, float argc, string vote_command)
1136 // Guide for working with argc arguments by example:
1137 // argc: 1 - 2 - 3 - 4
1138 // argv: 0 - 1 - 2 - 3
1139 // cmd vote - master - login - password
1143 case CMD_REQUEST_COMMAND:
1145 if (VoteCommand_macro_command(caller, argc, vote_command)) return;
1149 print_to(caller, strcat(((argv(1) != "") ? strcat("Unknown vote command \"", argv(1), "\"") : "No command provided"), ". For a list of supported commands, try ", GetCommandPrefix(caller), " vote help.\n"));
1150 case CMD_REQUEST_USAGE:
1152 VoteCommand_macro_help(caller, argc);