3 #include <common/command/_mod.qh>
4 #include <common/constants.qh>
5 #include <common/gamemodes/_mod.qh>
6 #include <common/items/inventory.qh>
7 #include <common/mapinfo.qh>
8 #include <common/net_linked.qh>
9 #include <common/notifications/all.qh>
10 #include <common/playerstats.qh>
11 #include <common/stats.qh>
12 #include <common/util.qh>
13 #include <common/weapons/_all.qh>
14 #include <server/campaign.qh>
15 #include <server/client.qh>
16 #include <server/command/banning.qh>
17 #include <server/command/common.qh>
18 #include <server/command/vote.qh>
19 #include <server/damage.qh>
20 #include <server/gamelog.qh>
21 #include <server/intermission.qh>
22 #include <server/mutators/_mod.qh>
23 #include <server/race.qh>
24 #include <server/round_handler.qh>
25 #include <server/scores.qh>
26 #include <server/teamplay.qh>
27 #include <server/weapons/accuracy.qh>
28 #include <server/world.qh>
30 // =============================================
31 // Server side voting code, reworked by Samual
32 // Last updated: December 27th, 2011
33 // =============================================
35 // Nagger for players to know status of voting
36 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
56 if (!to.ready) nags |= BIT(1);
64 if (to.vote_selection == 0) nags |= BIT(3);
65 nags |= sendflags & BIT(6);
66 nags |= sendflags & BIT(7);
69 WriteByte(MSG_ENTITY, nags);
73 WriteByte(MSG_ENTITY, vote_accept_count);
74 WriteByte(MSG_ENTITY, vote_reject_count);
75 WriteByte(MSG_ENTITY, vote_needed_overall);
76 WriteChar(MSG_ENTITY, to.vote_selection);
79 if (nags & BIT(7)) WriteString(MSG_ENTITY, vote_called_display);
83 for (int i = 1; i <= maxclients;)
86 for (int b = 0; b < 8 && i <= maxclients; ++b, ++i)
87 if (edict_num(i).ready)
89 WriteByte(MSG_ENTITY, f);
98 Net_LinkEntity(nagger = new_pure(nagger), false, 0, Nagger_SendEntity);
101 void Nagger_VoteChanged()
103 if (nagger) nagger.SendFlags |= BIT(7);
106 void Nagger_VoteCountChanged()
108 if (nagger) nagger.SendFlags |= BIT(6);
111 void Nagger_ReadyCounted()
113 if (nagger) nagger.SendFlags |= BIT(0);
116 // If the vote_caller is still here, return their name, otherwise vote_caller_name
117 string OriginalCallerName()
119 if (IS_REAL_CLIENT(vote_caller)) return playername(vote_caller.netname, vote_caller.team, false);
120 return vote_caller_name;
123 // =======================
124 // Game logic for voting
125 // =======================
129 FOREACH_CLIENT(true, { it.vote_selection = 0; });
133 strfree(vote_called_command);
134 strfree(vote_called_display);
135 strfree(vote_caller_name);
138 vote_called = VOTE_NULL;
142 vote_parsed_command = string_null;
143 vote_parsed_display = string_null;
145 Nagger_VoteChanged();
148 void VoteStop(entity stopper)
150 bprint("\{1}^2* ^3", GetCallerName(stopper), "^2 stopped ^3", OriginalCallerName(), "^2's vote\n");
151 if (autocvar_sv_eventlog) GameLogEcho(strcat(":vote:vstop:", ftos(stopper.playerid)));
152 // Don't force them to wait for next vote, this way they can e.g. correct their vote.
153 if ((vote_caller) && (stopper == vote_caller)) vote_caller.vote_waittime = time + autocvar_sv_vote_stop;
159 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ^1", vote_called_display, "^2 was accepted\n");
161 if ((vote_called == VOTE_MASTER) && vote_caller) vote_caller.vote_master = true;
162 else localcmd(strcat(vote_called_command, "\n"));
164 if (vote_caller) vote_caller.vote_waittime = 0; // people like your votes, you don't need to wait to vote again
167 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_ACCEPT);
172 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 was rejected\n");
174 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_FAIL);
179 bprint("\{1}^2* ^3", OriginalCallerName(), "^2's vote for ", vote_called_display, "^2 timed out\n");
181 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_FAIL);
184 void VoteSpam(float notvoters, float mincount, string result)
187 strcat("\{1}^2* vote results: ^1", ftos(vote_accept_count)),
188 strcat("^2:^1", ftos(vote_reject_count)),
189 ((mincount >= 0) ? strcat("^2 (^1", ftos(mincount), "^2 needed)") : "^2"),
190 strcat(", ^1", ftos(vote_abstain_count), "^2 didn't care"),
191 strcat(", ^1", ftos(notvoters), strcat("^2 didn't ", ((mincount >= 0) ? "" : "have to "), "vote\n"))));
193 if (autocvar_sv_eventlog)
196 strcat(":vote:v", result, ":", ftos(vote_accept_count)),
197 strcat(":", ftos(vote_reject_count)),
198 strcat(":", ftos(vote_abstain_count)),
199 strcat(":", ftos(notvoters)),
200 strcat(":", ftos(mincount))));
204 #define spectators_allowed (!autocvar_sv_vote_nospectators || (autocvar_sv_vote_nospectators == 1 && (warmup_stage || intermission_running)))
206 void VoteCount(float first_count)
209 vote_accept_count = vote_reject_count = vote_abstain_count = 0;
211 float vote_player_count = 0, notvoters = 0;
212 float vote_real_player_count = 0, vote_real_accept_count = 0;
213 float vote_real_reject_count = 0, vote_real_abstain_count = 0;
214 float vote_needed_of_voted, final_needed_votes;
215 float vote_factor_overall, vote_factor_of_voted;
217 Nagger_VoteCountChanged();
219 // add up all the votes from each connected client
220 FOREACH_CLIENT(IS_REAL_CLIENT(it), {
222 if (IS_PLAYER(it) || INGAME(it)) ++vote_real_player_count;
223 switch (it.vote_selection)
225 case VOTE_SELECT_REJECT:
227 if (IS_PLAYER(it) || INGAME(it)) ++vote_real_reject_count;
229 case VOTE_SELECT_ACCEPT:
231 if (IS_PLAYER(it) || INGAME(it)) ++vote_real_accept_count;
233 case VOTE_SELECT_ABSTAIN:
234 ++vote_abstain_count;
235 if (IS_PLAYER(it) || INGAME(it)) ++vote_real_abstain_count;
241 // Check to see if there are enough players on the server to allow master voting... otherwise, vote master could be used for evil.
242 if ((vote_called == VOTE_MASTER) && autocvar_sv_vote_master_playerlimit > vote_player_count)
244 if (vote_caller) vote_caller.vote_waittime = 0;
245 print_to(vote_caller, "^1There are not enough players on this server to allow you to become vote master.");
250 // 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.
251 if (!spectators_allowed && (vote_real_player_count > 0))
253 vote_accept_count = vote_real_accept_count;
254 vote_reject_count = vote_real_reject_count;
255 vote_abstain_count = vote_real_abstain_count;
256 vote_player_count = vote_real_player_count;
259 // people who have no opinion in any way :D
260 notvoters = (vote_player_count - vote_accept_count - vote_reject_count - vote_abstain_count);
262 // determine the goal for the vote to be passed or rejected normally
263 vote_factor_overall = bound(0.5, autocvar_sv_vote_majority_factor, 0.999);
264 vote_needed_overall = floor((vote_player_count - vote_abstain_count) * vote_factor_overall) + 1;
266 // if the vote times out, determine the amount of votes needed of the people who actually already voted
267 vote_factor_of_voted = bound(0.5, autocvar_sv_vote_majority_factor_of_voted, 0.999);
268 vote_needed_of_voted = floor((vote_accept_count + vote_reject_count) * vote_factor_of_voted) + 1;
270 // are there any players at all on the server? it could be an admin vote
271 if (vote_player_count == 0 && first_count)
273 VoteSpam(0, -1, "yes"); // no players at all, just accept it
278 // since there ARE players, finally calculate the result of the vote
279 if (vote_accept_count >= vote_needed_overall)
281 VoteSpam(notvoters, -1, "yes"); // there is enough acceptions to pass the vote
286 if (vote_reject_count > vote_player_count - vote_abstain_count - vote_needed_overall)
288 VoteSpam(notvoters, -1, "no"); // there is enough rejections to deny the vote
293 // there is not enough votes in either direction, now lets just calculate what the voters have said
294 if (time > vote_endtime)
296 final_needed_votes = vote_needed_overall;
298 if (autocvar_sv_vote_majority_factor_of_voted)
300 if (vote_accept_count >= vote_needed_of_voted)
302 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "yes");
307 if (vote_accept_count + vote_reject_count > 0)
309 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "no");
314 final_needed_votes = min(vote_needed_overall, vote_needed_of_voted);
317 // it didn't pass or fail, so not enough votes to even make a decision.
318 VoteSpam(notvoters, final_needed_votes, "timeout");
325 if (vote_endtime > 0) // a vote was called
327 if (time > vote_endtime) // time is up
333 // =======================
334 // Game logic for warmup
335 // =======================
337 // Resets the state of all clients, items, weapons, waypoints, ... of the map.
338 void reset_map(bool is_fake_round_start)
340 if (time <= game_starttime)
345 if (!is_fake_round_start)
348 PlayerStats_GameReport_Reset_All();
351 if (round_handler_IsActive())
352 round_handler_Reset(game_starttime);
355 if (shuffleteams_on_reset_map)
358 shuffleteams_on_reset_map = false;
361 FOREACH_CLIENT(true, {
362 if (time <= game_starttime)
363 accuracy_reset(it); // for spectators too because weapon accuracy is persistent
366 if (STAT(FROZEN, it))
368 player_powerups_remove_all(it);
369 entity store = PS(it);
372 Inventory_clear(store.inventory);
373 Inventory_update(store);
377 MUTATOR_CALLHOOK(reset_map_global);
379 FOREACH_ENTITY_FLOAT_ORDERED(pure_data, false,
388 if (it.team_saved) it.team = it.team_saved;
389 if (it.flags & FL_PROJECTILE) delete(it); // remove any projectiles left
392 // Waypoints and assault start come LAST
393 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), {
394 if (it.reset2) it.reset2(it);
397 // Moving the player reset code here since the player-reset depends
398 // on spawnpoint entities which have to be reset first --blub
399 if (!MUTATOR_CALLHOOK(reset_map_players))
401 FOREACH_CLIENT(IS_PLAYER(it),
403 // PlayerScore_Clear(it);
404 CS(it).killcount = 0;
405 // stop the player from moving so that they stand still once they get respawned
406 it.velocity = '0 0 0';
407 it.avelocity = '0 0 0';
408 CS(it).movement = '0 0 0';
409 PutClientInServer(it);
414 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
415 void ReadyRestart_think(entity this)
417 if (!warmup_stage) // if the countdown was not aborted
422 // Forces a restart of the game without actually reloading the map // this is a mess...
423 void ReadyRestart_force(bool is_fake_round_start)
425 if (time <= game_starttime && game_stopped)
427 if (!is_fake_round_start && !autocvar_g_campaign)
428 Send_Notification(NOTIF_ALL, NULL, MSG_INFO, INFO_COUNTDOWN_RESTART);
432 // clear overtime, we have to decrease timelimit to its original value again.
433 if (checkrules_overtimesadded > 0 && g_race_qualifying != 2)
434 cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime)));
435 checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = overtimes = 0;
438 game_starttime = time; // Warmup: No countdown in warmup
439 else if (autocvar_g_campaign)
440 game_starttime = time + 3;
442 game_starttime = time + RESTART_COUNTDOWN; // Go into match mode
444 // clear player attributes
445 FOREACH_CLIENT(IS_PLAYER(it), {
447 CS(it).killcount = 0;
450 // if we're ending the warmup stage call the corresponding hook
451 if(!is_fake_round_start && !warmup_stage)
452 localcmd("\nsv_hook_warmupend\n");
454 // reset the .ready status of all clients (including spectators and bots)
455 FOREACH_CLIENT(true, { it.ready = false; });
457 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
459 // lock teams with lockonrestart
460 if (autocvar_teamplay_lockonrestart && teamplay)
461 lockteams = !warmup_stage;
463 // initiate the restart-countdown-announcer entity
464 if (!is_fake_round_start && sv_ready_restart_after_countdown && !warmup_stage)
466 entity restart_timer = new_pure(restart_timer);
467 setthink(restart_timer, ReadyRestart_think);
468 restart_timer.nextthink = game_starttime;
471 // after a restart every players number of allowed timeouts gets reset, too
472 if (autocvar_sv_timeout)
474 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), { CS(it).allowed_timeouts = autocvar_sv_timeout_number; });
477 if (!sv_ready_restart_after_countdown || warmup_stage)
478 reset_map(is_fake_round_start);
480 if (autocvar_sv_eventlog) GameLogEcho(":restart");
483 void ReadyRestart(bool forceWarmupEnd)
485 if (MUTATOR_CALLHOOK(ReadyRestart_Deny) || intermission_running || race_completing)
487 // NOTE: ReadyRestart support is mandatory in campaign
488 if (autocvar_g_campaign)
489 error("ReadyRestart must be supported in campaign mode!");
490 localcmd("restart\n"); // if ReadyRestart is denied, restart the server
492 else localcmd("\nsv_hook_readyrestart\n");
494 if(forceWarmupEnd || autocvar_g_campaign)
495 warmup_stage = 0; // forcefully end warmup and go to match stage
497 warmup_stage = autocvar_g_warmup; // go into warmup if it's enabled, otherwise restart into match stage
499 ReadyRestart_force(false);
502 /* Count the players who are ready and determine whether or not to restart the match when:
503 * a player presses F4 server/command/cmd.qc ClientCommand_ready()
504 * a player switches from players to specs server/client.qc PutObserverInServer()
505 * a player joins (from specs or directly) server/client.qc PutPlayerInServer()
506 * a player disconnects server/client.qc ClientDisconnect() */
509 // cannot reset the game while a timeout is active or pending
510 if (timeout_status) return;
512 int total_players = 0, human_players = 0, humans_ready = 0;
515 FOREACH_CLIENT(IS_PLAYER(it) || INGAME_JOINED(it), {
517 if (it.ready) ++readycount;
518 if (IS_REAL_CLIENT(it))
521 if (it.ready) ++humans_ready;
525 Nagger_ReadyCounted();
527 // can't read warmup_stage here as it could have been set to 0 by ReadyRestart()
528 // and we need to use this when checking if we should abort the countdown
529 // map_minplayers can only be > 0 if g_warmup was -1 at worldspawn
530 int minplayers = autocvar_g_warmup > 1 ? autocvar_g_warmup : map_minplayers;
532 if (total_players < minplayers)
534 if (game_starttime > time) // someone bailed during countdown, back to warmup
536 warmup_stage = autocvar_g_warmup; // CAN change it AFTER calling Nagger_ReadyCounted() this frame
537 game_starttime = time;
538 Send_Notification(NOTIF_ALL, NULL, MSG_MULTI, COUNTDOWN_STOP, minplayers);
539 if (!sv_ready_restart_after_countdown) // if we ran reset_map() at start of countdown
540 FOREACH_CLIENT(IS_PLAYER(it), { GiveWarmupResources(it); });
542 if (warmup_limit > 0)
544 return; // don't ReadyRestart if players are ready but too few
546 else if (minplayers && warmup_limit <= 0)
548 // there's enough players now but we're still in infinite warmup
549 warmup_limit = cvar("g_warmup_limit");
550 if (warmup_limit == 0)
551 warmup_limit = autocvar_timelimit * 60;
552 if (warmup_limit > 0)
553 game_starttime = time;
554 // implicit else: g_warmup -1 && g_warmup_limit -1 means
555 // warmup continues until enough players AND enough RUPs (no time limit)
558 if (humans_ready && humans_ready >= rint(human_players * bound(0.5, cvar("g_warmup_majority_factor"), 1)))
563 // ======================================
564 // Supporting functions for VoteCommand
565 // ======================================
567 bool Votecommand_check_assignment(entity caller, float assignment)
569 bool from_server = (!caller);
571 if ((assignment == VC_ASGNMNT_BOTH)
572 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
573 || (from_server && assignment == VC_ASGNMNT_SERVERONLY))) return true;
578 string VoteCommand_extractcommand(string input, float startpos, int argc)
582 if ((argc - 1) < startpos) output = "";
583 else output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
588 bool VoteCommand_checknasty(string vote_command)
590 return !((strstrofs(vote_command, ";", 0) >= 0)
591 || (strstrofs(vote_command, "\n", 0) >= 0)
592 || (strstrofs(vote_command, "\r", 0) >= 0)
593 || (strstrofs(vote_command, "$", 0) >= 0));
596 // NOTE: requires input to be surrounded by spaces
597 string VoteCommand_checkreplacements(string input)
599 // add a space around the input so the start and end of the list is captured
600 string output = strcat(" ", input, " ");
601 // allow gotomap replacements
602 output = strreplace(" map ", " gotomap ", output);
603 output = strreplace(" chmap ", " gotomap ", output);
607 bool VoteCommand_checkinlist(string vote_command, string list)
609 if (vote_command == "" || list == "")
612 string l = VoteCommand_checkreplacements(list);
613 return (strstrofs(l, VoteCommand_checkreplacements(vote_command), 0) >= 0);
616 string ValidateMap(string validated_map, entity caller)
618 validated_map = MapInfo_FixName(validated_map);
622 print_to(caller, "This map is not available on this server.");
626 if (!autocvar_sv_vote_override_mostrecent && caller)
628 if (Map_IsRecent(validated_map))
630 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
635 if (!MapInfo_CheckMap(validated_map))
637 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
641 return validated_map;
644 float VoteCommand_checkargs(float startpos, int argc)
646 float p, q, check, minargs;
647 string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
648 string cmdrestriction = ""; // No we don't.
649 string charlist, arg;
652 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
653 cmdrestriction = cvar_string(cvarname);
655 LOG_INFO("NOTE: ", cvarname, " does not exist, no restrictions will be applied.");
657 if (cmdrestriction == "") return true;
659 ++startpos; // skip command name
661 // check minimum arg count
663 // 0 args: argc == startpos
664 // 1 args: argc == startpos + 1
667 minargs = stof(cmdrestriction);
668 if (argc - startpos < minargs) return false;
670 p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
674 // we know that at any time, startpos <= argc - minargs
675 // so this means: argc-minargs >= startpos >= argc, thus
676 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
677 // have been seen already
679 if (startpos >= argc) // all args checked? GOOD
682 if (p < 0) // no more args? FAIL
684 // exception: exactly minargs left, this one included
685 if (argc - startpos == minargs) break;
691 // cut to next semicolon
692 q = strstrofs(cmdrestriction, ";", p + 1); // find next semicolon
693 if (q < 0) charlist = substring(cmdrestriction, p + 1, -1);
694 else charlist = substring(cmdrestriction, p + 1, q - (p + 1));
696 // in case we ever want to allow semicolons in VoteCommand_checknasty
697 // charlist = strreplace("^^", ";", charlist);
701 // verify the arg only contains allowed chars
702 arg = argv(startpos);
703 checkmate = strlen(arg);
704 for (check = 0; check < checkmate; ++check)
705 if (strstrofs(charlist, substring(arg, check, 1), 0) < 0) return false;
706 // not allowed character
707 // all characters are allowed. FINE.
718 int VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, int argc)
720 string first_command = argv(startpos);
721 int missing_chars = argv_start_index(startpos);
723 if (autocvar_sv_vote_limit > 0 && strlen(vote_command) > autocvar_sv_vote_limit)
726 if (!VoteCommand_checkinlist(first_command, vote_list)) return 0;
728 if (!VoteCommand_checkargs(startpos, argc)) return 0;
730 switch (MUTATOR_CALLHOOK(VoteCommand_Parse, caller, first_command, vote_command, startpos, argc))
732 case MUT_VOTEPARSE_CONTINUE: { break; }
733 case MUT_VOTEPARSE_SUCCESS: { return 1; }
734 case MUT_VOTEPARSE_INVALID: { return -1; }
735 case MUT_VOTEPARSE_UNACCEPTABLE: { return 0; }
738 switch (first_command) // now go through and parse the proper commands to adjust as needed.
741 case "kickban": // catch all kick/kickban commands
743 entity victim = GetIndexedEntity(argc, (startpos + 1));
744 float accepted = VerifyClientEntity(victim, true, false);
748 string reason = "No reason provided";
749 if(argc > next_token)
750 reason = substring(vote_command, argv_start_index(next_token) - missing_chars, -1);
752 string command_arguments = reason;
753 if (first_command == "kickban")
754 command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
756 vote_parsed_command = strcat(first_command, " # ", ftos(etof(victim)), " ", command_arguments);
757 vote_parsed_display = sprintf("^1%s #%d ^7%s^1 %s", first_command, etof(victim), victim.netname, reason);
761 print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n"));
770 case "gotomap": // re-direct all map selection commands to gotomap
772 vote_command = ValidateMap(argv(startpos + 1), caller);
773 if (!vote_command) return -1;
774 vote_parsed_command = strcat("gotomap ", vote_command);
775 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
780 // TODO: replicate the old behaviour of being able to vote for maps from different modes on multimode servers (possibly support it in gotomap too)
781 // maybe fallback instead of aborting if map name is invalid?
784 vote_command = ValidateMap(argv(startpos + 1), caller);
785 if (!vote_command) return -1;
786 vote_parsed_command = strcat("nextmap ", vote_command);
787 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
792 case "timelimit": // include restrictions on the maximum votable time limit
794 float timelimit_vote = stof(argv(startpos + 1));
795 if(timelimit_vote > autocvar_timelimit_max || timelimit_vote < autocvar_timelimit_min)
797 print_to(caller, strcat("Invalid timelimit vote, accepted values are between ", ftos(autocvar_timelimit_min), " and ", ftos(autocvar_timelimit_max), "."));
800 timelimit_vote = bound(autocvar_timelimit_min, timelimit_vote, autocvar_timelimit_max);
801 vote_parsed_command = strcat("timelimit ", ftos(timelimit_vote));
802 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
809 // add a delay so that vote result can be seen and announcer can be heard
810 // if the vote is accepted
811 vote_parsed_command = strcat("defer 1 ", vote_command);
812 vote_parsed_display = strzone(strcat("^1", vote_command));
820 print_to(caller, "Game already started. Use the resetmatch command to restart the match.");
824 vote_parsed_command = vote_command;
825 vote_parsed_display = strzone(strcat("^1", vote_command));
831 vote_parsed_command = vote_command;
832 vote_parsed_display = strzone(strcat("^1", vote_command));
842 // =======================
843 // Command Sub-Functions
844 // =======================
846 void VoteCommand_abstain(int request, entity caller) // CLIENT ONLY
850 case CMD_REQUEST_COMMAND:
852 if (!vote_called) { print_to(caller, "^1No vote called."); }
853 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
855 print_to(caller, "^1You have already voted.");
858 else // everything went okay, continue changing vote
860 print_to(caller, "^1You abstained from your vote.");
861 caller.vote_selection = VOTE_SELECT_ABSTAIN;
863 if (!autocvar_sv_vote_singlecount)
871 case CMD_REQUEST_USAGE:
873 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
874 print_to(caller, " No arguments required.");
880 void print_available_commands_to(entity caller)
882 print_to(caller, strcat("You can call a vote for or execute these commands: ^3", autocvar_sv_vote_commands, "^7 and maybe further ^3arguments^7"));
885 void VoteCommand_call(int request, entity caller, int argc, string vote_command) // BOTH
889 case CMD_REQUEST_COMMAND:
891 float tmp_playercount = 0;
894 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
896 if (!autocvar_sv_vote_call && caller)
898 print_to(caller, "^1Vote calling is not allowed.");
900 else if (!autocvar_sv_vote_gamestart && time < game_starttime)
902 print_to(caller, "^1Vote calling is not allowed before the match has started.");
904 else if (vote_called)
906 print_to(caller, "^1There is already a vote called.");
908 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
910 print_to(caller, "^1Only players can call a vote.");
912 else if (caller && !IS_CLIENT(caller))
914 print_to(caller, "^1Only connected clients can vote.");
916 else if (timeout_status && vote_command != "timein")
918 print_to(caller, "^1You can not call a vote while a timeout is active.");
920 else if (caller && (time < caller.vote_waittime))
922 print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote."));
924 else if (!VoteCommand_checknasty(vote_command))
926 print_to(caller, "^1Syntax error in command.");
928 else if ((parse_error = VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc)) <= 0)
932 if (vote_called_command == "")
933 VoteCommand_call(CMD_REQUEST_USAGE, caller, argc, vote_command);
935 print_to(caller, "^1This command is not acceptable or not available.");
938 else // everything went okay, continue with calling the vote
940 vote_caller = caller; // remember who called the vote
941 vote_caller_name = strzone(GetCallerName(vote_caller));
942 vote_called = VOTE_NORMAL;
943 vote_called_command = strzone(vote_parsed_command);
944 vote_called_display = strzone(vote_parsed_display);
945 vote_endtime = time + autocvar_sv_vote_timeout;
949 caller.vote_selection = VOTE_SELECT_ACCEPT;
950 caller.vote_waittime = time + autocvar_sv_vote_wait;
954 FOREACH_CLIENT(IS_REAL_CLIENT(it), { ++tmp_playercount; });
956 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote for ", vote_called_display, "\n");
957 if (autocvar_sv_eventlog)
958 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
959 Nagger_VoteChanged();
960 VoteCount(true); // needed if you are the only one
962 if (tmp_playercount > 1 && vote_called != VOTE_NULL)
963 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_CALL);
970 case CMD_REQUEST_USAGE:
972 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call <command>"));
973 print_to(caller, " Where <command> is the command to request a vote upon.");
974 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
975 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
976 print_available_commands_to(caller);
977 print_to(caller, "Shortcuts: ^2vcall <command>, vend, vmap, vkick, ...");
983 void VoteCommand_master(int request, entity caller, int argc, string vote_command) // CLIENT ONLY
987 case CMD_REQUEST_COMMAND:
989 if (autocvar_sv_vote_master)
991 switch (strtolower(argv(2)))
996 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
998 if (!caller.vote_master)
999 print_to(caller, "^1You do not have vote master privileges.");
1000 else if (!VoteCommand_checknasty(vote_command))
1002 print_to(caller, "^1Syntax error in command.");
1004 else if ((parse_error = VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc)) <= 0)
1006 if(parse_error == 0)
1008 if (vote_called_command == "")
1009 VoteCommand_master(CMD_REQUEST_USAGE, caller, argc, vote_command);
1011 print_to(caller, "^1This command is not acceptable or not available.");
1014 else // everything went okay, proceed with command
1016 localcmd(strcat(vote_parsed_command, "\n"));
1017 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
1018 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
1019 if (autocvar_sv_eventlog)
1020 GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display));
1028 if (autocvar_sv_vote_master_password == "") { print_to(caller, "^1Login to vote master is not allowed."); }
1029 else if (caller.vote_master)
1031 print_to(caller, "^1You are already logged in as vote master.");
1033 else if (autocvar_sv_vote_master_password != argv(3))
1035 print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller)));
1037 else // everything went okay, proceed with giving this player master privilages
1039 caller.vote_master = true;
1040 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
1041 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
1042 if (autocvar_sv_eventlog)
1043 GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid)));
1049 default: // calling a vote for master
1051 if (!autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
1052 else if (vote_called)
1054 print_to(caller, "^1There is already a vote called.");
1056 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
1058 print_to(caller, "^1Only players can call a vote.");
1060 else if (timeout_status)
1062 print_to(caller, "^1You can not call a vote while a timeout is active.");
1064 else // everything went okay, continue with creating vote
1066 vote_caller = caller;
1067 vote_caller_name = strzone(GetCallerName(vote_caller));
1068 vote_called = VOTE_MASTER;
1069 vote_called_command = strzone("XXX");
1070 vote_called_display = strzone("^3master");
1071 vote_endtime = time + autocvar_sv_vote_timeout;
1073 caller.vote_selection = VOTE_SELECT_ACCEPT;
1074 caller.vote_waittime = time + autocvar_sv_vote_wait;
1076 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote to become ^3master^2.\n");
1077 if (autocvar_sv_eventlog)
1078 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
1079 Nagger_VoteChanged();
1080 VoteCount(true); // needed if you are the only one
1087 else { print_to(caller, "^1Master control of voting is not allowed."); }
1093 case CMD_REQUEST_USAGE:
1095 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [<action> [<command> | <password>]]"));
1096 print_to(caller, " If <action> is left blank, it calls a vote for you to become master.");
1097 print_to(caller, " Otherwise it can be either 'do' (to run <command>) or 'login' as master.");
1103 void VoteCommand_no(int request, entity caller) // CLIENT ONLY
1107 case CMD_REQUEST_COMMAND:
1109 if (!vote_called) { print_to(caller, "^1No vote called."); }
1110 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1112 print_to(caller, "^1You have already voted.");
1114 else if (((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote)
1119 else // everything went okay, continue changing vote
1121 print_to(caller, "^1You rejected the vote.");
1122 caller.vote_selection = VOTE_SELECT_REJECT;
1123 msg_entity = caller;
1124 if (!autocvar_sv_vote_singlecount)
1132 case CMD_REQUEST_USAGE:
1134 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
1135 print_to(caller, " No arguments required.");
1141 void VoteCommand_status(int request, entity caller) // BOTH
1145 case CMD_REQUEST_COMMAND:
1147 if (vote_called) print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", OriginalCallerName(), "^7."));
1148 else print_to(caller, "^1No vote called.");
1154 case CMD_REQUEST_USAGE:
1156 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
1157 print_to(caller, " No arguments required.");
1163 void VoteCommand_stop(int request, entity caller) // BOTH
1167 case CMD_REQUEST_COMMAND:
1169 if (!vote_called) print_to(caller, "^1No vote called.");
1170 else if ((caller == vote_caller) || !caller || caller.vote_master) VoteStop(caller);
1171 else print_to(caller, "^1You are not allowed to stop that vote.");
1176 case CMD_REQUEST_USAGE:
1178 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
1179 print_to(caller, " No arguments required.");
1185 void VoteCommand_yes(int request, entity caller) // CLIENT ONLY
1189 case CMD_REQUEST_COMMAND:
1191 if (!vote_called) { print_to(caller, "^1No vote called."); }
1192 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1194 print_to(caller, "^1You have already voted.");
1196 else // everything went okay, continue changing vote
1198 print_to(caller, "^1You accepted the vote.");
1199 caller.vote_selection = VOTE_SELECT_ACCEPT;
1200 msg_entity = caller;
1201 if (!autocvar_sv_vote_singlecount)
1209 case CMD_REQUEST_USAGE:
1211 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1212 print_to(caller, " No arguments required.");
1218 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1219 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1220 void VoteCommand_(int request)
1224 case CMD_REQUEST_COMMAND:
1231 case CMD_REQUEST_USAGE:
1233 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1234 print_to(caller, " No arguments required.");
1242 // ================================
1243 // Macro system for vote commands
1244 // ================================
1246 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1247 #define VOTE_COMMANDS(request, caller, arguments, command) \
1248 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1249 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1250 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1251 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1252 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1253 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1254 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1255 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1258 void VoteCommand_macro_help(entity caller, int argc)
1260 string command_origin = GetCommandPrefix(caller);
1262 if (argc == 2 || argv(2) == "help") // help display listing all commands
1264 print_to(caller, "\nVoting commands:\n");
1265 #define VOTE_COMMAND(name, function, description, assignment) \
1266 { if (Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
1268 VOTE_COMMANDS(0, caller, 0, "");
1271 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote <command>^7, where possible commands are listed above.\n"));
1272 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help <command>"));
1273 print_available_commands_to(caller);
1275 else // usage for individual command
1277 #define VOTE_COMMAND(name, function, description, assignment) \
1278 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(2))) { function; return; } } }
1280 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
1283 string cvarname = strcat("sv_vote_command_help_", argv(2));
1284 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
1285 wordwrap_sprint(caller, cvar_string(cvarname), 1000);
1286 else if (argv(2) != "")
1287 print_to(caller, "No documentation exists for this vote");
1291 float VoteCommand_macro_command(entity caller, int argc, string vote_command)
1293 #define VOTE_COMMAND(name, function, description, assignment) \
1294 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(1))) { function; return true; } } }
1296 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command);
1303 // ======================================
1304 // Main function handling vote commands
1305 // ======================================
1307 void VoteCommand(int request, entity caller, int argc, string vote_command)
1309 // Guide for working with argc arguments by example:
1310 // argc: 1 - 2 - 3 - 4
1311 // argv: 0 - 1 - 2 - 3
1312 // cmd vote - master - login - password
1316 case CMD_REQUEST_COMMAND:
1318 if (VoteCommand_macro_command(caller, argc, vote_command)) return;
1322 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"));
1323 case CMD_REQUEST_USAGE:
1325 VoteCommand_macro_help(caller, argc);