3 #include <server/defs.qh>
4 #include <server/miscfunctions.qh>
6 #include <common/command/_mod.qh>
11 #include "../g_damage.qh"
12 #include "../g_world.qh"
13 #include "../teamplay.qh"
15 #include "../round_handler.qh"
16 #include "../scores.qh"
18 #include <server/mutators/_mod.qh>
19 #include <common/gamemodes/_mod.qh>
21 #include <common/constants.qh>
22 #include <common/net_linked.qh>
23 #include <common/mapinfo.qh>
24 #include <common/notifications/all.qh>
25 #include <common/playerstats.qh>
26 #include <common/util.qh>
28 // =============================================
29 // Server side voting code, reworked by Samual
30 // Last updated: December 27th, 2011
31 // =============================================
33 // Nagger for players to know status of voting
34 bool Nagger_SendEntity(entity this, entity to, float sendflags)
38 WriteHeader(MSG_ENTITY, ENT_CLIENT_NAGGER);
42 // 2 = player needs to ready up
44 // 8 = player needs to vote
54 if (to.ready == 0) nags |= BIT(1);
59 if (to.vote_selection == 0) nags |= BIT(3);
61 if (warmup_stage) nags |= BIT(4);
63 if (sendflags & BIT(6)) nags |= BIT(6);
65 if (sendflags & BIT(7)) nags |= BIT(7);
67 if (!(nags & 4)) // no vote called? send no string
68 nags &= ~(BIT(6) | BIT(7));
70 WriteByte(MSG_ENTITY, nags);
74 WriteByte(MSG_ENTITY, vote_accept_count);
75 WriteByte(MSG_ENTITY, vote_reject_count);
76 WriteByte(MSG_ENTITY, vote_needed_overall);
77 WriteChar(MSG_ENTITY, to.vote_selection);
80 if (nags & BIT(7)) WriteString(MSG_ENTITY, vote_called_display);
84 for (i = 1; i <= maxclients; i += 8)
86 for (f = 0, e = edict_num(i), b = BIT(0); b < BIT(8); b <<= 1, e = nextent(e))
87 if (!IS_REAL_CLIENT(e) || e.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, 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 = 1;
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)
340 if (time <= game_starttime)
344 if (round_handler_IsActive())
345 round_handler_Reset(game_starttime);
348 if (shuffleteams_on_reset_map)
351 shuffleteams_on_reset_map = false;
353 MUTATOR_CALLHOOK(reset_map_global);
355 FOREACH_ENTITY_FLOAT_ORDERED(pure_data, false,
364 if (it.team_saved) it.team = it.team_saved;
365 if (it.flags & FL_PROJECTILE) delete(it); // remove any projectiles left
368 // Waypoints and assault start come LAST
369 FOREACH_ENTITY_ORDERED(IS_NOT_A_CLIENT(it), {
370 if (it.reset2) it.reset2(it);
373 FOREACH_CLIENT(IS_PLAYER(it) && STAT(FROZEN, it), { Unfreeze(it, false); });
375 // Moving the player reset code here since the player-reset depends
376 // on spawnpoint entities which have to be reset first --blub
379 if (!MUTATOR_CALLHOOK(reset_map_players))
381 if (restart_mapalreadyrestarted || (time < game_starttime))
383 FOREACH_CLIENT(IS_PLAYER(it),
386 only reset players if a restart countdown is active
387 this can either be due to cvar sv_ready_restart_after_countdown having set
388 restart_mapalreadyrestarted to 1 after the countdown ended or when
389 sv_ready_restart_after_countdown is not used and countdown is still running
391 // NEW: changed behaviour so that it prevents that previous spectators/observers suddenly spawn as players
392 // PlayerScore_Clear(it);
393 CS(it).killcount = 0;
394 // stop the player from moving so that he stands still once he gets respawned
395 it.velocity = '0 0 0';
396 it.avelocity = '0 0 0';
397 CS(it).movement = '0 0 0';
398 PutClientInServer(it);
405 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
406 void ReadyRestart_think(entity this)
408 restart_mapalreadyrestarted = true;
414 // Forces a restart of the game without actually reloading the map // this is a mess...
415 void ReadyRestart_force()
417 if (time <= game_starttime && game_stopped)
420 bprint("^1Server is restarting...\n");
424 // clear overtime, we have to decrease timelimit to its original value again.
425 if (checkrules_overtimesadded > 0 && g_race_qualifying != 2)
426 cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime)));
427 checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = 0;
429 readyrestart_happened = true;
430 game_starttime = time + RESTART_COUNTDOWN;
432 // clear player attributes
433 FOREACH_CLIENT(IS_PLAYER(it), {
435 CS(it).killcount = 0;
436 float val = PlayerStats_GameReport_Event_Player(it, PLAYERSTATS_ALIVETIME, 0);
437 PlayerStats_GameReport_Event_Player(it, PLAYERSTATS_ALIVETIME, -val);
440 restart_mapalreadyrestarted = false; // reset this var, needed when cvar sv_ready_restart_repeatable is in use
442 // disable the warmup global for the server
443 warmup_stage = 0; // once the game is restarted the game is in match stage
445 // reset the .ready status of all players (also spectators)
446 FOREACH_CLIENT(IS_REAL_CLIENT(it), { it.ready = false; });
448 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
450 // lock teams with lockonrestart
451 if (autocvar_teamplay_lockonrestart && teamplay)
454 bprint("^1The teams are now locked.\n");
457 // initiate the restart-countdown-announcer entity
458 if (sv_ready_restart_after_countdown)
460 entity restart_timer = new_pure(restart_timer);
461 setthink(restart_timer, ReadyRestart_think);
462 restart_timer.nextthink = game_starttime;
465 // after a restart every players number of allowed timeouts gets reset, too
466 if (autocvar_sv_timeout)
468 FOREACH_CLIENT(IS_PLAYER(it) && IS_REAL_CLIENT(it), { CS(it).allowed_timeouts = autocvar_sv_timeout_number; });
471 if (!sv_ready_restart_after_countdown) reset_map(true);
472 if (autocvar_sv_eventlog) GameLogEcho(":restart");
477 if (MUTATOR_CALLHOOK(ReadyRestart_Deny) || game_stopped || race_completing) localcmd("restart\n");
478 else localcmd("\nsv_hook_gamerestart\n");
480 // Reset ALL scores, but only do that at the beginning of the countdown if sv_ready_restart_after_countdown is off!
481 // Otherwise scores could be manipulated during the countdown.
482 if (!sv_ready_restart_after_countdown) Score_ClearAll();
483 ReadyRestart_force();
486 // Count the players who are ready and determine whether or not to restart the match
489 float ready_needed_factor, ready_needed_count;
490 float t_ready = 0, t_players = 0;
492 FOREACH_CLIENT(IS_REAL_CLIENT(it) && (IS_PLAYER(it) || it.caplayer == 1), {
494 if (it.ready) ++t_ready;
497 readycount = t_ready;
499 Nagger_ReadyCounted();
501 ready_needed_factor = bound(0.5, cvar("g_warmup_majority_factor"), 0.999);
502 ready_needed_count = floor(t_players * ready_needed_factor) + 1;
504 if (readycount >= ready_needed_count) ReadyRestart();
508 // ======================================
509 // Supporting functions for VoteCommand
510 // ======================================
512 float Votecommand_check_assignment(entity caller, float assignment)
514 float from_server = (!caller);
516 if ((assignment == VC_ASGNMNT_BOTH)
517 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
518 || (from_server && assignment == VC_ASGNMNT_SERVERONLY))) return true;
523 string VoteCommand_extractcommand(string input, float startpos, int argc)
527 if ((argc - 1) < startpos) output = "";
528 else output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
533 float VoteCommand_checknasty(string vote_command)
535 if ((strstrofs(vote_command, ";", 0) >= 0)
536 || (strstrofs(vote_command, "\n", 0) >= 0)
537 || (strstrofs(vote_command, "\r", 0) >= 0)
538 || (strstrofs(vote_command, "$", 0) >= 0)) return false;
543 float VoteCommand_checkinlist(string vote_command, string list)
545 string l = strcat(" ", list, " ");
547 if (strstrofs(l, strcat(" ", vote_command, " "), 0) >= 0) return true;
552 string ValidateMap(string validated_map, entity caller)
554 validated_map = MapInfo_FixName(validated_map);
558 print_to(caller, "This map is not available on this server.");
562 if (!autocvar_sv_vote_override_mostrecent && caller)
564 if (Map_IsRecent(validated_map))
566 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
571 if (!MapInfo_CheckMap(validated_map))
573 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
577 return validated_map;
580 float VoteCommand_checkargs(float startpos, int argc)
582 float p, q, check, minargs;
583 string cvarname = strcat("sv_vote_command_restriction_", argv(startpos));
584 string cmdrestriction = ""; // No we don't.
585 string charlist, arg;
588 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
589 cmdrestriction = cvar_string(cvarname);
591 LOG_INFO("NOTE: ", cvarname, " does not exist, no restrictions will be applied.");
593 if (cmdrestriction == "") return true;
595 ++startpos; // skip command name
597 // check minimum arg count
599 // 0 args: argc == startpos
600 // 1 args: argc == startpos + 1
603 minargs = stof(cmdrestriction);
604 if (argc - startpos < minargs) return false;
606 p = strstrofs(cmdrestriction, ";", 0); // find first semicolon
610 // we know that at any time, startpos <= argc - minargs
611 // so this means: argc-minargs >= startpos >= argc, thus
612 // argc-minargs >= argc, thus minargs <= 0, thus all minargs
613 // have been seen already
615 if (startpos >= argc) // all args checked? GOOD
618 if (p < 0) // no more args? FAIL
620 // exception: exactly minargs left, this one included
621 if (argc - startpos == minargs) break;
627 // cut to next semicolon
628 q = strstrofs(cmdrestriction, ";", p + 1); // find next semicolon
629 if (q < 0) charlist = substring(cmdrestriction, p + 1, -1);
630 else charlist = substring(cmdrestriction, p + 1, q - (p + 1));
632 // in case we ever want to allow semicolons in VoteCommand_checknasty
633 // charlist = strreplace("^^", ";", charlist);
637 // verify the arg only contains allowed chars
638 arg = argv(startpos);
639 checkmate = strlen(arg);
640 for (check = 0; check < checkmate; ++check)
641 if (strstrofs(charlist, substring(arg, check, 1), 0) < 0) return false;
642 // not allowed character
643 // all characters are allowed. FINE.
654 int VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, int argc)
656 string first_command = argv(startpos);
657 int missing_chars = argv_start_index(startpos);
659 if (autocvar_sv_vote_limit > 0 && strlen(vote_command) > autocvar_sv_vote_limit)
662 if (!VoteCommand_checkinlist(first_command, vote_list)) return 0;
664 if (!VoteCommand_checkargs(startpos, argc)) return 0;
666 switch (MUTATOR_CALLHOOK(VoteCommand_Parse, caller, first_command, vote_command, startpos, argc))
668 case MUT_VOTEPARSE_CONTINUE: { break; }
669 case MUT_VOTEPARSE_SUCCESS: { return 1; }
670 case MUT_VOTEPARSE_INVALID: { return -1; }
671 case MUT_VOTEPARSE_UNACCEPTABLE: { return 0; }
674 switch (first_command) // now go through and parse the proper commands to adjust as needed.
677 case "kickban": // catch all kick/kickban commands
679 entity victim = GetIndexedEntity(argc, (startpos + 1));
680 float accepted = VerifyClientEntity(victim, true, false);
684 string reason = "No reason provided";
685 if(argc > next_token)
686 reason = substring(vote_command, argv_start_index(next_token) - missing_chars, -1);
688 string command_arguments = reason;
689 if (first_command == "kickban")
690 command_arguments = strcat(ftos(autocvar_g_ban_default_bantime), " ", ftos(autocvar_g_ban_default_masksize), " ~");
692 vote_parsed_command = strcat(first_command, " # ", ftos(etof(victim)), " ", command_arguments);
693 vote_parsed_display = sprintf("^1%s #%d ^7%s^1 %s", first_command, etof(victim), victim.netname, reason);
695 else { print_to(caller, strcat("vcall: ", GetClientErrorString(accepted, argv(startpos + 1)), ".\n")); return 0; }
702 case "gotomap": // re-direct all map selection commands to gotomap
704 vote_command = ValidateMap(argv(startpos + 1), caller);
705 if (!vote_command) return -1;
706 vote_parsed_command = strcat("gotomap ", vote_command);
707 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
712 case "nextmap": // TODO: replicate the old behaviour of being able to vote for maps from different modes on multimode servers (possibly support it in gotomap too), maybe fallback instead of aborting if map name is invalid?
714 vote_command = ValidateMap(argv(startpos + 1), caller);
715 if (!vote_command) return -1;
716 vote_parsed_command = strcat("nextmap ", vote_command);
717 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
724 // add a delay so that vote result can be seen and announcer can be heard
725 // if the vote is accepted
726 vote_parsed_command = strcat("defer 1 ", vote_command);
727 vote_parsed_display = strzone(strcat("^1", vote_command));
734 vote_parsed_command = vote_command;
735 vote_parsed_display = strzone(strcat("^1", vote_command));
745 // =======================
746 // Command Sub-Functions
747 // =======================
749 void VoteCommand_abstain(int request, entity caller) // CLIENT ONLY
753 case CMD_REQUEST_COMMAND:
755 if (!vote_called) { print_to(caller, "^1No vote called."); }
756 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
758 print_to(caller, "^1You have already voted.");
761 else // everything went okay, continue changing vote
763 print_to(caller, "^1You abstained from your vote.");
764 caller.vote_selection = VOTE_SELECT_ABSTAIN;
766 if (!autocvar_sv_vote_singlecount) VoteCount(false); }
772 case CMD_REQUEST_USAGE:
774 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
775 print_to(caller, " No arguments required.");
781 void VoteCommand_call(int request, entity caller, int argc, string vote_command) // BOTH
785 case CMD_REQUEST_COMMAND:
787 float tmp_playercount = 0;
790 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
792 if (!autocvar_sv_vote_call && caller) { print_to(caller, "^1Vote calling is not allowed."); }
793 else if (!autocvar_sv_vote_gamestart && time < game_starttime)
795 print_to(caller, "^1Vote calling is not allowed before the match has started.");
797 else if (vote_called)
799 print_to(caller, "^1There is already a vote called.");
801 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
803 print_to(caller, "^1Only players can call a vote.");
805 else if (caller && !IS_CLIENT(caller))
807 print_to(caller, "^1Only connected clients can vote.");
809 else if (timeout_status)
811 print_to(caller, "^1You can not call a vote while a timeout is active.");
813 else if (caller && (time < caller.vote_waittime))
815 print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote."));
817 else if (!VoteCommand_checknasty(vote_command))
819 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
821 else if ((parse_error = VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc)) <= 0)
824 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
826 else // everything went okay, continue with calling the vote
828 vote_caller = caller; // remember who called the vote
829 vote_caller_name = strzone(GetCallerName(vote_caller));
830 vote_called = VOTE_NORMAL;
831 vote_called_command = strzone(vote_parsed_command);
832 vote_called_display = strzone(vote_parsed_display);
833 vote_endtime = time + autocvar_sv_vote_timeout;
837 caller.vote_selection = VOTE_SELECT_ACCEPT;
838 caller.vote_waittime = time + autocvar_sv_vote_wait;
842 FOREACH_CLIENT(IS_REAL_CLIENT(it), { ++tmp_playercount; });
844 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote for ", vote_called_display, "\n");
845 if (autocvar_sv_eventlog)
846 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
847 Nagger_VoteChanged();
848 VoteCount(true); // needed if you are the only one
850 if (tmp_playercount > 1 && vote_called != VOTE_NULL)
851 Send_Notification(NOTIF_ALL, NULL, MSG_ANNCE, ANNCE_VOTE_CALL);
858 case CMD_REQUEST_USAGE:
860 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call command"));
861 print_to(caller, " Where 'command' is the command to request a vote upon.");
862 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
863 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
869 void VoteCommand_master(int request, entity caller, int argc, string vote_command) // CLIENT ONLY
873 case CMD_REQUEST_COMMAND:
875 if (autocvar_sv_vote_master)
877 switch (strtolower(argv(2)))
882 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
884 if (!caller.vote_master)
885 print_to(caller, "^1You do not have vote master privileges.");
886 else if (!VoteCommand_checknasty(vote_command))
888 print_to(caller, "^1Syntax error in command, see 'vhelp' for more info.");
890 else if ((parse_error = VoteCommand_parse(caller, vote_command, strcat(autocvar_sv_vote_commands, " ", autocvar_sv_vote_master_commands), 3, argc)) <= 0)
893 print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info.");
895 else // everything went okay, proceed with command
897 localcmd(strcat(vote_parsed_command, "\n"));
898 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
899 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
900 if (autocvar_sv_eventlog)
901 GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display));
909 if (autocvar_sv_vote_master_password == "") { print_to(caller, "^1Login to vote master is not allowed."); }
910 else if (caller.vote_master)
912 print_to(caller, "^1You are already logged in as vote master.");
914 else if (autocvar_sv_vote_master_password != argv(3))
916 print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller)));
918 else // everything went okay, proceed with giving this player master privilages
920 caller.vote_master = true;
921 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
922 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
923 if (autocvar_sv_eventlog)
924 GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid)));
930 default: // calling a vote for master
932 if (!autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
933 else if (vote_called)
935 print_to(caller, "^1There is already a vote called.");
937 else if (!spectators_allowed && (caller && !IS_PLAYER(caller)))
939 print_to(caller, "^1Only players can call a vote.");
941 else if (timeout_status)
943 print_to(caller, "^1You can not call a vote while a timeout is active.");
945 else // everything went okay, continue with creating vote
947 vote_caller = caller;
948 vote_caller_name = strzone(GetCallerName(vote_caller));
949 vote_called = VOTE_MASTER;
950 vote_called_command = strzone("XXX");
951 vote_called_display = strzone("^3master");
952 vote_endtime = time + autocvar_sv_vote_timeout;
954 caller.vote_selection = VOTE_SELECT_ACCEPT;
955 caller.vote_waittime = time + autocvar_sv_vote_wait;
957 bprint("\{1}^2* ^3", OriginalCallerName(), "^2 calls a vote to become ^3master^2.\n");
958 if (autocvar_sv_eventlog)
959 GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display));
960 Nagger_VoteChanged();
961 VoteCount(true); // needed if you are the only one
968 else { print_to(caller, "^1Master control of voting is not allowed."); }
974 case CMD_REQUEST_USAGE:
976 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [action [command | password]]"));
977 print_to(caller, " If action is left blank, it calls a vote for you to become master.");
978 print_to(caller, " Otherwise the actions are either 'do' a command or 'login' as master.");
984 void VoteCommand_no(int request, entity caller) // CLIENT ONLY
988 case CMD_REQUEST_COMMAND:
990 if (!vote_called) { print_to(caller, "^1No vote called."); }
991 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
993 print_to(caller, "^1You have already voted.");
995 else if (((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote)
1000 else // everything went okay, continue changing vote
1002 print_to(caller, "^1You rejected the vote.");
1003 caller.vote_selection = VOTE_SELECT_REJECT;
1004 msg_entity = caller;
1005 if (!autocvar_sv_vote_singlecount)
1013 case CMD_REQUEST_USAGE:
1015 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
1016 print_to(caller, " No arguments required.");
1022 void VoteCommand_status(int request, entity caller) // BOTH
1026 case CMD_REQUEST_COMMAND:
1028 if (vote_called) print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", OriginalCallerName(), "^7."));
1029 else print_to(caller, "^1No vote called.");
1035 case CMD_REQUEST_USAGE:
1037 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
1038 print_to(caller, " No arguments required.");
1044 void VoteCommand_stop(int request, entity caller) // BOTH
1048 case CMD_REQUEST_COMMAND:
1050 if (!vote_called) print_to(caller, "^1No vote called.");
1051 else if ((caller == vote_caller) || !caller || caller.vote_master) VoteStop(caller);
1052 else print_to(caller, "^1You are not allowed to stop that vote.");
1057 case CMD_REQUEST_USAGE:
1059 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
1060 print_to(caller, " No arguments required.");
1066 void VoteCommand_yes(int request, entity caller) // CLIENT ONLY
1070 case CMD_REQUEST_COMMAND:
1072 if (!vote_called) { print_to(caller, "^1No vote called."); }
1073 else if (caller.vote_selection != VOTE_SELECT_NULL && !autocvar_sv_vote_change)
1075 print_to(caller, "^1You have already voted.");
1077 else // everything went okay, continue changing vote
1079 print_to(caller, "^1You accepted the vote.");
1080 caller.vote_selection = VOTE_SELECT_ACCEPT;
1081 msg_entity = caller;
1082 if (!autocvar_sv_vote_singlecount)
1090 case CMD_REQUEST_USAGE:
1092 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
1093 print_to(caller, " No arguments required.");
1099 /* use this when creating a new command, making sure to place it in alphabetical order... also,
1100 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
1101 void VoteCommand_(int request)
1105 case CMD_REQUEST_COMMAND:
1112 case CMD_REQUEST_USAGE:
1114 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
1115 print_to(caller, " No arguments required.");
1123 // ================================
1124 // Macro system for vote commands
1125 // ================================
1127 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
1128 #define VOTE_COMMANDS(request, caller, arguments, command) \
1129 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
1130 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
1131 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
1132 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "Full control over all voting and vote commands", VC_ASGNMNT_CLIENTONLY) \
1133 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
1134 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
1135 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
1136 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
1139 void VoteCommand_macro_help(entity caller, int argc)
1141 string command_origin = GetCommandPrefix(caller);
1143 if (argc == 2 || argv(2) == "help") // help display listing all commands
1145 print_to(caller, "\nVoting commands:\n");
1146 #define VOTE_COMMAND(name, function, description, assignment) \
1147 { if (Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
1149 VOTE_COMMANDS(0, caller, 0, "");
1152 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote COMMAND...^7, where possible commands are listed above.\n"));
1153 print_to(caller, strcat("For help about a specific command, type ", command_origin, " vote help COMMAND"));
1154 print_to(caller, strcat("\n^7You can call a vote for or execute these commands: ^3", autocvar_sv_vote_commands, "^7 and maybe further ^3arguments^7"));
1156 else // usage for individual command
1158 #define VOTE_COMMAND(name, function, description, assignment) \
1159 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(2))) { function; return; } } }
1161 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "");
1164 string cvarname = strcat("sv_vote_command_help_", argv(2));
1165 if(cvar_type(cvarname) & CVAR_TYPEFLAG_EXISTS)
1166 wordwrap_sprint(caller, cvar_string(cvarname), 1000);
1168 print_to(caller, "No documentation exists for this vote");
1172 float VoteCommand_macro_command(entity caller, int argc, string vote_command)
1174 #define VOTE_COMMAND(name, function, description, assignment) \
1175 { if (Votecommand_check_assignment(caller, assignment)) { if (name == strtolower(argv(1))) { function; return true; } } }
1177 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command);
1184 // ======================================
1185 // Main function handling vote commands
1186 // ======================================
1188 void VoteCommand(int request, entity caller, int argc, string vote_command)
1190 // Guide for working with argc arguments by example:
1191 // argc: 1 - 2 - 3 - 4
1192 // argv: 0 - 1 - 2 - 3
1193 // cmd vote - master - login - password
1197 case CMD_REQUEST_COMMAND:
1199 if (VoteCommand_macro_command(caller, argc, vote_command)) return;
1203 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"));
1204 case CMD_REQUEST_USAGE:
1206 VoteCommand_macro_help(caller, argc);