1 #include <common/command/command.qh>
6 #include "../g_damage.qh"
7 #include "../g_world.qh"
9 #include "../round_handler.qh"
10 #include "../scores.qh"
12 #include "../mutators/all.qh"
14 #include <common/constants.qh>
15 #include <common/mapinfo.qh>
16 #include <common/notifications/all.qh>
17 #include <common/playerstats.qh>
18 #include <common/util.qh>
20 // =============================================
21 // Server side voting code, reworked by Samual
22 // Last updated: December 27th, 2011
23 // =============================================
25 // Nagger for players to know status of voting
26 bool Nagger_SendEntity(entity this, entity to, float sendflags)
30 WriteHeader(MSG_ENTITY, ENT_CLIENT_NAGGER);
34 // 2 = player needs to ready up
36 // 8 = player needs to vote
46 if (to.ready == 0) nags |= BIT(1);
51 if (to.vote_selection == 0) nags |= BIT(3);
53 if (warmup_stage) nags |= BIT(4);
55 if (sendflags & BIT(6)) nags |= BIT(6);
57 if (sendflags & BIT(7)) nags |= BIT(7);
59 if (!(nags & 4)) // no vote called? send no string
60 nags &= ~(BIT(6) | BIT(7));
62 WriteByte(MSG_ENTITY, nags);
66 WriteByte(MSG_ENTITY, vote_accept_count);
67 WriteByte(MSG_ENTITY, vote_reject_count);
68 WriteByte(MSG_ENTITY, vote_needed_overall);
69 WriteChar(MSG_ENTITY, to.vote_selection);
72 if (nags & BIT(7)) WriteString(MSG_ENTITY, vote_called_display);
76 for (i = 1; i <= maxclients; i += 8)
78 for (f = 0, e = edict_num(i), b = 1; b < 256; b *= 2, e = nextent(e))
79 if (!IS_REAL_CLIENT(e) || e.ready) f |= b;
80 WriteByte(MSG_ENTITY, f);
89 Net_LinkEntity(nagger = new_pure(nagger), false, 0, Nagger_SendEntity);
92 void Nagger_VoteChanged()
94 if (nagger) nagger.SendFlags |= BIT(7);
97 void Nagger_VoteCountChanged()
99 if (nagger) nagger.SendFlags |= BIT(6);
102 void Nagger_ReadyCounted()
104 if (nagger) nagger.SendFlags |= BIT(0);
107 // If the vote_caller is still here, return their name, otherwise vote_caller_name
108 string OriginalCallerName()
110 if (IS_REAL_CLIENT(vote_caller)) return vote_caller.netname;
111 return vote_caller_name;
114 // =======================
115 // Game logic for voting
116 // =======================
120 FOREACH_CLIENT(true, LAMBDA(it.vote_selection = 0));
124 strunzone(vote_called_command);
125 strunzone(vote_called_display);
126 strunzone(vote_caller_name);
129 vote_called = VOTE_NULL;
131 vote_caller_name = string_null;
134 vote_called_command = string_null;
135 vote_called_display = string_null;
137 vote_parsed_command = string_null;
138 vote_parsed_display = string_null;
140 Nagger_VoteChanged();
143 void VoteStop(entity stopper)
145 bprint("\{1}^2* ^3", GetCallerName(stopper), "^2 stopped ^3", OriginalCallerName(), "^2's vote\n");
146 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vstop:", ftos(stopper.playerid)));
147 // Don't force them to wait for next vote, this way they can e.g. correct their vote.
148 if ((vote_caller) && (stopper == vote_caller)) vote_caller.vote_waittime = time + autocvar_sv_vote_stop;
154 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ^1", vote_called_display, "^2 was accepted\n");
156 if ((vote_called == VOTE_MASTER) && vote_caller) vote_caller.vote_master = 1;
157 else localcmd(strcat(vote_called_command, "\n"));
159 if (vote_caller) vote_caller.vote_waittime = 0; // people like your votes, you don't need to wait to vote again
162 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_VOTE_ACCEPT);
167 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 was rejected\n");
169 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_VOTE_FAIL);
174 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 timed out\n");
176 Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_VOTE_FAIL);
179 void VoteSpam(float notvoters, float mincount, string result)
182 strcat("\{1}^2* vote results: ^1", ftos(vote_accept_count)),
183 strcat("^2:^1", ftos(vote_reject_count)),
184 ((mincount >= 0) ? strcat("^2 (^1", ftos(mincount), "^2 needed)") : "^2"),
185 strcat(", ^1", ftos(vote_abstain_count), "^2 didn't care"),
186 strcat(", ^1", ftos(notvoters), strcat("^2 didn't ", ((mincount >= 0) ? "" : "have to "), "vote\n"))));
188 if (autocvar_sv_eventlog)
191 strcat(":vote:v", result, ":", ftos(vote_accept_count)),
192 strcat(":", ftos(vote_reject_count)),
193 strcat(":", ftos(vote_abstain_count)),
194 strcat(":", ftos(notvoters)),
195 strcat(":", ftos(mincount))));
199 void VoteCount(float first_count)
202 vote_accept_count = vote_reject_count = vote_abstain_count = 0;
204 float spectators_allowed = ((autocvar_sv_vote_nospectators != 2)
205 || ((autocvar_sv_vote_nospectators == 1) && (warmup_stage || gameover))
206 || (autocvar_sv_vote_nospectators == 0));
208 float vote_player_count = 0, notvoters = 0;
209 float vote_real_player_count = 0, vote_real_accept_count = 0;
210 float vote_real_reject_count = 0, vote_real_abstain_count = 0;
211 float vote_needed_of_voted, final_needed_votes;
212 float vote_factor_overall, vote_factor_of_voted;
214 Nagger_VoteCountChanged();
216 // add up all the votes from each connected client
217 FOREACH_CLIENT(IS_REAL_CLIENT(it) && IS_CLIENT(it), LAMBDA(
219 if (IS_PLAYER(it)) ++vote_real_player_count;
220 switch (it.vote_selection)
222 case VOTE_SELECT_REJECT:
223 { ++vote_reject_count;
224 { if (IS_PLAYER(it)) ++vote_real_reject_count; } break;
226 case VOTE_SELECT_ACCEPT:
227 { ++vote_accept_count;
228 { if (IS_PLAYER(it)) ++vote_real_accept_count; } break;
230 case VOTE_SELECT_ABSTAIN:
231 { ++vote_abstain_count;
232 { if (IS_PLAYER(it)) ++vote_real_abstain_count; } break;
238 // Check to see if there are enough players on the server to allow master voting... otherwise, vote master could be used for evil.
239 if ((vote_called == VOTE_MASTER) && autocvar_sv_vote_master_playerlimit > vote_player_count)
241 if (vote_caller) vote_caller.vote_waittime = 0;
242 print_to(vote_caller, "^1There are not enough players on this server to allow you to become vote master.");
247 // 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.
248 if (!spectators_allowed && (vote_real_player_count > 0))
250 vote_accept_count = vote_real_accept_count;
251 vote_reject_count = vote_real_reject_count;
252 vote_abstain_count = vote_real_abstain_count;
253 vote_player_count = vote_real_player_count;
256 // people who have no opinion in any way :D
257 notvoters = (vote_player_count - vote_accept_count - vote_reject_count - vote_abstain_count);
259 // determine the goal for the vote to be passed or rejected normally
260 vote_factor_overall = bound(0.5, autocvar_sv_vote_majority_factor, 0.999);
261 vote_needed_overall = floor((vote_player_count - vote_abstain_count) * vote_factor_overall) + 1;
263 // if the vote times out, determine the amount of votes needed of the people who actually already voted
264 vote_factor_of_voted = bound(0.5, autocvar_sv_vote_majority_factor_of_voted, 0.999);
265 vote_needed_of_voted = floor((vote_accept_count + vote_reject_count) * vote_factor_of_voted) + 1;
267 // are there any players at all on the server? it could be an admin vote
268 if (vote_player_count == 0 && first_count)
270 VoteSpam(0, -1, "yes"); // no players at all, just accept it
275 // since there ARE players, finally calculate the result of the vote
276 if (vote_accept_count >= vote_needed_overall)
278 VoteSpam(notvoters, -1, "yes"); // there is enough acceptions to pass the vote
283 if (vote_reject_count > vote_player_count - vote_abstain_count - vote_needed_overall)
285 VoteSpam(notvoters, -1, "no"); // there is enough rejections to deny the vote
290 // there is not enough votes in either direction, now lets just calculate what the voters have said
291 if (time > vote_endtime)
293 final_needed_votes = vote_needed_overall;
295 if (autocvar_sv_vote_majority_factor_of_voted)
297 if (vote_accept_count >= vote_needed_of_voted)
299 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "yes");
304 if (vote_accept_count + vote_reject_count > 0)
306 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "no");
311 final_needed_votes = min(vote_needed_overall, vote_needed_of_voted);
314 // it didn't pass or fail, so not enough votes to even make a decision.
315 VoteSpam(notvoters, final_needed_votes, "timeout");
322 if (vote_endtime > 0) // a vote was called
324 if (time > vote_endtime) // time is up
330 // =======================
331 // Game logic for warmup
332 // =======================
334 // Resets the state of all clients, items, weapons, waypoints, ... of the map.
335 void reset_map(bool dorespawn)
339 if (time <= game_starttime && round_handler_IsActive()) round_handler_Reset(game_starttime);
341 MUTATOR_CALLHOOK(reset_map_global);
343 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), LAMBDA(
346 WITH(entity, self, it, it.reset(it));
349 if (it.team_saved) it.team = it.team_saved;
350 if (it.flags & FL_PROJECTILE) remove(it); // remove any projectiles left
353 // Waypoints and assault start come LAST
354 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), LAMBDA(
355 if (it.reset2) WITH(entity, self, it, it.reset2());
358 FOREACH_CLIENT(IS_PLAYER(it) && STAT(FROZEN, it), LAMBDA(WITH(entity, self, it, Unfreeze(it))));
360 // Moving the player reset code here since the player-reset depends
361 // on spawnpoint entities which have to be reset first --blub
364 if (!MUTATOR_CALLHOOK(reset_map_players))
366 FOREACH_CLIENT(true, LAMBDA(
369 only reset players if a restart countdown is active
370 this can either be due to cvar sv_ready_restart_after_countdown having set
371 restart_mapalreadyrestarted to 1 after the countdown ended or when
372 sv_ready_restart_after_countdown is not used and countdown is still running
374 if (restart_mapalreadyrestarted || (time < game_starttime))
376 // NEW: changed behaviour so that it prevents that previous spectators/observers suddenly spawn as players
379 // PlayerScore_Clear(self);
381 // stop the player from moving so that he stands still once he gets respawned
382 self.velocity = '0 0 0';
383 self.avelocity = '0 0 0';
384 self.movement = '0 0 0';
395 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
396 void ReadyRestart_think()
399 restart_mapalreadyrestarted = true;
405 // Forces a restart of the game without actually reloading the map // this is a mess...
406 void ReadyRestart_force()
408 bprint("^1Server is restarting...\n");
412 // clear overtime, we have to decrease timelimit to its original value again.
413 if (checkrules_overtimesadded > 0 && g_race_qualifying != 2)
414 cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime)));
415 checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = 0;
417 readyrestart_happened = true;
418 game_starttime = time + RESTART_COUNTDOWN;
420 // clear player attributes
421 FOREACH_CLIENT(true, LAMBDA(
424 PS_GR_P_ADDVAL(it, PLAYERSTATS_ALIVETIME, -PS_GR_P_ADDVAL(it, PLAYERSTATS_ALIVETIME, 0));
427 restart_mapalreadyrestarted = false; // reset this var, needed when cvar sv_ready_restart_repeatable is in use
429 // disable the warmup global for the server
430 warmup_stage = 0; // once the game is restarted the game is in match stage
432 // reset the .ready status of all players (also spectators)
433 FOREACH_CLIENT(IS_REAL_CLIENT(it), LAMBDA(it.ready = false));
435 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
437 // lock teams with lockonrestart
438 if (autocvar_teamplay_lockonrestart && teamplay)
441 bprint("^1The teams are now locked.\n");
444 // initiate the restart-countdown-announcer entity
445 if (autocvar_sv_ready_restart_after_countdown)
447 entity restart_timer = new_pure(restart_timer);
448 restart_timer.think = ReadyRestart_think;
449 restart_timer.nextthink = game_starttime;
452 // after a restart every players number of allowed timeouts gets reset, too
453 if (autocvar_sv_timeout)
455 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), LAMBDA(it.allowed_timeouts = autocvar_sv_timeout_number));
457 // reset map immediately if this cvar is not set
458 if (!autocvar_sv_ready_restart_after_countdown) reset_map(true);
459 if (autocvar_sv_eventlog) GameLogEcho(":restart");
464 // no assault support yet...
465 if (g_assault | gameover | intermission_running | race_completing) localcmd("restart\n");
466 else localcmd("\nsv_hook_gamerestart\n");
468 // Reset ALL scores, but only do that at the beginning of the countdown if sv_ready_restart_after_countdown is off!
469 // Otherwise scores could be manipulated during the countdown.
470 if (!autocvar_sv_ready_restart_after_countdown) Score_ClearAll();
471 ReadyRestart_force();
474 // Count the players who are ready and determine whether or not to restart the match
477 float ready_needed_factor, ready_needed_count;
478 float t_ready = 0, t_players = 0;
480 FOREACH_CLIENT(IS_REAL_CLIENT(it) && (IS_PLAYER(it) || it.caplayer == 1), LAMBDA(
482 if (it.ready) ++t_ready;
485 readycount = t_ready;
487 Nagger_ReadyCounted();
489 ready_needed_factor = bound(0.5, cvar("g_warmup_majority_factor"), 0.999);
490 ready_needed_count = floor(t_players * ready_needed_factor) + 1;
492 if (readycount >= ready_needed_count) ReadyRestart();
496 // ======================================
497 // Supporting functions for VoteCommand
498 // ======================================
500 float Votecommand_check_assignment(entity caller, float assignment)
502 float from_server = (!caller);
504 if ((assignment == VC_ASGNMNT_BOTH)
505 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
506 || (from_server && assignment == VC_ASGNMNT_SERVERONLY))) return true;
511 string VoteCommand_extractcommand(string input, float startpos, float argc)
515 if ((argc - 1) < startpos) output = "";
516 else output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
521 float VoteCommand_checknasty(string vote_command)
523 if ((strstrofs(vote_command, ";", 0) >= 0)
524 || (strstrofs(vote_command, "\n", 0) >= 0)
525 || (strstrofs(vote_command, "\r", 0) >= 0)
526 || (strstrofs(vote_command, "$", 0) >= 0)) return false;
531 float VoteCommand_checkinlist(string vote_command, string list)
533 string l = strcat(" ", list, " ");
535 if (strstrofs(l, strcat(" ", vote_command, " "), 0) >= 0) return true;
540 string ValidateMap(string validated_map, entity caller)
542 validated_map = MapInfo_FixName(validated_map);
546 print_to(caller, "This map is not available on this server.");
550 if (!autocvar_sv_vote_override_mostrecent && caller)
552 if (Map_IsRecent(validated_map))
554 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
559 if (!MapInfo_CheckMap(validated_map))
561 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
565 return validated_map;
568 float VoteCommand_checkargs(float startpos, float argc)
570 float p, q, check, minargs;
571 string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
572 string cmdrestriction = cvar_string(cvarname); // note: this warns on undefined cvar. We want that.
573 string charlist, arg;
576 if (cmdrestriction == "") return true;
578 ++startpos; // skip command name
580 // check minimum arg count
582 // 0 args: argc == startpos
583 // 1 args: argc == startpos + 1
586 minargs = stof(cmdrestriction);
587 if (argc - startpos < minargs) return false;
589 p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
593 // we know that at any time, startpos <= argc - minargs
594 // so this means: argc-minargs >= startpos >= argc, thus
595 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
596 // have been seen already
598 if (startpos >= argc) // all args checked? GOOD
601 if (p < 0) // no more args? FAIL
603 // exception: exactly minargs left, this one included
604 if (argc - startpos == minargs) break;
610 // cut to next semicolon
611 q = strstrofs(cmdrestriction, ";", p + 1); // find next semicolon
612 if (q < 0) charlist = substring(cmdrestriction, p + 1, -1);
613 else charlist = substring(cmdrestriction, p + 1, q - (p + 1));
615 // in case we ever want to allow semicolons in VoteCommand_checknasty
616 // charlist = strreplace("^^", ";", charlist);
620 // verify the arg only contains allowed chars
621 arg = argv(startpos);
622 checkmate = strlen(arg);
623 for (check = 0; check < checkmate; ++check)
624 if (strstrofs(charlist, substring(arg, check, 1), 0) < 0) return false;
625 // not allowed character
626 // all characters are allowed. FINE.
637 float VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, float argc)
639 string first_command;
641 first_command = argv(startpos);
643 /*printf("VoteCommand_parse(): Command: '%s', Length: %f.\n",
644 substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos)),
645 strlen(substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos)))
649 (autocvar_sv_vote_limit > 0)
651 (strlen(substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos))) > autocvar_sv_vote_limit)
654 if (!VoteCommand_checkinlist(first_command, vote_list)) return false;
656 if (!VoteCommand_checkargs(startpos, argc)) return false;
658 switch (first_command) // now go through and parse the proper commands to adjust as needed.
661 case "kickban": // catch all kick/kickban commands
663 entity victim = GetIndexedEntity(argc, (startpos + 1));
664 float accepted = VerifyClientEntity(victim, true, false);
668 string reason = ((argc > next_token) ? substring(vote_command, argv_start_index(next_token), strlen(vote_command) - argv_start_index(next_token)) : "No reason provided");
669 string command_arguments;
671 if (first_command == "kickban") command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
672 else command_arguments = reason;
674 vote_parsed_command = strcat(first_command, " # ", ftos(etof(victim)), " ", command_arguments);
675 vote_parsed_display = strcat("^1", vote_command, " (^7", victim.netname, "^1): ", reason);
677 else { print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n")); return false; }
684 case "gotomap": // re-direct all map selection commands to gotomap
686 vote_command = ValidateMap(argv(startpos + 1), caller);
687 if (!vote_command) return false;
688 vote_parsed_command = strcat("gotomap ", vote_command);
689 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
696 vote_parsed_command = vote_command;
697 vote_parsed_display = strzone(strcat("^1", vote_command));
707 // =======================
708 // Command Sub-Functions
709 // =======================
711 void VoteCommand_abstain(float request, entity caller) // CLIENT ONLY
715 case CMD_REQUEST_COMMAND:
717 if (!vote_called) { print_to(caller, "^1No vote called."); }
718 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
720 print_to(caller, "^1You have already voted.");
723 else // everything went okay, continue changing vote
725 print_to(caller, "^1You abstained from your vote.");
726 caller.vote_selection = VOTE_SELECT_ABSTAIN;
728 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
734 case CMD_REQUEST_USAGE:
736 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
737 print_to(caller, " No arguments required.");
743 void VoteCommand_call(float request, entity caller, float argc, string vote_command) // BOTH
747 case CMD_REQUEST_COMMAND:
749 float spectators_allowed = ((autocvar_sv_vote_nospectators != 2)
750 || ((autocvar_sv_vote_nospectators == 1) && warmup_stage)
751 || (autocvar_sv_vote_nospectators == 0));
753 float tmp_playercount = 0;
755 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
757 if (!autocvar_sv_vote_call && caller) { print_to(caller, "^1Vote calling is not allowed."); }
758 else if (!autocvar_sv_vote_gamestart && time < game_starttime)
760 print_to(caller, "^1Vote calling is not allowed before the match has started.");
762 else if (vote_called)
764 print_to(caller, "^1There is already a vote called.");
766 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
768 print_to(caller, "^1Only players can call a vote.");
770 else if (caller && !IS_CLIENT(caller))
772 print_to(caller, "^1Only connected clients can vote.");
774 else if (timeout_status)
776 print_to(caller, "^1You can not call a vote while a timeout is active.");
778 else if (caller && (time < caller.vote_waittime))
780 print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote."));
782 else if (!VoteCommand_checknasty(vote_command))
784 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
786 else if (!VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc))
788 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
791 else // everything went okay, continue with calling the vote
793 vote_caller = caller; // remember who called the vote
794 vote_caller_name = strzone(GetCallerName(vote_caller));
795 vote_called = VOTE_NORMAL;
796 vote_called_command = strzone(vote_parsed_command);
797 vote_called_display = strzone(vote_parsed_display);
798 vote_endtime = time + autocvar_sv_vote_timeout;
802 caller.vote_selection = VOTE_SELECT_ACCEPT;
803 caller.vote_waittime = time + autocvar_sv_vote_wait;
807 FOREACH_CLIENT(IS_REAL_CLIENT(it), LAMBDA(++tmp_playercount));
808 if (tmp_playercount > 1) Send_Notification(NOTIF_ALL, world, MSG_ANNCE, ANNCE_VOTE_CALL); // don't announce a "vote now" sound if player is alone
810 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote for ", vote_called_display, "\n");
811 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
812 Nagger_VoteChanged();
813 VoteCount(true); // needed if you are the only one
820 case CMD_REQUEST_USAGE:
822 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call command"));
823 print_to(caller, " Where 'command' is the command to request a vote upon.");
824 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
825 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
831 void VoteCommand_master(float request, entity caller, float argc, string vote_command) // CLIENT ONLY
835 case CMD_REQUEST_COMMAND:
837 if (autocvar_sv_vote_master)
839 switch (strtolower(argv(2)))
843 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
845 if (!caller.vote_master) { print_to(caller, "^1You do not have vote master privelages."); }
846 else if (!VoteCommand_checknasty(vote_command))
848 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
850 else if (!VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc))
852 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
855 else // everything went okay, proceed with command
857 localcmd(strcat(vote_parsed_command, "\n"));
858 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
859 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
860 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display)); }
867 if (autocvar_sv_vote_master_password == "") { print_to(caller, "^1Login to vote master is not allowed."); }
868 else if (caller.vote_master)
870 print_to(caller, "^1You are already logged in as vote master.");
872 else if (autocvar_sv_vote_master_password != argv(3))
874 print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller)));
877 else // everything went okay, proceed with giving this player master privilages
879 caller.vote_master = true;
880 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
881 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
882 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid))); }
887 default: // calling a vote for master
889 float spectators_allowed = ((autocvar_sv_vote_nospectators != 2)
890 || ((autocvar_sv_vote_nospectators == 1) && warmup_stage)
891 || (autocvar_sv_vote_nospectators == 0));
893 if (!autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
894 else if (vote_called)
896 print_to(caller, "^1There is already a vote called.");
898 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
900 print_to(caller, "^1Only players can call a vote.");
902 else if (timeout_status)
904 print_to(caller, "^1You can not call a vote while a timeout is active.");
907 else // everything went okay, continue with creating vote
909 vote_caller = caller;
910 vote_caller_name = strzone(GetCallerName(vote_caller));
911 vote_called = VOTE_MASTER;
912 vote_called_command = strzone("XXX");
913 vote_called_display = strzone("^3master");
914 vote_endtime = time + autocvar_sv_vote_timeout;
916 caller.vote_selection = VOTE_SELECT_ACCEPT;
917 caller.vote_waittime = time + autocvar_sv_vote_wait;
919 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote to become ^3master^2.\n");
920 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
921 Nagger_VoteChanged();
922 VoteCount(true); // needed if you are the only one
929 else { print_to(caller, "^1Master control of voting is not allowed."); }
935 case CMD_REQUEST_USAGE:
937 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [action [command | password]]"));
938 print_to(caller, " If action is left blank, it calls a vote for you to become master.");
939 print_to(caller, " Otherwise the actions are either 'do' a command or 'login' as master.");
945 void VoteCommand_no(float request, entity caller) // CLIENT ONLY
949 case CMD_REQUEST_COMMAND:
951 if (!vote_called) { print_to(caller, "^1No vote called."); }
952 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
954 print_to(caller, "^1You have already voted.");
956 else if (((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote)
961 else // everything went okay, continue changing vote
963 print_to(caller, "^1You rejected the vote.");
964 caller.vote_selection = VOTE_SELECT_REJECT;
966 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
972 case CMD_REQUEST_USAGE:
974 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
975 print_to(caller, " No arguments required.");
981 void VoteCommand_status(float request, entity caller) // BOTH
985 case CMD_REQUEST_COMMAND:
987 if (vote_called) print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", OriginalCallerName(), "^7."));
988 else print_to(caller, "^1No vote called.");
994 case CMD_REQUEST_USAGE:
996 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
997 print_to(caller, " No arguments required.");
1003 void VoteCommand_stop(float request, entity caller) // BOTH
1007 case CMD_REQUEST_COMMAND:
1009 if (!vote_called) print_to(caller, "^1No vote called.");
1010 else if ((caller == vote_caller) || !caller || caller.vote_master) VoteStop(caller);
1011 else print_to(caller, "^1You are not allowed to stop that vote.");
1016 case CMD_REQUEST_USAGE:
1018 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
1019 print_to(caller, " No arguments required.");
1025 void VoteCommand_yes(float request, entity caller) // CLIENT ONLY
1029 case CMD_REQUEST_COMMAND:
1031 if (!vote_called) { print_to(caller, "^1No vote called."); }
1032 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1034 print_to(caller, "^1You have already voted.");
1037 else // everything went okay, continue changing vote
1039 print_to(caller, "^1You accepted the vote.");
1040 caller.vote_selection = VOTE_SELECT_ACCEPT;
1041 msg_entity = caller;
1042 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
1048 case CMD_REQUEST_USAGE:
1050 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1051 print_to(caller, " No arguments required.");
1057 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1058 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1059 void VoteCommand_(float request)
1063 case CMD_REQUEST_COMMAND:
1070 case CMD_REQUEST_USAGE:
1072 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1073 print_to(caller, " No arguments required.");
1081 // ================================
1082 // Macro system for vote commands
1083 // ================================
1085 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1086 #define VOTE_COMMANDS(request, caller, arguments, command) \
1087 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1088 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1089 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1090 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1091 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1092 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1093 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1094 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1097 void VoteCommand_macro_help(entity caller, float argc)
1099 string command_origin = GetCommandPrefix(caller);
1101 if (argc == 2 || argv(2) == "help") // help display listing all commands
1103 print_to(caller, "\nVoting commands:\n");
1104 #define VOTE_COMMAND(name, function, description, assignment) \
1105 { if (Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
1107 VOTE_COMMANDS(0, caller, 0, "");
1110 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote COMMAND...^7, where possible commands are listed above.\n"));
1111 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help COMMAND"));
1112 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"));
1114 else // usage for individual command
1116 #define VOTE_COMMAND(name, function, description, assignment) \
1117 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(2))) { function; return; } } }
1119 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
1124 float VoteCommand_macro_command(entity caller, float argc, string vote_command)
1126 #define VOTE_COMMAND(name, function, description, assignment) \
1127 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(1))) { function; return true; } } }
1129 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command);
1136 // ======================================
1137 // Main function handling vote commands
1138 // ======================================
1140 void VoteCommand(float request, entity caller, float argc, string vote_command)
1142 // Guide for working with argc arguments by example:
1143 // argc: 1 - 2 - 3 - 4
1144 // argv: 0 - 1 - 2 - 3
1145 // cmd vote - master - login - password
1149 case CMD_REQUEST_COMMAND:
1151 if (VoteCommand_macro_command(caller, argc, vote_command)) return;
1155 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"));
1156 case CMD_REQUEST_USAGE:
1158 VoteCommand_macro_help(caller, argc);