3 #include <server/defs.qh>
4 #include <server/gamelog.qh>
5 #include <server/miscfunctions.qh>
7 #include <common/command/_mod.qh>
12 #include "../g_damage.qh"
13 #include "../g_world.qh"
14 #include "../teamplay.qh"
16 #include "../round_handler.qh"
17 #include "../scores.qh"
19 #include <server/mutators/_mod.qh>
20 #include <common/gamemodes/_mod.qh>
22 #include <common/constants.qh>
23 #include <common/net_linked.qh>
24 #include <common/mapinfo.qh>
25 #include <common/notifications/all.qh>
26 #include <common/playerstats.qh>
27 #include <common/util.qh>
29 // =============================================
30 // Server side voting code, reworked by Samual
31 // Last updated: December 27th, 2011
32 // =============================================
34 // Nagger for players to know status of voting
35 bool Nagger_SendEntity(entity this, entity to, float sendflags)
39 WriteHeader(MSG_ENTITY, ENT_CLIENT_NAGGER);
43 // 2 = player needs to ready up
45 // 8 = player needs to vote
55 if (to.ready == 0) nags |= BIT(1);
60 if (to.vote_selection == 0) nags |= BIT(3);
62 if (warmup_stage) nags |= BIT(4);
64 if (sendflags & BIT(6)) nags |= BIT(6);
66 if (sendflags & BIT(7)) nags |= BIT(7);
68 if (!(nags & 4)) // no vote called? send no string
69 nags &= ~(BIT(6) | BIT(7));
71 WriteByte(MSG_ENTITY, nags);
75 WriteByte(MSG_ENTITY, vote_accept_count);
76 WriteByte(MSG_ENTITY, vote_reject_count);
77 WriteByte(MSG_ENTITY, vote_needed_overall);
78 WriteChar(MSG_ENTITY, to.vote_selection);
81 if (nags & BIT(7)) WriteString(MSG_ENTITY, vote_called_display);
85 for (i = 1; i <= maxclients; i += 8)
87 for (f = 0, e = edict_num(i), b = BIT(0); b < BIT(8); b <<= 1, e = nextent(e))
88 if (!IS_REAL_CLIENT(e) || e.ready)
90 WriteByte(MSG_ENTITY, f);
99 Net_LinkEntity(nagger = new_pure(nagger), false, 0, Nagger_SendEntity);
102 void Nagger_VoteChanged()
104 if (nagger) nagger.SendFlags |= BIT(7);
107 void Nagger_VoteCountChanged()
109 if (nagger) nagger.SendFlags |= BIT(6);
112 void Nagger_ReadyCounted()
114 if (nagger) nagger.SendFlags |= BIT(0);
117 // If the vote_caller is still here, return their name, otherwise vote_caller_name
118 string OriginalCallerName()
120 if (IS_REAL_CLIENT(vote_caller)) return playername(vote_caller, false);
121 return vote_caller_name;
124 // =======================
125 // Game logic for voting
126 // =======================
130 FOREACH_CLIENT(true, { it.vote_selection = 0; });
134 strfree(vote_called_command);
135 strfree(vote_called_display);
136 strfree(vote_caller_name);
139 vote_called = VOTE_NULL;
143 vote_parsed_command = string_null;
144 vote_parsed_display = string_null;
146 Nagger_VoteChanged();
149 void VoteStop(entity stopper)
151 bprint("\{1}^2* ^3", GetCallerName(stopper), "^2 stopped ^3", OriginalCallerName(), "^2's vote\n");
152 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vstop:", ftos(stopper.playerid)));
153 // Don't force them to wait for next vote, this way they can e.g. correct their vote.
154 if ((vote_caller) && (stopper == vote_caller)) vote_caller.vote_waittime = time + autocvar_sv_vote_stop;
160 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ^1", vote_called_display, "^2 was accepted\n");
162 if ((vote_called == VOTE_MASTER) && vote_caller) vote_caller.vote_master = 1;
163 else localcmd(strcat(vote_called_command, "\n"));
165 if (vote_caller) vote_caller.vote_waittime = 0; // people like your votes, you don't need to wait to vote again
168 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_ACCEPT);
173 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 was rejected\n");
175 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_FAIL);
180 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 timed out\n");
182 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_FAIL);
185 void VoteSpam(float notvoters, float mincount, string result)
188 strcat("\{1}^2* vote results: ^1", ftos(vote_accept_count)),
189 strcat("^2:^1", ftos(vote_reject_count)),
190 ((mincount >= 0) ? strcat("^2 (^1", ftos(mincount), "^2 needed)") : "^2"),
191 strcat(", ^1", ftos(vote_abstain_count), "^2 didn't care"),
192 strcat(", ^1", ftos(notvoters), strcat("^2 didn't ", ((mincount >= 0) ? "" : "have to "), "vote\n"))));
194 if (autocvar_sv_eventlog)
197 strcat(":vote:v", result, ":", ftos(vote_accept_count)),
198 strcat(":", ftos(vote_reject_count)),
199 strcat(":", ftos(vote_abstain_count)),
200 strcat(":", ftos(notvoters)),
201 strcat(":", ftos(mincount))));
205 #define spectators_allowed (!autocvar_sv_vote_nospectators || (autocvar_sv_vote_nospectators == 1 && (warmup_stage || intermission_running)))
207 void VoteCount(float first_count)
210 vote_accept_count = vote_reject_count = vote_abstain_count = 0;
212 float vote_player_count = 0, notvoters = 0;
213 float vote_real_player_count = 0, vote_real_accept_count = 0;
214 float vote_real_reject_count = 0, vote_real_abstain_count = 0;
215 float vote_needed_of_voted, final_needed_votes;
216 float vote_factor_overall, vote_factor_of_voted;
218 Nagger_VoteCountChanged();
220 // add up all the votes from each connected client
221 FOREACH_CLIENT(IS_REAL_CLIENT(it) && IS_CLIENT(it), {
223 if (IS_PLAYER(it)) ++vote_real_player_count;
224 switch (it.vote_selection)
226 case VOTE_SELECT_REJECT:
227 { ++vote_reject_count;
228 { if (IS_PLAYER(it)) ++vote_real_reject_count; } break;
230 case VOTE_SELECT_ACCEPT:
231 { ++vote_accept_count;
232 { if (IS_PLAYER(it)) ++vote_real_accept_count; } break;
234 case VOTE_SELECT_ABSTAIN:
235 { ++vote_abstain_count;
236 { if (IS_PLAYER(it)) ++vote_real_abstain_count; } break;
242 // Check to see if there are enough players on the server to allow master voting... otherwise, vote master could be used for evil.
243 if ((vote_called == VOTE_MASTER) && autocvar_sv_vote_master_playerlimit > vote_player_count)
245 if (vote_caller) vote_caller.vote_waittime = 0;
246 print_to(vote_caller, "^1There are not enough players on this server to allow you to become vote master.");
251 // 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.
252 if (!spectators_allowed && (vote_real_player_count > 0))
254 vote_accept_count = vote_real_accept_count;
255 vote_reject_count = vote_real_reject_count;
256 vote_abstain_count = vote_real_abstain_count;
257 vote_player_count = vote_real_player_count;
260 // people who have no opinion in any way :D
261 notvoters = (vote_player_count - vote_accept_count - vote_reject_count - vote_abstain_count);
263 // determine the goal for the vote to be passed or rejected normally
264 vote_factor_overall = bound(0.5, autocvar_sv_vote_majority_factor, 0.999);
265 vote_needed_overall = floor((vote_player_count - vote_abstain_count) * vote_factor_overall) + 1;
267 // if the vote times out, determine the amount of votes needed of the people who actually already voted
268 vote_factor_of_voted = bound(0.5, autocvar_sv_vote_majority_factor_of_voted, 0.999);
269 vote_needed_of_voted = floor((vote_accept_count + vote_reject_count) * vote_factor_of_voted) + 1;
271 // are there any players at all on the server? it could be an admin vote
272 if (vote_player_count == 0 && first_count)
274 VoteSpam(0, -1, "yes"); // no players at all, just accept it
279 // since there ARE players, finally calculate the result of the vote
280 if (vote_accept_count >= vote_needed_overall)
282 VoteSpam(notvoters, -1, "yes"); // there is enough acceptions to pass the vote
287 if (vote_reject_count > vote_player_count - vote_abstain_count - vote_needed_overall)
289 VoteSpam(notvoters, -1, "no"); // there is enough rejections to deny the vote
294 // there is not enough votes in either direction, now lets just calculate what the voters have said
295 if (time > vote_endtime)
297 final_needed_votes = vote_needed_overall;
299 if (autocvar_sv_vote_majority_factor_of_voted)
301 if (vote_accept_count >= vote_needed_of_voted)
303 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "yes");
308 if (vote_accept_count + vote_reject_count > 0)
310 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "no");
315 final_needed_votes = min(vote_needed_overall, vote_needed_of_voted);
318 // it didn't pass or fail, so not enough votes to even make a decision.
319 VoteSpam(notvoters, final_needed_votes, "timeout");
326 if (vote_endtime > 0) // a vote was called
328 if (time > vote_endtime) // time is up
334 // =======================
335 // Game logic for warmup
336 // =======================
338 // Resets the state of all clients, items, weapons, waypoints, ... of the map.
339 void reset_map(bool dorespawn)
341 if (time <= game_starttime)
345 if (round_handler_IsActive())
346 round_handler_Reset(game_starttime);
349 if (shuffleteams_on_reset_map)
352 shuffleteams_on_reset_map = false;
354 MUTATOR_CALLHOOK(reset_map_global);
356 FOREACH_ENTITY_FLOAT_ORDERED(pure_data, false,
365 if (it.team_saved) it.team = it.team_saved;
366 if (it.flags & FL_PROJECTILE) delete(it); // remove any projectiles left
369 // Waypoints and assault start come LAST
370 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), {
371 if (it.reset2) it.reset2(it);
374 FOREACH_CLIENT(IS_PLAYER(it) && STAT(FROZEN, it), { Unfreeze(it, false); });
376 // Moving the player reset code here since the player-reset depends
377 // on spawnpoint entities which have to be reset first --blub
380 if (!MUTATOR_CALLHOOK(reset_map_players))
382 if (restart_mapalreadyrestarted || (time < game_starttime))
384 FOREACH_CLIENT(IS_PLAYER(it),
387 only reset players if a restart countdown is active
388 this can either be due to cvar sv_ready_restart_after_countdown having set
389 restart_mapalreadyrestarted to 1 after the countdown ended or when
390 sv_ready_restart_after_countdown is not used and countdown is still running
392 // NEW: changed behaviour so that it prevents that previous spectators/observers suddenly spawn as players
393 // PlayerScore_Clear(it);
394 CS(it).killcount = 0;
395 // stop the player from moving so that he stands still once he gets respawned
396 it.velocity = '0 0 0';
397 it.avelocity = '0 0 0';
398 CS(it).movement = '0 0 0';
399 PutClientInServer(it);
406 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
407 void ReadyRestart_think(entity this)
409 restart_mapalreadyrestarted = true;
415 // Forces a restart of the game without actually reloading the map // this is a mess...
416 void ReadyRestart_force()
418 if (time <= game_starttime && game_stopped)
421 bprint("^1Server is restarting...\n");
425 // clear overtime, we have to decrease timelimit to its original value again.
426 if (checkrules_overtimesadded > 0 && g_race_qualifying != 2)
427 cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime)));
428 checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = 0;
430 readyrestart_happened = true;
431 game_starttime = time + RESTART_COUNTDOWN;
433 // clear player attributes
434 FOREACH_CLIENT(IS_PLAYER(it), {
436 CS(it).killcount = 0;
437 float val = PlayerStats_GameReport_Event_Player(it, PLAYERSTATS_ALIVETIME, 0);
438 PlayerStats_GameReport_Event_Player(it, PLAYERSTATS_ALIVETIME, -val);
441 restart_mapalreadyrestarted = false; // reset this var, needed when cvar sv_ready_restart_repeatable is in use
443 // disable the warmup global for the server
445 localcmd("\nsv_hook_warmupend\n");
446 warmup_stage = 0; // once the game is restarted the game is in match stage
448 // reset the .ready status of all players (also spectators)
449 FOREACH_CLIENT(IS_REAL_CLIENT(it), { it.ready = false; });
451 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
453 // lock teams with lockonrestart
454 if (autocvar_teamplay_lockonrestart && teamplay)
457 bprint("^1The teams are now locked.\n");
460 // initiate the restart-countdown-announcer entity
461 if (sv_ready_restart_after_countdown)
463 entity restart_timer = new_pure(restart_timer);
464 setthink(restart_timer, ReadyRestart_think);
465 restart_timer.nextthink = game_starttime;
468 // after a restart every players number of allowed timeouts gets reset, too
469 if (autocvar_sv_timeout)
471 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), { CS(it).allowed_timeouts = autocvar_sv_timeout_number; });
474 if (!sv_ready_restart_after_countdown) reset_map(true);
475 if (autocvar_sv_eventlog) GameLogEcho(":restart");
480 if (MUTATOR_CALLHOOK(ReadyRestart_Deny) || intermission_running || race_completing) localcmd("restart\n");
481 else localcmd("\nsv_hook_readyrestart\n");
483 // Reset ALL scores, but only do that at the beginning of the countdown if sv_ready_restart_after_countdown is off!
484 // Otherwise scores could be manipulated during the countdown.
485 if (!sv_ready_restart_after_countdown) Score_ClearAll();
486 ReadyRestart_force();
489 // Count the players who are ready and determine whether or not to restart the match
492 float ready_needed_factor, ready_needed_count;
493 float t_ready = 0, t_players = 0;
495 FOREACH_CLIENT(IS_REAL_CLIENT(it) && (IS_PLAYER(it) || it.caplayer == 1), {
497 if (it.ready) ++t_ready;
500 readycount = t_ready;
502 Nagger_ReadyCounted();
504 ready_needed_factor = bound(0.5, cvar("g_warmup_majority_factor"), 0.999);
505 ready_needed_count = floor(t_players * ready_needed_factor) + 1;
507 if (readycount >= ready_needed_count) ReadyRestart();
511 // ======================================
512 // Supporting functions for VoteCommand
513 // ======================================
515 float Votecommand_check_assignment(entity caller, float assignment)
517 float from_server = (!caller);
519 if ((assignment == VC_ASGNMNT_BOTH)
520 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
521 || (from_server && assignment == VC_ASGNMNT_SERVERONLY))) return true;
526 string VoteCommand_extractcommand(string input, float startpos, int argc)
530 if ((argc - 1) < startpos) output = "";
531 else output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
536 float VoteCommand_checknasty(string vote_command)
538 if ((strstrofs(vote_command, ";", 0) >= 0)
539 || (strstrofs(vote_command, "\n", 0) >= 0)
540 || (strstrofs(vote_command, "\r", 0) >= 0)
541 || (strstrofs(vote_command, "$", 0) >= 0)) return false;
546 // NOTE: requires input to be surrounded by spaces
547 string VoteCommand_checkreplacements(string input)
549 string output = input;
550 // allow gotomap replacements
551 output = strreplace(" map ", " gotomap ", output);
552 output = strreplace(" chmap ", " gotomap ", output);
556 float VoteCommand_checkinlist(string vote_command, string list)
558 string l = VoteCommand_checkreplacements(strcat(" ", list, " "));
560 if (strstrofs(l, VoteCommand_checkreplacements(strcat(" ", vote_command, " ")), 0) >= 0) return true;
565 string ValidateMap(string validated_map, entity caller)
567 validated_map = MapInfo_FixName(validated_map);
571 print_to(caller, "This map is not available on this server.");
575 if (!autocvar_sv_vote_override_mostrecent && caller)
577 if (Map_IsRecent(validated_map))
579 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
584 if (!MapInfo_CheckMap(validated_map))
586 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
590 return validated_map;
593 float VoteCommand_checkargs(float startpos, int argc)
595 float p, q, check, minargs;
596 string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
597 string cmdrestriction = ""; // No we don't.
598 string charlist, arg;
601 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
602 cmdrestriction = cvar_string(cvarname);
604 LOG_INFO("NOTE: ", cvarname, " does not exist, no restrictions will be applied.");
606 if (cmdrestriction == "") return true;
608 ++startpos; // skip command name
610 // check minimum arg count
612 // 0 args: argc == startpos
613 // 1 args: argc == startpos + 1
616 minargs = stof(cmdrestriction);
617 if (argc - startpos < minargs) return false;
619 p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
623 // we know that at any time, startpos <= argc - minargs
624 // so this means: argc-minargs >= startpos >= argc, thus
625 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
626 // have been seen already
628 if (startpos >= argc) // all args checked? GOOD
631 if (p < 0) // no more args? FAIL
633 // exception: exactly minargs left, this one included
634 if (argc - startpos == minargs) break;
640 // cut to next semicolon
641 q = strstrofs(cmdrestriction, ";", p + 1); // find next semicolon
642 if (q < 0) charlist = substring(cmdrestriction, p + 1, -1);
643 else charlist = substring(cmdrestriction, p + 1, q - (p + 1));
645 // in case we ever want to allow semicolons in VoteCommand_checknasty
646 // charlist = strreplace("^^", ";", charlist);
650 // verify the arg only contains allowed chars
651 arg = argv(startpos);
652 checkmate = strlen(arg);
653 for (check = 0; check < checkmate; ++check)
654 if (strstrofs(charlist, substring(arg, check, 1), 0) < 0) return false;
655 // not allowed character
656 // all characters are allowed. FINE.
667 int VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, int argc)
669 string first_command = argv(startpos);
670 int missing_chars = argv_start_index(startpos);
672 if (autocvar_sv_vote_limit > 0 && strlen(vote_command) > autocvar_sv_vote_limit)
675 if (!VoteCommand_checkinlist(first_command, vote_list)) return 0;
677 if (!VoteCommand_checkargs(startpos, argc)) return 0;
679 switch (MUTATOR_CALLHOOK(VoteCommand_Parse, caller, first_command, vote_command, startpos, argc))
681 case MUT_VOTEPARSE_CONTINUE: { break; }
682 case MUT_VOTEPARSE_SUCCESS: { return 1; }
683 case MUT_VOTEPARSE_INVALID: { return -1; }
684 case MUT_VOTEPARSE_UNACCEPTABLE: { return 0; }
687 switch (first_command) // now go through and parse the proper commands to adjust as needed.
690 case "kickban": // catch all kick/kickban commands
692 entity victim = GetIndexedEntity(argc, (startpos + 1));
693 float accepted = VerifyClientEntity(victim, true, false);
697 string reason = "No reason provided";
698 if(argc > next_token)
699 reason = substring(vote_command, argv_start_index(next_token) - missing_chars, -1);
701 string command_arguments = reason;
702 if (first_command == "kickban")
703 command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
705 vote_parsed_command = strcat(first_command, " # ", ftos(etof(victim)), " ", command_arguments);
706 vote_parsed_display = sprintf("^1%s #%d ^7%s^1 %s", first_command, etof(victim), victim.netname, reason);
708 else { print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n")); return 0; }
715 case "gotomap": // re-direct all map selection commands to gotomap
717 vote_command = ValidateMap(argv(startpos + 1), caller);
718 if (!vote_command) return -1;
719 vote_parsed_command = strcat("gotomap ", vote_command);
720 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
725 // TODO: replicate the old behaviour of being able to vote for maps from different modes on multimode servers (possibly support it in gotomap too)
726 // maybe fallback instead of aborting if map name is invalid?
729 vote_command = ValidateMap(argv(startpos + 1), caller);
730 if (!vote_command) return -1;
731 vote_parsed_command = strcat("nextmap ", vote_command);
732 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
737 case "timelimit": // include restrictions on the maximum votable time limit
739 float timelimit_vote = stof(argv(startpos + 1));
740 if(timelimit_vote > autocvar_timelimit_max || timelimit_vote < autocvar_timelimit_min)
742 print_to(caller, strcat("Invalid timelimit vote, accepted values are between ", ftos(autocvar_timelimit_min), " and ", ftos(autocvar_timelimit_max), "."));
745 timelimit_vote = bound(autocvar_timelimit_min, timelimit_vote, autocvar_timelimit_max);
746 vote_parsed_command = strcat("timelimit ", ftos(timelimit_vote));
747 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
754 // add a delay so that vote result can be seen and announcer can be heard
755 // if the vote is accepted
756 vote_parsed_command = strcat("defer 1 ", vote_command);
757 vote_parsed_display = strzone(strcat("^1", vote_command));
764 vote_parsed_command = vote_command;
765 vote_parsed_display = strzone(strcat("^1", vote_command));
775 // =======================
776 // Command Sub-Functions
777 // =======================
779 void VoteCommand_abstain(int request, entity caller) // CLIENT ONLY
783 case CMD_REQUEST_COMMAND:
785 if (!vote_called) { print_to(caller, "^1No vote called."); }
786 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
788 print_to(caller, "^1You have already voted.");
791 else // everything went okay, continue changing vote
793 print_to(caller, "^1You abstained from your vote.");
794 caller.vote_selection = VOTE_SELECT_ABSTAIN;
796 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
802 case CMD_REQUEST_USAGE:
804 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
805 print_to(caller, " No arguments required.");
811 void VoteCommand_call(int request, entity caller, int argc, string vote_command) // BOTH
815 case CMD_REQUEST_COMMAND:
817 float tmp_playercount = 0;
820 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
822 if (!autocvar_sv_vote_call && caller) { print_to(caller, "^1Vote calling is not allowed."); }
823 else if (!autocvar_sv_vote_gamestart && time < game_starttime)
825 print_to(caller, "^1Vote calling is not allowed before the match has started.");
827 else if (vote_called)
829 print_to(caller, "^1There is already a vote called.");
831 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
833 print_to(caller, "^1Only players can call a vote.");
835 else if (caller && !IS_CLIENT(caller))
837 print_to(caller, "^1Only connected clients can vote.");
839 else if (timeout_status && vote_command != "timein")
841 print_to(caller, "^1You can not call a vote while a timeout is active.");
843 else if (caller && (time < caller.vote_waittime))
845 print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote."));
847 else if (!VoteCommand_checknasty(vote_command))
849 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
851 else if ((parse_error = VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc)) <= 0)
854 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
856 else // everything went okay, continue with calling the vote
858 vote_caller = caller; // remember who called the vote
859 vote_caller_name = strzone(GetCallerName(vote_caller));
860 vote_called = VOTE_NORMAL;
861 vote_called_command = strzone(vote_parsed_command);
862 vote_called_display = strzone(vote_parsed_display);
863 vote_endtime = time + autocvar_sv_vote_timeout;
867 caller.vote_selection = VOTE_SELECT_ACCEPT;
868 caller.vote_waittime = time + autocvar_sv_vote_wait;
872 FOREACH_CLIENT(IS_REAL_CLIENT(it), { ++tmp_playercount; });
874 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote for ", vote_called_display, "\n");
875 if (autocvar_sv_eventlog)
876 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
877 Nagger_VoteChanged();
878 VoteCount(true); // needed if you are the only one
880 if (tmp_playercount > 1 && vote_called != VOTE_NULL)
881 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_CALL);
888 case CMD_REQUEST_USAGE:
890 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call command"));
891 print_to(caller, " Where 'command' is the command to request a vote upon.");
892 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
893 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
899 void VoteCommand_master(int request, entity caller, int argc, string vote_command) // CLIENT ONLY
903 case CMD_REQUEST_COMMAND:
905 if (autocvar_sv_vote_master)
907 switch (strtolower(argv(2)))
912 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
914 if (!caller.vote_master)
915 print_to(caller, "^1You do not have vote master privileges.");
916 else if (!VoteCommand_checknasty(vote_command))
918 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
920 else if ((parse_error = VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc)) <= 0)
923 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
925 else // everything went okay, proceed with command
927 localcmd(strcat(vote_parsed_command, "\n"));
928 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
929 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
930 if (autocvar_sv_eventlog)
931 GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display));
939 if (autocvar_sv_vote_master_password == "") { print_to(caller, "^1Login to vote master is not allowed."); }
940 else if (caller.vote_master)
942 print_to(caller, "^1You are already logged in as vote master.");
944 else if (autocvar_sv_vote_master_password != argv(3))
946 print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller)));
948 else // everything went okay, proceed with giving this player master privilages
950 caller.vote_master = true;
951 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
952 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
953 if (autocvar_sv_eventlog)
954 GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid)));
960 default: // calling a vote for master
962 if (!autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
963 else if (vote_called)
965 print_to(caller, "^1There is already a vote called.");
967 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
969 print_to(caller, "^1Only players can call a vote.");
971 else if (timeout_status)
973 print_to(caller, "^1You can not call a vote while a timeout is active.");
975 else // everything went okay, continue with creating vote
977 vote_caller = caller;
978 vote_caller_name = strzone(GetCallerName(vote_caller));
979 vote_called = VOTE_MASTER;
980 vote_called_command = strzone("XXX");
981 vote_called_display = strzone("^3master");
982 vote_endtime = time + autocvar_sv_vote_timeout;
984 caller.vote_selection = VOTE_SELECT_ACCEPT;
985 caller.vote_waittime = time + autocvar_sv_vote_wait;
987 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote to become ^3master^2.\n");
988 if (autocvar_sv_eventlog)
989 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
990 Nagger_VoteChanged();
991 VoteCount(true); // needed if you are the only one
998 else { print_to(caller, "^1Master control of voting is not allowed."); }
1004 case CMD_REQUEST_USAGE:
1006 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [action [command | password]]"));
1007 print_to(caller, " If action is left blank, it calls a vote for you to become master.");
1008 print_to(caller, " Otherwise the actions are either 'do' a command or 'login' as master.");
1014 void VoteCommand_no(int request, entity caller) // CLIENT ONLY
1018 case CMD_REQUEST_COMMAND:
1020 if (!vote_called) { print_to(caller, "^1No vote called."); }
1021 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1023 print_to(caller, "^1You have already voted.");
1025 else if (((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote)
1030 else // everything went okay, continue changing vote
1032 print_to(caller, "^1You rejected the vote.");
1033 caller.vote_selection = VOTE_SELECT_REJECT;
1034 msg_entity = caller;
1035 if (!autocvar_sv_vote_singlecount)
1043 case CMD_REQUEST_USAGE:
1045 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
1046 print_to(caller, " No arguments required.");
1052 void VoteCommand_status(int request, entity caller) // BOTH
1056 case CMD_REQUEST_COMMAND:
1058 if (vote_called) print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", OriginalCallerName(), "^7."));
1059 else print_to(caller, "^1No vote called.");
1065 case CMD_REQUEST_USAGE:
1067 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
1068 print_to(caller, " No arguments required.");
1074 void VoteCommand_stop(int request, entity caller) // BOTH
1078 case CMD_REQUEST_COMMAND:
1080 if (!vote_called) print_to(caller, "^1No vote called.");
1081 else if ((caller == vote_caller) || !caller || caller.vote_master) VoteStop(caller);
1082 else print_to(caller, "^1You are not allowed to stop that vote.");
1087 case CMD_REQUEST_USAGE:
1089 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
1090 print_to(caller, " No arguments required.");
1096 void VoteCommand_yes(int request, entity caller) // CLIENT ONLY
1100 case CMD_REQUEST_COMMAND:
1102 if (!vote_called) { print_to(caller, "^1No vote called."); }
1103 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1105 print_to(caller, "^1You have already voted.");
1107 else // everything went okay, continue changing vote
1109 print_to(caller, "^1You accepted the vote.");
1110 caller.vote_selection = VOTE_SELECT_ACCEPT;
1111 msg_entity = caller;
1112 if (!autocvar_sv_vote_singlecount)
1120 case CMD_REQUEST_USAGE:
1122 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1123 print_to(caller, " No arguments required.");
1129 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1130 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1131 void VoteCommand_(int request)
1135 case CMD_REQUEST_COMMAND:
1142 case CMD_REQUEST_USAGE:
1144 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1145 print_to(caller, " No arguments required.");
1153 // ================================
1154 // Macro system for vote commands
1155 // ================================
1157 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1158 #define VOTE_COMMANDS(request, caller, arguments, command) \
1159 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1160 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1161 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1162 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1163 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1164 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1165 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1166 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1169 void VoteCommand_macro_help(entity caller, int argc)
1171 string command_origin = GetCommandPrefix(caller);
1173 if (argc == 2 || argv(2) == "help") // help display listing all commands
1175 print_to(caller, "\nVoting commands:\n");
1176 #define VOTE_COMMAND(name, function, description, assignment) \
1177 { if (Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
1179 VOTE_COMMANDS(0, caller, 0, "");
1182 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote COMMAND...^7, where possible commands are listed above.\n"));
1183 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help COMMAND"));
1184 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"));
1186 else // usage for individual command
1188 #define VOTE_COMMAND(name, function, description, assignment) \
1189 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(2))) { function; return; } } }
1191 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
1194 string cvarname = strcat("sv_vote_command_help_", argv(2));
1195 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
1196 wordwrap_sprint(caller, cvar_string(cvarname), 1000);
1198 print_to(caller, "No documentation exists for this vote");
1202 float VoteCommand_macro_command(entity caller, int argc, string vote_command)
1204 #define VOTE_COMMAND(name, function, description, assignment) \
1205 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(1))) { function; return true; } } }
1207 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command);
1214 // ======================================
1215 // Main function handling vote commands
1216 // ======================================
1218 void VoteCommand(int request, entity caller, int argc, string vote_command)
1220 // Guide for working with argc arguments by example:
1221 // argc: 1 - 2 - 3 - 4
1222 // argv: 0 - 1 - 2 - 3
1223 // cmd vote - master - login - password
1227 case CMD_REQUEST_COMMAND:
1229 if (VoteCommand_macro_command(caller, argc, vote_command)) return;
1233 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"));
1234 case CMD_REQUEST_USAGE:
1236 VoteCommand_macro_help(caller, argc);