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/net_linked.qh>
17 #include <common/mapinfo.qh>
18 #include <common/notifications/all.qh>
19 #include <common/playerstats.qh>
20 #include <common/util.qh>
22 // =============================================
23 // Server side voting code, reworked by Samual
24 // Last updated: December 27th, 2011
25 // =============================================
27 // Nagger for players to know status of voting
28 bool Nagger_SendEntity(entity this, entity to, float sendflags)
32 WriteHeader(MSG_ENTITY, ENT_CLIENT_NAGGER);
36 // 2 = player needs to ready up
38 // 8 = player needs to vote
48 if (to.ready == 0) nags |= BIT(1);
53 if (to.vote_selection == 0) nags |= BIT(3);
55 if (warmup_stage) nags |= BIT(4);
57 if (sendflags & BIT(6)) nags |= BIT(6);
59 if (sendflags & BIT(7)) nags |= BIT(7);
61 if (!(nags & 4)) // no vote called? send no string
62 nags &= ~(BIT(6) | BIT(7));
64 WriteByte(MSG_ENTITY, nags);
68 WriteByte(MSG_ENTITY, vote_accept_count);
69 WriteByte(MSG_ENTITY, vote_reject_count);
70 WriteByte(MSG_ENTITY, vote_needed_overall);
71 WriteChar(MSG_ENTITY, to.vote_selection);
74 if (nags & BIT(7)) WriteString(MSG_ENTITY, vote_called_display);
78 for (i = 1; i <= maxclients; i += 8)
80 for (f = 0, e = edict_num(i), b = 1; b < 256; b *= 2, e = nextent(e))
81 if (!IS_REAL_CLIENT(e) || e.ready) f |= b;
82 WriteByte(MSG_ENTITY, f);
91 Net_LinkEntity(nagger = new_pure(nagger), false, 0, Nagger_SendEntity);
94 void Nagger_VoteChanged()
96 if (nagger) nagger.SendFlags |= BIT(7);
99 void Nagger_VoteCountChanged()
101 if (nagger) nagger.SendFlags |= BIT(6);
104 void Nagger_ReadyCounted()
106 if (nagger) nagger.SendFlags |= BIT(0);
109 // If the vote_caller is still here, return their name, otherwise vote_caller_name
110 string OriginalCallerName()
112 if (IS_REAL_CLIENT(vote_caller)) return vote_caller.netname;
113 return vote_caller_name;
116 // =======================
117 // Game logic for voting
118 // =======================
122 FOREACH_CLIENT(true, LAMBDA(it.vote_selection = 0));
126 strunzone(vote_called_command);
127 strunzone(vote_called_display);
128 strunzone(vote_caller_name);
131 vote_called = VOTE_NULL;
133 vote_caller_name = string_null;
136 vote_called_command = string_null;
137 vote_called_display = string_null;
139 vote_parsed_command = string_null;
140 vote_parsed_display = string_null;
142 Nagger_VoteChanged();
145 void VoteStop(entity stopper)
147 bprint("\{1}^2* ^3", GetCallerName(stopper), "^2 stopped ^3", OriginalCallerName(), "^2's vote\n");
148 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vstop:", ftos(stopper.playerid)));
149 // Don't force them to wait for next vote, this way they can e.g. correct their vote.
150 if ((vote_caller) && (stopper == vote_caller)) vote_caller.vote_waittime = time + autocvar_sv_vote_stop;
156 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ^1", vote_called_display, "^2 was accepted\n");
158 if ((vote_called == VOTE_MASTER) && vote_caller) vote_caller.vote_master = 1;
159 else localcmd(strcat(vote_called_command, "\n"));
161 if (vote_caller) vote_caller.vote_waittime = 0; // people like your votes, you don't need to wait to vote again
164 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_ACCEPT);
169 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 was rejected\n");
171 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_FAIL);
176 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 timed out\n");
178 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_FAIL);
181 void VoteSpam(float notvoters, float mincount, string result)
184 strcat("\{1}^2* vote results: ^1", ftos(vote_accept_count)),
185 strcat("^2:^1", ftos(vote_reject_count)),
186 ((mincount >= 0) ? strcat("^2 (^1", ftos(mincount), "^2 needed)") : "^2"),
187 strcat(", ^1", ftos(vote_abstain_count), "^2 didn't care"),
188 strcat(", ^1", ftos(notvoters), strcat("^2 didn't ", ((mincount >= 0) ? "" : "have to "), "vote\n"))));
190 if (autocvar_sv_eventlog)
193 strcat(":vote:v", result, ":", ftos(vote_accept_count)),
194 strcat(":", ftos(vote_reject_count)),
195 strcat(":", ftos(vote_abstain_count)),
196 strcat(":", ftos(notvoters)),
197 strcat(":", ftos(mincount))));
201 void VoteCount(float first_count)
204 vote_accept_count = vote_reject_count = vote_abstain_count = 0;
206 bool spectators_allowed = (!autocvar_sv_vote_nospectators || (autocvar_sv_vote_nospectators == 1 && (warmup_stage || gameover)));
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)
337 if (time <= game_starttime)
341 if (round_handler_IsActive())
342 round_handler_Reset(game_starttime);
345 MUTATOR_CALLHOOK(reset_map_global);
347 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), {
353 if (it.team_saved) it.team = it.team_saved;
354 if (it.flags & FL_PROJECTILE) delete(it); // remove any projectiles left
357 // Waypoints and assault start come LAST
358 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), {
359 if (it.reset2) it.reset2(it);
362 FOREACH_CLIENT(IS_PLAYER(it) && STAT(FROZEN, it), LAMBDA(Unfreeze(it)));
364 // Moving the player reset code here since the player-reset depends
365 // on spawnpoint entities which have to be reset first --blub
368 if (!MUTATOR_CALLHOOK(reset_map_players))
370 FOREACH_CLIENT(true, LAMBDA(
372 only reset players if a restart countdown is active
373 this can either be due to cvar sv_ready_restart_after_countdown having set
374 restart_mapalreadyrestarted to 1 after the countdown ended or when
375 sv_ready_restart_after_countdown is not used and countdown is still running
377 if (restart_mapalreadyrestarted || (time < game_starttime))
379 // NEW: changed behaviour so that it prevents that previous spectators/observers suddenly spawn as players
382 // PlayerScore_Clear(it);
384 // stop the player from moving so that he stands still once he gets respawned
385 it.velocity = '0 0 0';
386 it.avelocity = '0 0 0';
387 it.movement = '0 0 0';
388 PutClientInServer(it);
396 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
397 void ReadyRestart_think(entity this)
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 if (time <= game_starttime && gameover)
411 bprint("^1Server is restarting...\n");
415 // clear overtime, we have to decrease timelimit to its original value again.
416 if (checkrules_overtimesadded > 0 && g_race_qualifying != 2)
417 cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime)));
418 checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = 0;
420 readyrestart_happened = true;
421 game_starttime = time + RESTART_COUNTDOWN;
423 // clear player attributes
424 FOREACH_CLIENT(true, LAMBDA(
427 PS_GR_P_ADDVAL(it, PLAYERSTATS_ALIVETIME, -PS_GR_P_ADDVAL(it, PLAYERSTATS_ALIVETIME, 0));
430 restart_mapalreadyrestarted = false; // reset this var, needed when cvar sv_ready_restart_repeatable is in use
432 // disable the warmup global for the server
433 warmup_stage = 0; // once the game is restarted the game is in match stage
435 // reset the .ready status of all players (also spectators)
436 FOREACH_CLIENT(IS_REAL_CLIENT(it), LAMBDA(it.ready = false));
438 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
440 // lock teams with lockonrestart
441 if (autocvar_teamplay_lockonrestart && teamplay)
444 bprint("^1The teams are now locked.\n");
447 // initiate the restart-countdown-announcer entity
448 if (autocvar_sv_ready_restart_after_countdown)
450 entity restart_timer = new_pure(restart_timer);
451 setthink(restart_timer, ReadyRestart_think);
452 restart_timer.nextthink = game_starttime;
455 // after a restart every players number of allowed timeouts gets reset, too
456 if (autocvar_sv_timeout)
458 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), LAMBDA(it.allowed_timeouts = autocvar_sv_timeout_number));
460 // reset map immediately if this cvar is not set
461 if (!autocvar_sv_ready_restart_after_countdown) reset_map(true);
462 if (autocvar_sv_eventlog) GameLogEcho(":restart");
467 if (MUTATOR_CALLHOOK(ReadyRestart_Deny) || gameover || race_completing) localcmd("restart\n");
468 else localcmd("\nsv_hook_gamerestart\n");
470 // Reset ALL scores, but only do that at the beginning of the countdown if sv_ready_restart_after_countdown is off!
471 // Otherwise scores could be manipulated during the countdown.
472 if (!autocvar_sv_ready_restart_after_countdown) Score_ClearAll();
473 ReadyRestart_force();
476 // Count the players who are ready and determine whether or not to restart the match
479 float ready_needed_factor, ready_needed_count;
480 float t_ready = 0, t_players = 0;
482 FOREACH_CLIENT(IS_REAL_CLIENT(it) && (IS_PLAYER(it) || it.caplayer == 1), LAMBDA(
484 if (it.ready) ++t_ready;
487 readycount = t_ready;
489 Nagger_ReadyCounted();
491 ready_needed_factor = bound(0.5, cvar("g_warmup_majority_factor"), 0.999);
492 ready_needed_count = floor(t_players * ready_needed_factor) + 1;
494 if (readycount >= ready_needed_count) ReadyRestart();
498 // ======================================
499 // Supporting functions for VoteCommand
500 // ======================================
502 float Votecommand_check_assignment(entity caller, float assignment)
504 float from_server = (!caller);
506 if ((assignment == VC_ASGNMNT_BOTH)
507 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
508 || (from_server && assignment == VC_ASGNMNT_SERVERONLY))) return true;
513 string VoteCommand_extractcommand(string input, float startpos, float argc)
517 if ((argc - 1) < startpos) output = "";
518 else output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
523 float VoteCommand_checknasty(string vote_command)
525 if ((strstrofs(vote_command, ";", 0) >= 0)
526 || (strstrofs(vote_command, "\n", 0) >= 0)
527 || (strstrofs(vote_command, "\r", 0) >= 0)
528 || (strstrofs(vote_command, "$", 0) >= 0)) return false;
533 float VoteCommand_checkinlist(string vote_command, string list)
535 string l = strcat(" ", list, " ");
537 if (strstrofs(l, strcat(" ", vote_command, " "), 0) >= 0) return true;
542 string ValidateMap(string validated_map, entity caller)
544 validated_map = MapInfo_FixName(validated_map);
548 print_to(caller, "This map is not available on this server.");
552 if (!autocvar_sv_vote_override_mostrecent && caller)
554 if (Map_IsRecent(validated_map))
556 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
561 if (!MapInfo_CheckMap(validated_map))
563 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
567 return validated_map;
570 float VoteCommand_checkargs(float startpos, float argc)
572 float p, q, check, minargs;
573 string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
574 string cmdrestriction = ""; // No we don't.
575 string charlist, arg;
578 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
579 cmdrestriction = cvar_string(cvarname);
581 LOG_INFO("NOTE: ", cvarname, " does not exist, no restrictions will be applied.\n");
583 if (cmdrestriction == "") return true;
585 ++startpos; // skip command name
587 // check minimum arg count
589 // 0 args: argc == startpos
590 // 1 args: argc == startpos + 1
593 minargs = stof(cmdrestriction);
594 if (argc - startpos < minargs) return false;
596 p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
600 // we know that at any time, startpos <= argc - minargs
601 // so this means: argc-minargs >= startpos >= argc, thus
602 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
603 // have been seen already
605 if (startpos >= argc) // all args checked? GOOD
608 if (p < 0) // no more args? FAIL
610 // exception: exactly minargs left, this one included
611 if (argc - startpos == minargs) break;
617 // cut to next semicolon
618 q = strstrofs(cmdrestriction, ";", p + 1); // find next semicolon
619 if (q < 0) charlist = substring(cmdrestriction, p + 1, -1);
620 else charlist = substring(cmdrestriction, p + 1, q - (p + 1));
622 // in case we ever want to allow semicolons in VoteCommand_checknasty
623 // charlist = strreplace("^^", ";", charlist);
627 // verify the arg only contains allowed chars
628 arg = argv(startpos);
629 checkmate = strlen(arg);
630 for (check = 0; check < checkmate; ++check)
631 if (strstrofs(charlist, substring(arg, check, 1), 0) < 0) return false;
632 // not allowed character
633 // all characters are allowed. FINE.
644 float VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, float argc)
646 string first_command;
648 first_command = argv(startpos);
650 /*printf("VoteCommand_parse(): Command: '%s', Length: %f.\n",
651 substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos)),
652 strlen(substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos)))
656 (autocvar_sv_vote_limit > 0)
658 (strlen(substring(vote_command, argv_start_index(startpos), strlen(vote_command) - argv_start_index(startpos))) > autocvar_sv_vote_limit)
661 if (!VoteCommand_checkinlist(first_command, vote_list)) return false;
663 if (!VoteCommand_checkargs(startpos, argc)) return false;
665 switch (first_command) // now go through and parse the proper commands to adjust as needed.
668 case "kickban": // catch all kick/kickban commands
670 entity victim = GetIndexedEntity(argc, (startpos + 1));
671 float accepted = VerifyClientEntity(victim, true, false);
675 string reason = ((argc > next_token) ? substring(vote_command, argv_start_index(next_token), strlen(vote_command) - argv_start_index(next_token)) : "No reason provided");
676 string command_arguments;
678 if (first_command == "kickban") command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
679 else command_arguments = reason;
681 vote_parsed_command = strcat(first_command, " # ", ftos(etof(victim)), " ", command_arguments);
682 vote_parsed_display = strcat("^1", vote_command, " (^7", victim.netname, "^1): ", reason);
684 else { print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n")); return false; }
691 case "gotomap": // re-direct all map selection commands to gotomap
693 vote_command = ValidateMap(argv(startpos + 1), caller);
694 if (!vote_command) return false;
695 vote_parsed_command = strcat("gotomap ", vote_command);
696 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
703 vote_parsed_command = vote_command;
704 vote_parsed_display = strzone(strcat("^1", vote_command));
714 // =======================
715 // Command Sub-Functions
716 // =======================
718 void VoteCommand_abstain(float request, entity caller) // CLIENT ONLY
722 case CMD_REQUEST_COMMAND:
724 if (!vote_called) { print_to(caller, "^1No vote called."); }
725 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
727 print_to(caller, "^1You have already voted.");
730 else // everything went okay, continue changing vote
732 print_to(caller, "^1You abstained from your vote.");
733 caller.vote_selection = VOTE_SELECT_ABSTAIN;
735 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
741 case CMD_REQUEST_USAGE:
743 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
744 print_to(caller, " No arguments required.");
750 void VoteCommand_call(float request, entity caller, float argc, string vote_command) // BOTH
754 case CMD_REQUEST_COMMAND:
756 bool spectators_allowed = (!autocvar_sv_vote_nospectators || (autocvar_sv_vote_nospectators == 1 && (warmup_stage || gameover)));
758 float tmp_playercount = 0;
760 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
762 if (!autocvar_sv_vote_call && caller) { print_to(caller, "^1Vote calling is not allowed."); }
763 else if (!autocvar_sv_vote_gamestart && time < game_starttime)
765 print_to(caller, "^1Vote calling is not allowed before the match has started.");
767 else if (vote_called)
769 print_to(caller, "^1There is already a vote called.");
771 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
773 print_to(caller, "^1Only players can call a vote.");
775 else if (caller && !IS_CLIENT(caller))
777 print_to(caller, "^1Only connected clients can vote.");
779 else if (timeout_status)
781 print_to(caller, "^1You can not call a vote while a timeout is active.");
783 else if (caller && (time < caller.vote_waittime))
785 print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote."));
787 else if (!VoteCommand_checknasty(vote_command))
789 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
791 else if (!VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc))
793 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
796 else // everything went okay, continue with calling the vote
798 vote_caller = caller; // remember who called the vote
799 vote_caller_name = strzone(GetCallerName(vote_caller));
800 vote_called = VOTE_NORMAL;
801 vote_called_command = strzone(vote_parsed_command);
802 vote_called_display = strzone(vote_parsed_display);
803 vote_endtime = time + autocvar_sv_vote_timeout;
807 caller.vote_selection = VOTE_SELECT_ACCEPT;
808 caller.vote_waittime = time + autocvar_sv_vote_wait;
812 FOREACH_CLIENT(IS_REAL_CLIENT(it), LAMBDA(++tmp_playercount));
813 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
815 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote for ", vote_called_display, "\n");
816 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
817 Nagger_VoteChanged();
818 VoteCount(true); // needed if you are the only one
825 case CMD_REQUEST_USAGE:
827 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call command"));
828 print_to(caller, " Where 'command' is the command to request a vote upon.");
829 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
830 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
836 void VoteCommand_master(float request, entity caller, float argc, string vote_command) // CLIENT ONLY
840 case CMD_REQUEST_COMMAND:
842 if (autocvar_sv_vote_master)
844 switch (strtolower(argv(2)))
848 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
850 if (!caller.vote_master) { print_to(caller, "^1You do not have vote master privelages."); }
851 else if (!VoteCommand_checknasty(vote_command))
853 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
855 else if (!VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc))
857 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
860 else // everything went okay, proceed with command
862 localcmd(strcat(vote_parsed_command, "\n"));
863 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
864 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
865 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display)); }
872 if (autocvar_sv_vote_master_password == "") { print_to(caller, "^1Login to vote master is not allowed."); }
873 else if (caller.vote_master)
875 print_to(caller, "^1You are already logged in as vote master.");
877 else if (autocvar_sv_vote_master_password != argv(3))
879 print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller)));
882 else // everything went okay, proceed with giving this player master privilages
884 caller.vote_master = true;
885 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
886 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
887 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid))); }
892 default: // calling a vote for master
894 bool spectators_allowed = (!autocvar_sv_vote_nospectators || (autocvar_sv_vote_nospectators == 1 && (warmup_stage || gameover)));
896 if (!autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
897 else if (vote_called)
899 print_to(caller, "^1There is already a vote called.");
901 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
903 print_to(caller, "^1Only players can call a vote.");
905 else if (timeout_status)
907 print_to(caller, "^1You can not call a vote while a timeout is active.");
910 else // everything went okay, continue with creating vote
912 vote_caller = caller;
913 vote_caller_name = strzone(GetCallerName(vote_caller));
914 vote_called = VOTE_MASTER;
915 vote_called_command = strzone("XXX");
916 vote_called_display = strzone("^3master");
917 vote_endtime = time + autocvar_sv_vote_timeout;
919 caller.vote_selection = VOTE_SELECT_ACCEPT;
920 caller.vote_waittime = time + autocvar_sv_vote_wait;
922 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote to become ^3master^2.\n");
923 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
924 Nagger_VoteChanged();
925 VoteCount(true); // needed if you are the only one
932 else { print_to(caller, "^1Master control of voting is not allowed."); }
938 case CMD_REQUEST_USAGE:
940 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [action [command | password]]"));
941 print_to(caller, " If action is left blank, it calls a vote for you to become master.");
942 print_to(caller, " Otherwise the actions are either 'do' a command or 'login' as master.");
948 void VoteCommand_no(float request, entity caller) // CLIENT ONLY
952 case CMD_REQUEST_COMMAND:
954 if (!vote_called) { print_to(caller, "^1No vote called."); }
955 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
957 print_to(caller, "^1You have already voted.");
959 else if (((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote)
964 else // everything went okay, continue changing vote
966 print_to(caller, "^1You rejected the vote.");
967 caller.vote_selection = VOTE_SELECT_REJECT;
969 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
975 case CMD_REQUEST_USAGE:
977 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
978 print_to(caller, " No arguments required.");
984 void VoteCommand_status(float request, entity caller) // BOTH
988 case CMD_REQUEST_COMMAND:
990 if (vote_called) print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", OriginalCallerName(), "^7."));
991 else print_to(caller, "^1No vote called.");
997 case CMD_REQUEST_USAGE:
999 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
1000 print_to(caller, " No arguments required.");
1006 void VoteCommand_stop(float request, entity caller) // BOTH
1010 case CMD_REQUEST_COMMAND:
1012 if (!vote_called) print_to(caller, "^1No vote called.");
1013 else if ((caller == vote_caller) || !caller || caller.vote_master) VoteStop(caller);
1014 else print_to(caller, "^1You are not allowed to stop that vote.");
1019 case CMD_REQUEST_USAGE:
1021 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
1022 print_to(caller, " No arguments required.");
1028 void VoteCommand_yes(float request, entity caller) // CLIENT ONLY
1032 case CMD_REQUEST_COMMAND:
1034 if (!vote_called) { print_to(caller, "^1No vote called."); }
1035 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1037 print_to(caller, "^1You have already voted.");
1040 else // everything went okay, continue changing vote
1042 print_to(caller, "^1You accepted the vote.");
1043 caller.vote_selection = VOTE_SELECT_ACCEPT;
1044 msg_entity = caller;
1045 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
1051 case CMD_REQUEST_USAGE:
1053 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1054 print_to(caller, " No arguments required.");
1060 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1061 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1062 void VoteCommand_(float request)
1066 case CMD_REQUEST_COMMAND:
1073 case CMD_REQUEST_USAGE:
1075 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1076 print_to(caller, " No arguments required.");
1084 // ================================
1085 // Macro system for vote commands
1086 // ================================
1088 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1089 #define VOTE_COMMANDS(request, caller, arguments, command) \
1090 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1091 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1092 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1093 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1094 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1095 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1096 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1097 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1100 void VoteCommand_macro_help(entity caller, float argc)
1102 string command_origin = GetCommandPrefix(caller);
1104 if (argc == 2 || argv(2) == "help") // help display listing all commands
1106 print_to(caller, "\nVoting commands:\n");
1107 #define VOTE_COMMAND(name, function, description, assignment) \
1108 { if (Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
1110 VOTE_COMMANDS(0, caller, 0, "");
1113 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote COMMAND...^7, where possible commands are listed above.\n"));
1114 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help COMMAND"));
1115 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"));
1117 else // usage for individual command
1119 #define VOTE_COMMAND(name, function, description, assignment) \
1120 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(2))) { function; return; } } }
1122 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
1127 float VoteCommand_macro_command(entity caller, float argc, string vote_command)
1129 #define VOTE_COMMAND(name, function, description, assignment) \
1130 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(1))) { function; return true; } } }
1132 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command);
1139 // ======================================
1140 // Main function handling vote commands
1141 // ======================================
1143 void VoteCommand(float request, entity caller, float argc, string vote_command)
1145 // Guide for working with argc arguments by example:
1146 // argc: 1 - 2 - 3 - 4
1147 // argv: 0 - 1 - 2 - 3
1148 // cmd vote - master - login - password
1152 case CMD_REQUEST_COMMAND:
1154 if (VoteCommand_macro_command(caller, argc, vote_command)) return;
1158 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"));
1159 case CMD_REQUEST_USAGE:
1161 VoteCommand_macro_help(caller, argc);