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/client.qh>
15 #include <server/command/banning.qh>
16 #include <server/command/common.qh>
17 #include <server/command/vote.qh>
18 #include <server/damage.qh>
19 #include <server/gamelog.qh>
20 #include <server/intermission.qh>
21 #include <server/mutators/_mod.qh>
22 #include <server/race.qh>
23 #include <server/round_handler.qh>
24 #include <server/scores.qh>
25 #include <server/teamplay.qh>
26 #include <server/weapons/accuracy.qh>
27 #include <server/world.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.netname, vote_caller.team, 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, bool is_fake_round_start)
341 if (time <= game_starttime)
346 if (!is_fake_round_start)
347 PlayerStats_GameReport_Reset_All();
348 if (round_handler_IsActive())
349 round_handler_Reset(game_starttime);
352 if (shuffleteams_on_reset_map)
355 shuffleteams_on_reset_map = false;
358 FOREACH_CLIENT(true, {
359 if (time <= game_starttime)
360 accuracy_reset(it); // for spectators too because weapon accuracy is persistent
363 if (STAT(FROZEN, it))
365 player_powerups_remove_all(it);
366 entity store = PS(it);
369 Inventory_clear(store.inventory);
370 Inventory_update(store);
374 MUTATOR_CALLHOOK(reset_map_global);
376 FOREACH_ENTITY_FLOAT_ORDERED(pure_data, false,
385 if (it.team_saved) it.team = it.team_saved;
386 if (it.flags & FL_PROJECTILE) delete(it); // remove any projectiles left
389 // Waypoints and assault start come LAST
390 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), {
391 if (it.reset2) it.reset2(it);
394 // Moving the player reset code here since the player-reset depends
395 // on spawnpoint entities which have to be reset first --blub
398 if (!MUTATOR_CALLHOOK(reset_map_players))
400 FOREACH_CLIENT(IS_PLAYER(it),
402 // PlayerScore_Clear(it);
403 CS(it).killcount = 0;
404 // stop the player from moving so that he stands still once he gets respawned
405 it.velocity = '0 0 0';
406 it.avelocity = '0 0 0';
407 CS(it).movement = '0 0 0';
408 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 reset_map(true, false);
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)
428 bprint("^1Match is restarting...\n");
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 = 0;
438 game_starttime = time; // Warmup: No countdown in warmup
440 game_starttime = time + RESTART_COUNTDOWN; // Go into match mode
442 // clear player attributes
443 FOREACH_CLIENT(IS_PLAYER(it), {
445 CS(it).killcount = 0;
448 // if we're ending the warmup stage call the corresponding hook
449 if(!is_fake_round_start && !warmup_stage)
450 localcmd("\nsv_hook_warmupend\n");
452 // reset the .ready status of all players (also spectators)
453 FOREACH_CLIENT(IS_REAL_CLIENT(it), { it.ready = false; });
455 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
457 // lock teams with lockonrestart
458 if (autocvar_teamplay_lockonrestart && teamplay)
459 lockteams = !warmup_stage;
461 // initiate the restart-countdown-announcer entity
462 if (!is_fake_round_start && sv_ready_restart_after_countdown && !warmup_stage)
464 entity restart_timer = new_pure(restart_timer);
465 setthink(restart_timer, ReadyRestart_think);
466 restart_timer.nextthink = game_starttime;
469 // after a restart every players number of allowed timeouts gets reset, too
470 if (autocvar_sv_timeout)
472 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), { CS(it).allowed_timeouts = autocvar_sv_timeout_number; });
475 if (!sv_ready_restart_after_countdown || warmup_stage) reset_map(true, is_fake_round_start);
476 if (autocvar_sv_eventlog) GameLogEcho(":restart");
479 void ReadyRestart(bool forceWarmupEnd)
481 if (MUTATOR_CALLHOOK(ReadyRestart_Deny) || intermission_running || race_completing) localcmd("restart\n");
482 else localcmd("\nsv_hook_readyrestart\n");
484 // Reset ALL scores, but only do that at the beginning of the countdown if sv_ready_restart_after_countdown is off!
485 // Otherwise scores could be manipulated during the countdown.
486 if (!sv_ready_restart_after_countdown) Score_ClearAll();
489 warmup_stage = 0; // forcefully end warmup and go to match stage
491 warmup_stage = cvar("g_warmup"); // go into warmup if it's enabled, otherwise restart into match stage
493 ReadyRestart_force(false);
496 // Count the players who are ready and determine whether or not to restart the match
499 float ready_needed_factor, ready_needed_count;
500 float t_ready = 0, t_players = 0;
502 FOREACH_CLIENT(IS_REAL_CLIENT(it) && (IS_PLAYER(it) || INGAME_JOINED(it)), {
504 if (it.ready) ++t_ready;
507 readycount = t_ready;
509 Nagger_ReadyCounted();
511 ready_needed_factor = bound(0.5, cvar("g_warmup_majority_factor"), 0.999);
512 ready_needed_count = floor(t_players * ready_needed_factor) + 1;
514 if (readycount >= ready_needed_count) ReadyRestart(true);
518 // ======================================
519 // Supporting functions for VoteCommand
520 // ======================================
522 float Votecommand_check_assignment(entity caller, float assignment)
524 float from_server = (!caller);
526 if ((assignment == VC_ASGNMNT_BOTH)
527 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
528 || (from_server && assignment == VC_ASGNMNT_SERVERONLY))) return true;
533 string VoteCommand_extractcommand(string input, float startpos, int argc)
537 if ((argc - 1) < startpos) output = "";
538 else output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
543 float VoteCommand_checknasty(string vote_command)
545 if ((strstrofs(vote_command, ";", 0) >= 0)
546 || (strstrofs(vote_command, "\n", 0) >= 0)
547 || (strstrofs(vote_command, "\r", 0) >= 0)
548 || (strstrofs(vote_command, "$", 0) >= 0)) return false;
553 // NOTE: requires input to be surrounded by spaces
554 string VoteCommand_checkreplacements(string input)
556 string output = input;
557 // allow gotomap replacements
558 output = strreplace(" map ", " gotomap ", output);
559 output = strreplace(" chmap ", " gotomap ", output);
563 float VoteCommand_checkinlist(string vote_command, string list)
565 string l = VoteCommand_checkreplacements(strcat(" ", list, " "));
567 if (strstrofs(l, VoteCommand_checkreplacements(strcat(" ", vote_command, " ")), 0) >= 0) return true;
572 string ValidateMap(string validated_map, entity caller)
574 validated_map = MapInfo_FixName(validated_map);
578 print_to(caller, "This map is not available on this server.");
582 if (!autocvar_sv_vote_override_mostrecent && caller)
584 if (Map_IsRecent(validated_map))
586 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
591 if (!MapInfo_CheckMap(validated_map))
593 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
597 return validated_map;
600 float VoteCommand_checkargs(float startpos, int argc)
602 float p, q, check, minargs;
603 string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
604 string cmdrestriction = ""; // No we don't.
605 string charlist, arg;
608 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
609 cmdrestriction = cvar_string(cvarname);
611 LOG_INFO("NOTE: ", cvarname, " does not exist, no restrictions will be applied.");
613 if (cmdrestriction == "") return true;
615 ++startpos; // skip command name
617 // check minimum arg count
619 // 0 args: argc == startpos
620 // 1 args: argc == startpos + 1
623 minargs = stof(cmdrestriction);
624 if (argc - startpos < minargs) return false;
626 p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
630 // we know that at any time, startpos <= argc - minargs
631 // so this means: argc-minargs >= startpos >= argc, thus
632 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
633 // have been seen already
635 if (startpos >= argc) // all args checked? GOOD
638 if (p < 0) // no more args? FAIL
640 // exception: exactly minargs left, this one included
641 if (argc - startpos == minargs) break;
647 // cut to next semicolon
648 q = strstrofs(cmdrestriction, ";", p + 1); // find next semicolon
649 if (q < 0) charlist = substring(cmdrestriction, p + 1, -1);
650 else charlist = substring(cmdrestriction, p + 1, q - (p + 1));
652 // in case we ever want to allow semicolons in VoteCommand_checknasty
653 // charlist = strreplace("^^", ";", charlist);
657 // verify the arg only contains allowed chars
658 arg = argv(startpos);
659 checkmate = strlen(arg);
660 for (check = 0; check < checkmate; ++check)
661 if (strstrofs(charlist, substring(arg, check, 1), 0) < 0) return false;
662 // not allowed character
663 // all characters are allowed. FINE.
674 int VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, int argc)
676 string first_command = argv(startpos);
677 int missing_chars = argv_start_index(startpos);
679 if (autocvar_sv_vote_limit > 0 && strlen(vote_command) > autocvar_sv_vote_limit)
682 if (!VoteCommand_checkinlist(first_command, vote_list)) return 0;
684 if (!VoteCommand_checkargs(startpos, argc)) return 0;
686 switch (MUTATOR_CALLHOOK(VoteCommand_Parse, caller, first_command, vote_command, startpos, argc))
688 case MUT_VOTEPARSE_CONTINUE: { break; }
689 case MUT_VOTEPARSE_SUCCESS: { return 1; }
690 case MUT_VOTEPARSE_INVALID: { return -1; }
691 case MUT_VOTEPARSE_UNACCEPTABLE: { return 0; }
694 switch (first_command) // now go through and parse the proper commands to adjust as needed.
697 case "kickban": // catch all kick/kickban commands
699 entity victim = GetIndexedEntity(argc, (startpos + 1));
700 float accepted = VerifyClientEntity(victim, true, false);
704 string reason = "No reason provided";
705 if(argc > next_token)
706 reason = substring(vote_command, argv_start_index(next_token) - missing_chars, -1);
708 string command_arguments = reason;
709 if (first_command == "kickban")
710 command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
712 vote_parsed_command = strcat(first_command, " # ", ftos(etof(victim)), " ", command_arguments);
713 vote_parsed_display = sprintf("^1%s #%d ^7%s^1 %s", first_command, etof(victim), victim.netname, reason);
717 print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n"));
726 case "gotomap": // re-direct all map selection commands to gotomap
728 vote_command = ValidateMap(argv(startpos + 1), caller);
729 if (!vote_command) return -1;
730 vote_parsed_command = strcat("gotomap ", vote_command);
731 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
736 // TODO: replicate the old behaviour of being able to vote for maps from different modes on multimode servers (possibly support it in gotomap too)
737 // maybe fallback instead of aborting if map name is invalid?
740 vote_command = ValidateMap(argv(startpos + 1), caller);
741 if (!vote_command) return -1;
742 vote_parsed_command = strcat("nextmap ", vote_command);
743 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
748 case "timelimit": // include restrictions on the maximum votable time limit
750 float timelimit_vote = stof(argv(startpos + 1));
751 if(timelimit_vote > autocvar_timelimit_max || timelimit_vote < autocvar_timelimit_min)
753 print_to(caller, strcat("Invalid timelimit vote, accepted values are between ", ftos(autocvar_timelimit_min), " and ", ftos(autocvar_timelimit_max), "."));
756 timelimit_vote = bound(autocvar_timelimit_min, timelimit_vote, autocvar_timelimit_max);
757 vote_parsed_command = strcat("timelimit ", ftos(timelimit_vote));
758 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
763 case "restart": // re-direct all match restarting to resetmatch
764 vote_command = "resetmatch"; // fall-through
767 vote_parsed_command = vote_command;
768 vote_parsed_display = strzone(strcat("^1", vote_command));
776 print_to(caller, "Game already started. Use the resetmatch command to restart the match.");
780 vote_parsed_command = vote_command;
781 vote_parsed_display = strzone(strcat("^1", vote_command));
787 vote_parsed_command = vote_command;
788 vote_parsed_display = strzone(strcat("^1", vote_command));
798 // =======================
799 // Command Sub-Functions
800 // =======================
802 void VoteCommand_abstain(int request, entity caller) // CLIENT ONLY
806 case CMD_REQUEST_COMMAND:
808 if (!vote_called) { print_to(caller, "^1No vote called."); }
809 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
811 print_to(caller, "^1You have already voted.");
814 else // everything went okay, continue changing vote
816 print_to(caller, "^1You abstained from your vote.");
817 caller.vote_selection = VOTE_SELECT_ABSTAIN;
819 if (!autocvar_sv_vote_singlecount)
827 case CMD_REQUEST_USAGE:
829 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
830 print_to(caller, " No arguments required.");
836 void print_available_commands_to(entity caller)
838 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"));
841 void VoteCommand_call(int request, entity caller, int argc, string vote_command) // BOTH
845 case CMD_REQUEST_COMMAND:
847 float tmp_playercount = 0;
850 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
852 if (!autocvar_sv_vote_call && caller)
854 print_to(caller, "^1Vote calling is not allowed.");
856 else if (!autocvar_sv_vote_gamestart && time < game_starttime)
858 print_to(caller, "^1Vote calling is not allowed before the match has started.");
860 else if (vote_called)
862 print_to(caller, "^1There is already a vote called.");
864 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
866 print_to(caller, "^1Only players can call a vote.");
868 else if (caller && !IS_CLIENT(caller))
870 print_to(caller, "^1Only connected clients can vote.");
872 else if (timeout_status && vote_command != "timein")
874 print_to(caller, "^1You can not call a vote while a timeout is active.");
876 else if (caller && (time < caller.vote_waittime))
878 print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote."));
880 else if (!VoteCommand_checknasty(vote_command))
882 print_to(caller, "^1Syntax error in command.");
884 else if ((parse_error = VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc)) <= 0)
888 if (vote_called_command == "")
889 VoteCommand_call(CMD_REQUEST_USAGE, caller, argc, vote_command);
891 print_to(caller, "^1This command is not acceptable or not available.");
894 else // everything went okay, continue with calling the vote
896 vote_caller = caller; // remember who called the vote
897 vote_caller_name = strzone(GetCallerName(vote_caller));
898 vote_called = VOTE_NORMAL;
899 vote_called_command = strzone(vote_parsed_command);
900 vote_called_display = strzone(vote_parsed_display);
901 vote_endtime = time + autocvar_sv_vote_timeout;
905 caller.vote_selection = VOTE_SELECT_ACCEPT;
906 caller.vote_waittime = time + autocvar_sv_vote_wait;
910 FOREACH_CLIENT(IS_REAL_CLIENT(it), { ++tmp_playercount; });
912 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote for ", vote_called_display, "\n");
913 if (autocvar_sv_eventlog)
914 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
915 Nagger_VoteChanged();
916 VoteCount(true); // needed if you are the only one
918 if (tmp_playercount > 1 && vote_called != VOTE_NULL)
919 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_CALL);
926 case CMD_REQUEST_USAGE:
928 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call <command>"));
929 print_to(caller, " Where <command> is the command to request a vote upon.");
930 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
931 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
932 print_available_commands_to(caller);
933 print_to(caller, "Shortcuts: ^2vcall <command>, vend, vmap, vkick, ...");
939 void VoteCommand_master(int request, entity caller, int argc, string vote_command) // CLIENT ONLY
943 case CMD_REQUEST_COMMAND:
945 if (autocvar_sv_vote_master)
947 switch (strtolower(argv(2)))
952 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
954 if (!caller.vote_master)
955 print_to(caller, "^1You do not have vote master privileges.");
956 else if (!VoteCommand_checknasty(vote_command))
958 print_to(caller, "^1Syntax error in command.");
960 else if ((parse_error = VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc)) <= 0)
964 if (vote_called_command == "")
965 VoteCommand_master(CMD_REQUEST_USAGE, caller, argc, vote_command);
967 print_to(caller, "^1This command is not acceptable or not available.");
970 else // everything went okay, proceed with command
972 localcmd(strcat(vote_parsed_command, "\n"));
973 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
974 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
975 if (autocvar_sv_eventlog)
976 GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display));
984 if (autocvar_sv_vote_master_password == "") { print_to(caller, "^1Login to vote master is not allowed."); }
985 else if (caller.vote_master)
987 print_to(caller, "^1You are already logged in as vote master.");
989 else if (autocvar_sv_vote_master_password != argv(3))
991 print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller)));
993 else // everything went okay, proceed with giving this player master privilages
995 caller.vote_master = true;
996 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
997 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
998 if (autocvar_sv_eventlog)
999 GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid)));
1005 default: // calling a vote for master
1007 if (!autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
1008 else if (vote_called)
1010 print_to(caller, "^1There is already a vote called.");
1012 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
1014 print_to(caller, "^1Only players can call a vote.");
1016 else if (timeout_status)
1018 print_to(caller, "^1You can not call a vote while a timeout is active.");
1020 else // everything went okay, continue with creating vote
1022 vote_caller = caller;
1023 vote_caller_name = strzone(GetCallerName(vote_caller));
1024 vote_called = VOTE_MASTER;
1025 vote_called_command = strzone("XXX");
1026 vote_called_display = strzone("^3master");
1027 vote_endtime = time + autocvar_sv_vote_timeout;
1029 caller.vote_selection = VOTE_SELECT_ACCEPT;
1030 caller.vote_waittime = time + autocvar_sv_vote_wait;
1032 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote to become ^3master^2.\n");
1033 if (autocvar_sv_eventlog)
1034 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
1035 Nagger_VoteChanged();
1036 VoteCount(true); // needed if you are the only one
1043 else { print_to(caller, "^1Master control of voting is not allowed."); }
1049 case CMD_REQUEST_USAGE:
1051 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [<action> [<command> | <password>]]"));
1052 print_to(caller, " If <action> is left blank, it calls a vote for you to become master.");
1053 print_to(caller, " Otherwise it can be either 'do' (to run <command>) or 'login' as master.");
1059 void VoteCommand_no(int request, entity caller) // CLIENT ONLY
1063 case CMD_REQUEST_COMMAND:
1065 if (!vote_called) { print_to(caller, "^1No vote called."); }
1066 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1068 print_to(caller, "^1You have already voted.");
1070 else if (((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote)
1075 else // everything went okay, continue changing vote
1077 print_to(caller, "^1You rejected the vote.");
1078 caller.vote_selection = VOTE_SELECT_REJECT;
1079 msg_entity = caller;
1080 if (!autocvar_sv_vote_singlecount)
1088 case CMD_REQUEST_USAGE:
1090 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
1091 print_to(caller, " No arguments required.");
1097 void VoteCommand_status(int request, entity caller) // BOTH
1101 case CMD_REQUEST_COMMAND:
1103 if (vote_called) print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", OriginalCallerName(), "^7."));
1104 else print_to(caller, "^1No vote called.");
1110 case CMD_REQUEST_USAGE:
1112 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
1113 print_to(caller, " No arguments required.");
1119 void VoteCommand_stop(int request, entity caller) // BOTH
1123 case CMD_REQUEST_COMMAND:
1125 if (!vote_called) print_to(caller, "^1No vote called.");
1126 else if ((caller == vote_caller) || !caller || caller.vote_master) VoteStop(caller);
1127 else print_to(caller, "^1You are not allowed to stop that vote.");
1132 case CMD_REQUEST_USAGE:
1134 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
1135 print_to(caller, " No arguments required.");
1141 void VoteCommand_yes(int request, entity caller) // CLIENT ONLY
1145 case CMD_REQUEST_COMMAND:
1147 if (!vote_called) { print_to(caller, "^1No vote called."); }
1148 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1150 print_to(caller, "^1You have already voted.");
1152 else // everything went okay, continue changing vote
1154 print_to(caller, "^1You accepted the vote.");
1155 caller.vote_selection = VOTE_SELECT_ACCEPT;
1156 msg_entity = caller;
1157 if (!autocvar_sv_vote_singlecount)
1165 case CMD_REQUEST_USAGE:
1167 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1168 print_to(caller, " No arguments required.");
1174 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1175 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1176 void VoteCommand_(int request)
1180 case CMD_REQUEST_COMMAND:
1187 case CMD_REQUEST_USAGE:
1189 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1190 print_to(caller, " No arguments required.");
1198 // ================================
1199 // Macro system for vote commands
1200 // ================================
1202 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1203 #define VOTE_COMMANDS(request, caller, arguments, command) \
1204 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1205 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1206 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1207 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1208 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1209 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1210 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1211 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1214 void VoteCommand_macro_help(entity caller, int argc)
1216 string command_origin = GetCommandPrefix(caller);
1218 if (argc == 2 || argv(2) == "help") // help display listing all commands
1220 print_to(caller, "\nVoting commands:\n");
1221 #define VOTE_COMMAND(name, function, description, assignment) \
1222 { if (Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
1224 VOTE_COMMANDS(0, caller, 0, "");
1227 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote <command>^7, where possible commands are listed above.\n"));
1228 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help <command>"));
1229 print_available_commands_to(caller);
1231 else // usage for individual command
1233 #define VOTE_COMMAND(name, function, description, assignment) \
1234 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(2))) { function; return; } } }
1236 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
1239 string cvarname = strcat("sv_vote_command_help_", argv(2));
1240 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
1241 wordwrap_sprint(caller, cvar_string(cvarname), 1000);
1242 else if (argv(2) != "")
1243 print_to(caller, "No documentation exists for this vote");
1247 float VoteCommand_macro_command(entity caller, int argc, string vote_command)
1249 #define VOTE_COMMAND(name, function, description, assignment) \
1250 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(1))) { function; return true; } } }
1252 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command);
1259 // ======================================
1260 // Main function handling vote commands
1261 // ======================================
1263 void VoteCommand(int request, entity caller, int argc, string vote_command)
1265 // Guide for working with argc arguments by example:
1266 // argc: 1 - 2 - 3 - 4
1267 // argv: 0 - 1 - 2 - 3
1268 // cmd vote - master - login - password
1272 case CMD_REQUEST_COMMAND:
1274 if (VoteCommand_macro_command(caller, argc, vote_command)) return;
1278 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"));
1279 case CMD_REQUEST_USAGE:
1281 VoteCommand_macro_help(caller, argc);