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) && IS_CLIENT(it), {
222 if (IS_PLAYER(it)) ++vote_real_player_count;
223 switch (it.vote_selection)
225 case VOTE_SELECT_REJECT:
226 { ++vote_reject_count;
227 { if (IS_PLAYER(it)) ++vote_real_reject_count; } break;
229 case VOTE_SELECT_ACCEPT:
230 { ++vote_accept_count;
231 { if (IS_PLAYER(it)) ++vote_real_accept_count; } break;
233 case VOTE_SELECT_ABSTAIN:
234 { ++vote_abstain_count;
235 { if (IS_PLAYER(it)) ++vote_real_abstain_count; } break;
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 dorespawn, 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
401 if (!MUTATOR_CALLHOOK(reset_map_players))
403 FOREACH_CLIENT(IS_PLAYER(it),
405 // PlayerScore_Clear(it);
406 CS(it).killcount = 0;
407 // stop the player from moving so that he stands still once he gets respawned
408 it.velocity = '0 0 0';
409 it.avelocity = '0 0 0';
410 CS(it).movement = '0 0 0';
411 PutClientInServer(it);
417 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
418 void ReadyRestart_think(entity this)
420 if (!warmup_stage) // if the countdown was not aborted
421 reset_map(true, false);
425 // Forces a restart of the game without actually reloading the map // this is a mess...
426 void ReadyRestart_force(bool is_fake_round_start)
428 if (time <= game_starttime && game_stopped)
430 if (!is_fake_round_start && !autocvar_g_campaign)
431 Send_Notification(NOTIF_ALL, NULL, MSG_INFO, INFO_COUNTDOWN_RESTART);
435 // clear overtime, we have to decrease timelimit to its original value again.
436 if (checkrules_overtimesadded > 0 && g_race_qualifying != 2)
437 cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime)));
438 checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = overtimes = 0;
441 game_starttime = time; // Warmup: No countdown in warmup
442 else if (autocvar_g_campaign)
443 game_starttime = time + 3;
445 game_starttime = time + RESTART_COUNTDOWN; // Go into match mode
447 // clear player attributes
448 FOREACH_CLIENT(IS_PLAYER(it), {
450 CS(it).killcount = 0;
453 // if we're ending the warmup stage call the corresponding hook
454 if(!is_fake_round_start && !warmup_stage)
455 localcmd("\nsv_hook_warmupend\n");
457 // reset the .ready status of all clients (including spectators and bots)
458 FOREACH_CLIENT(true, { it.ready = false; });
460 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
462 // lock teams with lockonrestart
463 if (autocvar_teamplay_lockonrestart && teamplay)
464 lockteams = !warmup_stage;
466 // initiate the restart-countdown-announcer entity
467 if (!is_fake_round_start && sv_ready_restart_after_countdown && !warmup_stage)
469 entity restart_timer = new_pure(restart_timer);
470 setthink(restart_timer, ReadyRestart_think);
471 restart_timer.nextthink = game_starttime;
474 // after a restart every players number of allowed timeouts gets reset, too
475 if (autocvar_sv_timeout)
477 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), { CS(it).allowed_timeouts = autocvar_sv_timeout_number; });
480 if (!sv_ready_restart_after_countdown || warmup_stage)
481 reset_map(true, is_fake_round_start);
483 if (autocvar_sv_eventlog) GameLogEcho(":restart");
486 void ReadyRestart(bool forceWarmupEnd)
488 if (MUTATOR_CALLHOOK(ReadyRestart_Deny) || intermission_running || race_completing)
490 // NOTE: ReadyRestart support is mandatory in campaign
491 if (autocvar_g_campaign)
492 error("ReadyRestart must be supported in campaign mode!");
493 localcmd("restart\n"); // if ReadyRestart is denied, restart the server
495 else localcmd("\nsv_hook_readyrestart\n");
497 if(forceWarmupEnd || autocvar_g_campaign)
498 warmup_stage = 0; // forcefully end warmup and go to match stage
500 warmup_stage = autocvar_g_warmup; // go into warmup if it's enabled, otherwise restart into match stage
502 ReadyRestart_force(false);
505 /* Count the players who are ready and determine whether or not to restart the match when:
506 * a player presses F4 server/command/cmd.qc ClientCommand_ready()
507 * a player switches from players to specs server/client.qc PutObserverInServer()
508 * a player joins (from specs or directly) server/client.qc PutPlayerInServer()
509 * a player disconnects server/client.qc ClientDisconnect() */
512 // cannot reset the game while a timeout is active or pending
513 if (timeout_status) return;
515 int total_players = 0, human_players = 0, humans_ready = 0;
518 FOREACH_CLIENT(IS_PLAYER(it) || INGAME_JOINED(it), {
520 if (it.ready) ++readycount;
521 if (IS_REAL_CLIENT(it))
524 if (it.ready) ++humans_ready;
528 Nagger_ReadyCounted();
530 // can't read warmup_stage here as it could have been set to 0 by ReadyRestart()
531 // and we need to use this when checking if we should abort the countdown
532 // map_minplayers can only be > 0 if g_warmup was -1 at worldspawn
533 int minplayers = autocvar_g_warmup > 1 ? autocvar_g_warmup : map_minplayers;
535 if (total_players < minplayers)
537 if (game_starttime > time) // someone bailed during countdown, back to warmup
539 warmup_stage = autocvar_g_warmup; // CAN change it AFTER calling Nagger_ReadyCounted() this frame
540 game_starttime = time;
541 Send_Notification(NOTIF_ALL, NULL, MSG_MULTI, COUNTDOWN_STOP, minplayers);
542 if (!sv_ready_restart_after_countdown) // if we ran reset_map() at start of countdown
543 FOREACH_CLIENT(IS_PLAYER(it), { GiveWarmupResources(it); });
545 if (warmup_limit > 0)
547 return; // don't ReadyRestart if players are ready but too few
549 else if (minplayers && warmup_limit <= 0)
551 // there's enough players now but we're still in infinite warmup
552 warmup_limit = cvar("g_warmup_limit");
553 if (warmup_limit == 0)
554 warmup_limit = autocvar_timelimit * 60;
555 if (warmup_limit > 0)
556 game_starttime = time;
557 // implicit else: g_warmup -1 && g_warmup_limit -1 means
558 // warmup continues until enough players AND enough RUPs (no time limit)
561 if (humans_ready && humans_ready >= rint(human_players * bound(0.5, cvar("g_warmup_majority_factor"), 1)))
566 // ======================================
567 // Supporting functions for VoteCommand
568 // ======================================
570 bool Votecommand_check_assignment(entity caller, float assignment)
572 bool from_server = (!caller);
574 if ((assignment == VC_ASGNMNT_BOTH)
575 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
576 || (from_server && assignment == VC_ASGNMNT_SERVERONLY))) return true;
581 string VoteCommand_extractcommand(string input, float startpos, int argc)
585 if ((argc - 1) < startpos) output = "";
586 else output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
591 bool VoteCommand_checknasty(string vote_command)
593 return !((strstrofs(vote_command, ";", 0) >= 0)
594 || (strstrofs(vote_command, "\n", 0) >= 0)
595 || (strstrofs(vote_command, "\r", 0) >= 0)
596 || (strstrofs(vote_command, "$", 0) >= 0));
599 // NOTE: requires input to be surrounded by spaces
600 string VoteCommand_checkreplacements(string input)
602 // add a space around the input so the start and end of the list is captured
603 string output = strcat(" ", input, " ");
604 // allow gotomap replacements
605 output = strreplace(" map ", " gotomap ", output);
606 output = strreplace(" chmap ", " gotomap ", output);
610 bool VoteCommand_checkinlist(string vote_command, string list)
612 if (vote_command == "" || list == "")
615 string l = VoteCommand_checkreplacements(list);
616 return (strstrofs(l, VoteCommand_checkreplacements(vote_command), 0) >= 0);
619 string ValidateMap(string validated_map, entity caller)
621 validated_map = MapInfo_FixName(validated_map);
625 print_to(caller, "This map is not available on this server.");
629 if (!autocvar_sv_vote_override_mostrecent && caller)
631 if (Map_IsRecent(validated_map))
633 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
638 if (!MapInfo_CheckMap(validated_map))
640 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
644 return validated_map;
647 float VoteCommand_checkargs(float startpos, int argc)
649 float p, q, check, minargs;
650 string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
651 string cmdrestriction = ""; // No we don't.
652 string charlist, arg;
655 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
656 cmdrestriction = cvar_string(cvarname);
658 LOG_INFO("NOTE: ", cvarname, " does not exist, no restrictions will be applied.");
660 if (cmdrestriction == "") return true;
662 ++startpos; // skip command name
664 // check minimum arg count
666 // 0 args: argc == startpos
667 // 1 args: argc == startpos + 1
670 minargs = stof(cmdrestriction);
671 if (argc - startpos < minargs) return false;
673 p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
677 // we know that at any time, startpos <= argc - minargs
678 // so this means: argc-minargs >= startpos >= argc, thus
679 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
680 // have been seen already
682 if (startpos >= argc) // all args checked? GOOD
685 if (p < 0) // no more args? FAIL
687 // exception: exactly minargs left, this one included
688 if (argc - startpos == minargs) break;
694 // cut to next semicolon
695 q = strstrofs(cmdrestriction, ";", p + 1); // find next semicolon
696 if (q < 0) charlist = substring(cmdrestriction, p + 1, -1);
697 else charlist = substring(cmdrestriction, p + 1, q - (p + 1));
699 // in case we ever want to allow semicolons in VoteCommand_checknasty
700 // charlist = strreplace("^^", ";", charlist);
704 // verify the arg only contains allowed chars
705 arg = argv(startpos);
706 checkmate = strlen(arg);
707 for (check = 0; check < checkmate; ++check)
708 if (strstrofs(charlist, substring(arg, check, 1), 0) < 0) return false;
709 // not allowed character
710 // all characters are allowed. FINE.
721 int VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, int argc)
723 string first_command = argv(startpos);
724 int missing_chars = argv_start_index(startpos);
726 if (autocvar_sv_vote_limit > 0 && strlen(vote_command) > autocvar_sv_vote_limit)
729 if (!VoteCommand_checkinlist(first_command, vote_list)) return 0;
731 if (!VoteCommand_checkargs(startpos, argc)) return 0;
733 switch (MUTATOR_CALLHOOK(VoteCommand_Parse, caller, first_command, vote_command, startpos, argc))
735 case MUT_VOTEPARSE_CONTINUE: { break; }
736 case MUT_VOTEPARSE_SUCCESS: { return 1; }
737 case MUT_VOTEPARSE_INVALID: { return -1; }
738 case MUT_VOTEPARSE_UNACCEPTABLE: { return 0; }
741 switch (first_command) // now go through and parse the proper commands to adjust as needed.
744 case "kickban": // catch all kick/kickban commands
746 entity victim = GetIndexedEntity(argc, (startpos + 1));
747 float accepted = VerifyClientEntity(victim, true, false);
751 string reason = "No reason provided";
752 if(argc > next_token)
753 reason = substring(vote_command, argv_start_index(next_token) - missing_chars, -1);
755 string command_arguments = reason;
756 if (first_command == "kickban")
757 command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
759 vote_parsed_command = strcat(first_command, " # ", ftos(etof(victim)), " ", command_arguments);
760 vote_parsed_display = sprintf("^1%s #%d ^7%s^1 %s", first_command, etof(victim), victim.netname, reason);
764 print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n"));
773 case "gotomap": // re-direct all map selection commands to gotomap
775 vote_command = ValidateMap(argv(startpos + 1), caller);
776 if (!vote_command) return -1;
777 vote_parsed_command = strcat("gotomap ", vote_command);
778 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
783 // TODO: replicate the old behaviour of being able to vote for maps from different modes on multimode servers (possibly support it in gotomap too)
784 // maybe fallback instead of aborting if map name is invalid?
787 vote_command = ValidateMap(argv(startpos + 1), caller);
788 if (!vote_command) return -1;
789 vote_parsed_command = strcat("nextmap ", vote_command);
790 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
795 case "timelimit": // include restrictions on the maximum votable time limit
797 float timelimit_vote = stof(argv(startpos + 1));
798 if(timelimit_vote > autocvar_timelimit_max || timelimit_vote < autocvar_timelimit_min)
800 print_to(caller, strcat("Invalid timelimit vote, accepted values are between ", ftos(autocvar_timelimit_min), " and ", ftos(autocvar_timelimit_max), "."));
803 timelimit_vote = bound(autocvar_timelimit_min, timelimit_vote, autocvar_timelimit_max);
804 vote_parsed_command = strcat("timelimit ", ftos(timelimit_vote));
805 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
812 // add a delay so that vote result can be seen and announcer can be heard
813 // if the vote is accepted
814 vote_parsed_command = strcat("defer 1 ", vote_command);
815 vote_parsed_display = strzone(strcat("^1", vote_command));
823 print_to(caller, "Game already started. Use the resetmatch command to restart the match.");
827 vote_parsed_command = vote_command;
828 vote_parsed_display = strzone(strcat("^1", vote_command));
834 vote_parsed_command = vote_command;
835 vote_parsed_display = strzone(strcat("^1", vote_command));
845 // =======================
846 // Command Sub-Functions
847 // =======================
849 void VoteCommand_abstain(int request, entity caller) // CLIENT ONLY
853 case CMD_REQUEST_COMMAND:
855 if (!vote_called) { print_to(caller, "^1No vote called."); }
856 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
858 print_to(caller, "^1You have already voted.");
861 else // everything went okay, continue changing vote
863 print_to(caller, "^1You abstained from your vote.");
864 caller.vote_selection = VOTE_SELECT_ABSTAIN;
866 if (!autocvar_sv_vote_singlecount)
874 case CMD_REQUEST_USAGE:
876 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
877 print_to(caller, " No arguments required.");
883 void print_available_commands_to(entity caller)
885 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"));
888 void VoteCommand_call(int request, entity caller, int argc, string vote_command) // BOTH
892 case CMD_REQUEST_COMMAND:
894 float tmp_playercount = 0;
897 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
899 if (!autocvar_sv_vote_call && caller)
901 print_to(caller, "^1Vote calling is not allowed.");
903 else if (!autocvar_sv_vote_gamestart && time < game_starttime)
905 print_to(caller, "^1Vote calling is not allowed before the match has started.");
907 else if (vote_called)
909 print_to(caller, "^1There is already a vote called.");
911 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
913 print_to(caller, "^1Only players can call a vote.");
915 else if (caller && !IS_CLIENT(caller))
917 print_to(caller, "^1Only connected clients can vote.");
919 else if (timeout_status && vote_command != "timein")
921 print_to(caller, "^1You can not call a vote while a timeout is active.");
923 else if (caller && (time < caller.vote_waittime))
925 print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote."));
927 else if (!VoteCommand_checknasty(vote_command))
929 print_to(caller, "^1Syntax error in command.");
931 else if ((parse_error = VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc)) <= 0)
935 if (vote_called_command == "")
936 VoteCommand_call(CMD_REQUEST_USAGE, caller, argc, vote_command);
938 print_to(caller, "^1This command is not acceptable or not available.");
941 else // everything went okay, continue with calling the vote
943 vote_caller = caller; // remember who called the vote
944 vote_caller_name = strzone(GetCallerName(vote_caller));
945 vote_called = VOTE_NORMAL;
946 vote_called_command = strzone(vote_parsed_command);
947 vote_called_display = strzone(vote_parsed_display);
948 vote_endtime = time + autocvar_sv_vote_timeout;
952 caller.vote_selection = VOTE_SELECT_ACCEPT;
953 caller.vote_waittime = time + autocvar_sv_vote_wait;
957 FOREACH_CLIENT(IS_REAL_CLIENT(it), { ++tmp_playercount; });
959 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote for ", vote_called_display, "\n");
960 if (autocvar_sv_eventlog)
961 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
962 Nagger_VoteChanged();
963 VoteCount(true); // needed if you are the only one
965 if (tmp_playercount > 1 && vote_called != VOTE_NULL)
966 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_CALL);
973 case CMD_REQUEST_USAGE:
975 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call <command>"));
976 print_to(caller, " Where <command> is the command to request a vote upon.");
977 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
978 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
979 print_available_commands_to(caller);
980 print_to(caller, "Shortcuts: ^2vcall <command>, vend, vmap, vkick, ...");
986 void VoteCommand_master(int request, entity caller, int argc, string vote_command) // CLIENT ONLY
990 case CMD_REQUEST_COMMAND:
992 if (autocvar_sv_vote_master)
994 switch (strtolower(argv(2)))
999 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
1001 if (!caller.vote_master)
1002 print_to(caller, "^1You do not have vote master privileges.");
1003 else if (!VoteCommand_checknasty(vote_command))
1005 print_to(caller, "^1Syntax error in command.");
1007 else if ((parse_error = VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc)) <= 0)
1009 if(parse_error == 0)
1011 if (vote_called_command == "")
1012 VoteCommand_master(CMD_REQUEST_USAGE, caller, argc, vote_command);
1014 print_to(caller, "^1This command is not acceptable or not available.");
1017 else // everything went okay, proceed with command
1019 localcmd(strcat(vote_parsed_command, "\n"));
1020 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
1021 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
1022 if (autocvar_sv_eventlog)
1023 GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display));
1031 if (autocvar_sv_vote_master_password == "") { print_to(caller, "^1Login to vote master is not allowed."); }
1032 else if (caller.vote_master)
1034 print_to(caller, "^1You are already logged in as vote master.");
1036 else if (autocvar_sv_vote_master_password != argv(3))
1038 print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller)));
1040 else // everything went okay, proceed with giving this player master privilages
1042 caller.vote_master = true;
1043 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
1044 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
1045 if (autocvar_sv_eventlog)
1046 GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid)));
1052 default: // calling a vote for master
1054 if (!autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
1055 else if (vote_called)
1057 print_to(caller, "^1There is already a vote called.");
1059 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
1061 print_to(caller, "^1Only players can call a vote.");
1063 else if (timeout_status)
1065 print_to(caller, "^1You can not call a vote while a timeout is active.");
1067 else // everything went okay, continue with creating vote
1069 vote_caller = caller;
1070 vote_caller_name = strzone(GetCallerName(vote_caller));
1071 vote_called = VOTE_MASTER;
1072 vote_called_command = strzone("XXX");
1073 vote_called_display = strzone("^3master");
1074 vote_endtime = time + autocvar_sv_vote_timeout;
1076 caller.vote_selection = VOTE_SELECT_ACCEPT;
1077 caller.vote_waittime = time + autocvar_sv_vote_wait;
1079 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote to become ^3master^2.\n");
1080 if (autocvar_sv_eventlog)
1081 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
1082 Nagger_VoteChanged();
1083 VoteCount(true); // needed if you are the only one
1090 else { print_to(caller, "^1Master control of voting is not allowed."); }
1096 case CMD_REQUEST_USAGE:
1098 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [<action> [<command> | <password>]]"));
1099 print_to(caller, " If <action> is left blank, it calls a vote for you to become master.");
1100 print_to(caller, " Otherwise it can be either 'do' (to run <command>) or 'login' as master.");
1106 void VoteCommand_no(int request, entity caller) // CLIENT ONLY
1110 case CMD_REQUEST_COMMAND:
1112 if (!vote_called) { print_to(caller, "^1No vote called."); }
1113 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1115 print_to(caller, "^1You have already voted.");
1117 else if (((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote)
1122 else // everything went okay, continue changing vote
1124 print_to(caller, "^1You rejected the vote.");
1125 caller.vote_selection = VOTE_SELECT_REJECT;
1126 msg_entity = caller;
1127 if (!autocvar_sv_vote_singlecount)
1135 case CMD_REQUEST_USAGE:
1137 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
1138 print_to(caller, " No arguments required.");
1144 void VoteCommand_status(int request, entity caller) // BOTH
1148 case CMD_REQUEST_COMMAND:
1150 if (vote_called) print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", OriginalCallerName(), "^7."));
1151 else print_to(caller, "^1No vote called.");
1157 case CMD_REQUEST_USAGE:
1159 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
1160 print_to(caller, " No arguments required.");
1166 void VoteCommand_stop(int request, entity caller) // BOTH
1170 case CMD_REQUEST_COMMAND:
1172 if (!vote_called) print_to(caller, "^1No vote called.");
1173 else if ((caller == vote_caller) || !caller || caller.vote_master) VoteStop(caller);
1174 else print_to(caller, "^1You are not allowed to stop that vote.");
1179 case CMD_REQUEST_USAGE:
1181 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
1182 print_to(caller, " No arguments required.");
1188 void VoteCommand_yes(int request, entity caller) // CLIENT ONLY
1192 case CMD_REQUEST_COMMAND:
1194 if (!vote_called) { print_to(caller, "^1No vote called."); }
1195 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1197 print_to(caller, "^1You have already voted.");
1199 else // everything went okay, continue changing vote
1201 print_to(caller, "^1You accepted the vote.");
1202 caller.vote_selection = VOTE_SELECT_ACCEPT;
1203 msg_entity = caller;
1204 if (!autocvar_sv_vote_singlecount)
1212 case CMD_REQUEST_USAGE:
1214 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1215 print_to(caller, " No arguments required.");
1221 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1222 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1223 void VoteCommand_(int request)
1227 case CMD_REQUEST_COMMAND:
1234 case CMD_REQUEST_USAGE:
1236 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1237 print_to(caller, " No arguments required.");
1245 // ================================
1246 // Macro system for vote commands
1247 // ================================
1249 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1250 #define VOTE_COMMANDS(request, caller, arguments, command) \
1251 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1252 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1253 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1254 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1255 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1256 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1257 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1258 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1261 void VoteCommand_macro_help(entity caller, int argc)
1263 string command_origin = GetCommandPrefix(caller);
1265 if (argc == 2 || argv(2) == "help") // help display listing all commands
1267 print_to(caller, "\nVoting commands:\n");
1268 #define VOTE_COMMAND(name, function, description, assignment) \
1269 { if (Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
1271 VOTE_COMMANDS(0, caller, 0, "");
1274 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote <command>^7, where possible commands are listed above.\n"));
1275 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help <command>"));
1276 print_available_commands_to(caller);
1278 else // usage for individual command
1280 #define VOTE_COMMAND(name, function, description, assignment) \
1281 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(2))) { function; return; } } }
1283 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
1286 string cvarname = strcat("sv_vote_command_help_", argv(2));
1287 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
1288 wordwrap_sprint(caller, cvar_string(cvarname), 1000);
1289 else if (argv(2) != "")
1290 print_to(caller, "No documentation exists for this vote");
1294 float VoteCommand_macro_command(entity caller, int argc, string vote_command)
1296 #define VOTE_COMMAND(name, function, description, assignment) \
1297 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(1))) { function; return true; } } }
1299 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command);
1306 // ======================================
1307 // Main function handling vote commands
1308 // ======================================
1310 void VoteCommand(int request, entity caller, int argc, string vote_command)
1312 // Guide for working with argc arguments by example:
1313 // argc: 1 - 2 - 3 - 4
1314 // argv: 0 - 1 - 2 - 3
1315 // cmd vote - master - login - password
1319 case CMD_REQUEST_COMMAND:
1321 if (VoteCommand_macro_command(caller, argc, vote_command)) return;
1325 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"));
1326 case CMD_REQUEST_USAGE:
1328 VoteCommand_macro_help(caller, argc);