1 // =============================================
2 // Server side voting code, reworked by Samual
3 // Last updated: December 14th, 2011
4 // =============================================
6 // Nagger for players to know status of voting
7 float Nagger_SendEntity(entity to, float sendflags)
11 WriteByte(MSG_ENTITY, ENT_CLIENT_NAGGER);
15 // 2 = player needs to ready up
17 // 8 = player needs to vote
33 if(to.vote_selection == 0)
45 if(!(nags & 4)) // no vote called? send no string
48 WriteByte(MSG_ENTITY, nags);
52 WriteByte(MSG_ENTITY, vote_accept_count);
53 WriteByte(MSG_ENTITY, vote_reject_count);
54 WriteByte(MSG_ENTITY, vote_needed_overall);
55 WriteChar(MSG_ENTITY, to.vote_selection);
59 WriteString(MSG_ENTITY, vote_called_display);
63 for(i = 1; i <= maxclients; i += 8)
65 for(f = 0, e = edict_num(i), b = 1; b < 256; b *= 2, e = nextent(e))
66 if(clienttype(e) != CLIENTTYPE_REAL || e.ready)
68 WriteByte(MSG_ENTITY, f);
77 Net_LinkEntity(nagger = spawn(), FALSE, 0, Nagger_SendEntity);
80 void Nagger_VoteChanged()
83 nagger.SendFlags |= 128;
86 void Nagger_VoteCountChanged()
89 nagger.SendFlags |= 64;
92 void Nagger_ReadyCounted()
95 nagger.SendFlags |= 1;
99 // =======================
100 // Game logic for voting
101 // =======================
107 FOR_EACH_CLIENT(tmp_player) { tmp_player.vote_selection = 0; }
111 strunzone(vote_called_command);
112 strunzone(vote_called_display);
115 vote_called = VOTE_NULL;
119 vote_called_command = string_null;
120 vote_called_display = string_null;
122 vote_parsed_command = string_null;
123 vote_parsed_display = string_null;
125 Nagger_VoteChanged();
128 void VoteStop(entity stopper)
130 bprint("\{1}^2* ^3", GetCallerName(stopper), "^2 stopped ^3", GetCallerName(vote_caller), "^2's vote\n");
131 if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vstop:", ftos(stopper.playerid))); }
133 // Don't force them to wait for next vote, this way they can e.g. correct their vote.
134 if((vote_caller) && (stopper == vote_caller)) { vote_caller.vote_waittime = time + autocvar_sv_vote_stop; }
141 bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2's vote for ^1", vote_called_display, "^2 was accepted\n");
143 if((vote_called == VOTE_MASTER) && vote_caller)
144 vote_caller.vote_master = 1;
146 localcmd(strcat(vote_called_command, "\n"));
148 if(vote_caller) { vote_caller.vote_waittime = 0; } // people like your votes, you don't need to wait to vote again
151 Announce("voteaccept");
156 bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2's vote for ", vote_called_display, "^2 was rejected\n");
158 Announce("votefail");
163 bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2's vote for ", vote_called_display, "^2 timed out\n");
165 Announce("votefail");
168 void VoteSpam(float notvoters, float mincount, string result)
171 strcat("\{1}^2* vote results: ^1", ftos(vote_accept_count)),
172 strcat("^2:^1", ftos(vote_reject_count)),
173 ((mincount >= 0) ? strcat("^2 (^1", ftos(mincount), "^2 needed)") : "^2"),
174 strcat(", ^1", ftos(vote_abstain_count), "^2 didn't care"),
175 strcat(", ^1", ftos(notvoters), strcat("^2 didn't ", ((mincount >= 0) ? string_null : "have to "), "vote\n"))));
177 if(autocvar_sv_eventlog)
180 strcat(":vote:v", result, ":", ftos(vote_accept_count)),
181 strcat(":", ftos(vote_reject_count)),
182 strcat(":", ftos(vote_abstain_count)),
183 strcat(":", ftos(notvoters)),
184 strcat(":", ftos(mincount))));
191 vote_accept_count = vote_reject_count = vote_abstain_count = 0;
193 float spectators_allowed = ((autocvar_sv_vote_nospectators != 2)
194 || ((autocvar_sv_vote_nospectators == 1) && inWarmupStage)
195 || (autocvar_sv_vote_nospectators == 0));
197 float vote_player_count, is_player, notvoters;
198 float vote_real_player_count, vote_real_accept_count;
199 float vote_real_reject_count, vote_real_abstain_count;
200 float vote_needed_of_voted, final_needed_votes;
201 float vote_factor_overall, vote_factor_of_voted;
205 Nagger_VoteCountChanged();
207 // add up all the votes from each connected client
208 FOR_EACH_REALCLIENT(tmp_player)
210 is_player = (tmp_player.classname == "player");
213 if(is_player) { ++vote_real_player_count; }
215 switch(tmp_player.vote_selection)
217 case VOTE_SELECT_REJECT: { ++vote_reject_count; { if(is_player) ++vote_real_reject_count; } break; }
218 case VOTE_SELECT_ACCEPT: { ++vote_accept_count; { if(is_player) ++vote_real_reject_count; } break; }
219 case VOTE_SELECT_ABSTAIN: { ++vote_abstain_count; { if(is_player) ++vote_real_abstain_count; } break; }
224 // Check to see if there are enough players on the server to allow master voting... otherwise, vote master could be used for evil.
225 if((vote_called == VOTE_MASTER) && autocvar_sv_vote_master_playerlimit > vote_player_count)
227 if(vote_caller) { vote_caller.vote_waittime = 0; }
228 print_to(vote_caller, "^1There are not enough players on this server to allow you to become vote master.");
233 // 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.
234 if(!spectators_allowed && (vote_real_player_count > 0))
236 vote_accept_count = vote_real_accept_count;
237 vote_reject_count = vote_real_reject_count;
238 vote_abstain_count = vote_real_abstain_count;
239 vote_player_count = vote_real_player_count;
242 // people who have no opinion in any way :D
243 notvoters = (vote_player_count - vote_accept_count - vote_reject_count - vote_abstain_count);
245 // determine the goal for the vote to be passed or rejected normally
246 vote_factor_overall = bound(0.5, autocvar_sv_vote_majority_factor, 0.999);
247 vote_needed_overall = floor((vote_player_count - vote_abstain_count) * vote_factor_overall) + 1;
249 // if the vote times out, determine the amount of votes needed of the people who actually already voted
250 vote_factor_of_voted = bound(0.5, autocvar_sv_vote_majority_factor_of_voted, 0.999);
251 vote_needed_of_voted = floor((vote_accept_count + vote_reject_count) * vote_factor_of_voted) + 1;
254 // finally calculate the result of the vote
255 if(vote_accept_count >= vote_needed_overall)
257 VoteSpam(notvoters, -1, "yes"); // there is enough acceptions to pass the vote
262 if(vote_reject_count > vote_player_count - vote_abstain_count - vote_needed_overall)
264 VoteSpam(notvoters, -1, "no"); // there is enough rejections to deny the vote
269 // there is not enough votes in either direction, now lets just calculate what the voters have said
270 if(time > vote_endtime)
272 final_needed_votes = vote_needed_overall;
274 if(autocvar_sv_vote_majority_factor_of_voted)
276 if(vote_accept_count >= vote_needed_of_voted)
278 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "yes");
283 if(vote_accept_count + vote_reject_count > 0)
285 VoteSpam(notvoters, min(vote_needed_overall, vote_needed_of_voted), "no");
290 final_needed_votes = min(vote_needed_overall, vote_needed_of_voted);
293 // it didn't pass or fail, so not enough votes to even make a decision.
294 VoteSpam(notvoters, final_needed_votes, "timeout");
301 if(vote_endtime > 0) // a vote was called
302 if(time > vote_endtime) // time is up
311 // =======================
312 // Game logic for warmup
313 // =======================
315 // Restarts the map after the countdown is over (and cvar sv_ready_restart_after_countdown is set)
316 void ReadyRestart_think()
318 restart_mapalreadyrestarted = 1;
326 // Forces a restart of the game without actually reloading the map // this is a mess...
327 void ReadyRestart_force()
329 entity tmp_player, restart_timer;
331 bprint("^1Server is restarting...\n");
335 // clear overtime, we have to decrease timelimit to its original value again.
336 if (checkrules_overtimesadded > 0 && g_race_qualifying != 2) { cvar_set("timelimit", ftos(autocvar_timelimit - (checkrules_overtimesadded * autocvar_timelimit_overtime))); }
338 checkrules_suddendeathend = checkrules_overtimesadded = checkrules_suddendeathwarning = 0;
340 readyrestart_happened = 1;
341 game_starttime = time;
342 if(!g_ca && !g_arena) { game_starttime += RESTART_COUNTDOWN; }
344 restart_mapalreadyrestarted = 0; // reset this var, needed when cvar sv_ready_restart_repeatable is in use
346 // disable the warmup global for the server
347 inWarmupStage = 0; // once the game is restarted the game is in match stage
349 // reset the .ready status of all players (also spectators)
350 FOR_EACH_CLIENTSLOT(tmp_player) { tmp_player.ready = 0; }
352 Nagger_ReadyCounted(); // NOTE: this causes a resend of that entity, and will also turn off warmup state on the client
354 // lock teams with lockonrestart
355 if(autocvar_teamplay_lockonrestart && teamplay)
358 bprint("^1The teams are now locked.\n");
361 //initiate the restart-countdown-announcer entity
362 if(autocvar_sv_ready_restart_after_countdown && !g_ca && !g_arena)
364 restart_timer = spawn();
365 restart_timer.think = ReadyRestart_think;
366 restart_timer.nextthink = game_starttime;
369 // after a restart every players number of allowed timeouts gets reset, too
370 if(autocvar_sv_timeout) { FOR_EACH_REALPLAYER(tmp_player) { tmp_player.allowedTimeouts = autocvar_sv_timeout_number; } }
372 //reset map immediately if this cvar is not set
373 if not(autocvar_sv_ready_restart_after_countdown) { reset_map(TRUE); }
375 if(autocvar_sv_eventlog) { GameLogEcho(":restart"); }
380 // no arena, assault support yet...
381 if(g_arena | g_assault | gameover | intermission_running | race_completing)
382 localcmd("restart\n");
384 localcmd("\nsv_hook_gamerestart\n");
386 // Reset ALL scores, but only do that at the beginning of the countdown if sv_ready_restart_after_countdown is off!
387 // Otherwise scores could be manipulated during the countdown.
388 if not(autocvar_sv_ready_restart_after_countdown) { Score_ClearAll(); }
390 ReadyRestart_force();
395 // Count the players who are ready and determine whether or not to restart the match
399 float ready_needed_factor, ready_needed_count;
400 float t_ready, t_players;
402 FOR_EACH_REALPLAYER(tmp_player)
405 if(tmp_player.ready) { ++t_ready; }
408 readycount = t_ready;
410 Nagger_ReadyCounted();
412 ready_needed_factor = bound(0.5, cvar("g_warmup_majority_factor"), 0.999);
413 ready_needed_count = floor(t_players * ready_needed_factor) + 1;
415 if(readycount >= ready_needed_count)
424 // ======================================
425 // Supporting functions for VoteCommand
426 // ======================================
428 float Votecommand_check_assignment(entity caller, float assignment)
430 float from_server = (!caller);
432 if((assignment == VC_ASGNMNT_BOTH)
433 || ((!from_server && assignment == VC_ASGNMNT_CLIENTONLY)
434 || (from_server && assignment == VC_ASGNMNT_SERVERONLY)))
442 string VoteCommand_extractcommand(string input, float startpos, float argc)
446 if((argc - 1) < startpos)
449 output = substring(input, argv_start_index(startpos), argv_end_index(-1) - argv_start_index(startpos));
454 float VoteCommand_checknasty(string vote_command)
456 if((strstrofs(vote_command, ";", 0) >= 0)
457 || (strstrofs(vote_command, "\n", 0) >= 0)
458 || (strstrofs(vote_command, "\r", 0) >= 0)
459 || (strstrofs(vote_command, "$", 0) >= 0))
465 float VoteCommand_checkinlist(string vote_command, string list)
467 string l = strcat(" ", list, " ");
469 if(strstrofs(l, strcat(" ", vote_command, " "), 0) >= 0)
472 // if gotomap is allowed, chmap is too, and vice versa
473 if(vote_command == "gotomap")
474 if(strstrofs(l, " chmap ", 0) >= 0)
477 if(vote_command == "chmap")
478 if(strstrofs(l, " gotomap ", 0) >= 0)
484 string ValidateMap(string validated_map, entity caller)
486 validated_map = MapInfo_FixName(validated_map);
490 print_to(caller, "This map is not available on this server.");
494 if(!autocvar_sv_vote_override_mostrecent && caller)
496 if(Map_IsRecent(validated_map))
498 print_to(caller, "This server does not allow for recent maps to be played again. Please be patient for some rounds.");
503 if(!MapInfo_CheckMap(validated_map))
505 print_to(caller, strcat("^1Invalid mapname, \"^3", validated_map, "^1\" does not support the current game mode."));
509 return validated_map;
512 float VoteCommand_parse(entity caller, string vote_command, string vote_list, float startpos, float argc)
514 string first_command;
517 first_command = argv(startpos);
519 if not(VoteCommand_checkinlist(first_command, vote_list))
522 if(argc < startpos) // These commands won't work without arguments
524 switch(first_command)
537 switch(first_command) // now go through and parse the proper commands to adjust as needed.
540 case "kickban": // catch all kick/kickban commands
542 victim = GetFilteredEntity(argv(startpos + 1));
543 if not(victim) { return FALSE; }
544 // TODO: figure out how kick/kickban/ban commands work and re-write this to fit around them
545 vote_parsed_command = vote_command;
546 vote_parsed_display = strcat("^1", vote_command, " (^7", victim.netname, "^1): ", "todo");
553 case "gotomap": // re-direct all map selection commands to gotomap
555 vote_command = ValidateMap(argv(startpos + 1), caller);
556 if not(vote_command) { return FALSE; }
557 vote_parsed_command = strcat("gotomap ", vote_command);
558 vote_parsed_display = strzone(strcat("^1", vote_parsed_command));
565 vote_parsed_command = vote_command;
566 vote_parsed_display = strzone(strcat("^1", vote_command));
576 // =======================
577 // Command Sub-Functions
578 // =======================
580 void VoteCommand_abstain(float request, entity caller) // CLIENT ONLY
584 case CMD_REQUEST_COMMAND:
586 if not(vote_called) { print_to(caller, "^1No vote called."); }
587 else if not(caller.vote_selection == VOTE_SELECT_NULL || autocvar_sv_vote_change) { print_to(caller, "^1You have already voted."); }
589 else // everything went okay, continue changing vote
591 print_to(caller, "^1You abstained from your vote.");
592 caller.vote_selection = VOTE_SELECT_ABSTAIN;
594 if(!autocvar_sv_vote_singlecount) { VoteCount(); }
601 case CMD_REQUEST_USAGE:
603 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote abstain"));
604 print_to(caller, " No arguments required.");
610 void VoteCommand_call(float request, entity caller, float argc, string vote_command) // BOTH
614 case CMD_REQUEST_COMMAND:
616 float spectators_allowed = ((autocvar_sv_vote_nospectators != 2)
617 || ((autocvar_sv_vote_nospectators == 1) && inWarmupStage)
618 || (autocvar_sv_vote_nospectators == 0));
620 float tmp_playercount;
623 vote_command = VoteCommand_extractcommand(vote_command, 2, argc);
625 if not(autocvar_sv_vote_call || !caller) { print_to(caller, "^1Vote calling is not allowed."); }
626 else if(vote_called) { print_to(caller, "^1There is already a vote called."); }
627 else if(!spectators_allowed && (caller && (caller.classname != "player"))) { print_to(caller, "^1Only players can call a vote."); }
628 else if(timeoutStatus) { print_to(caller, "^1You can not call a vote while a timeout is active."); }
629 else if(caller && (time < caller.vote_waittime)) { print_to(caller, strcat("^1You have to wait ^2", ftos(ceil(caller.vote_waittime - time)), "^1 seconds before you can again call a vote.")); }
630 else if not(VoteCommand_checknasty(vote_command)) { print_to(caller, "^1Syntax error in command, see 'vhelp' for more info."); }
631 else if not(VoteCommand_parse(caller, vote_command, autocvar_sv_vote_commands, 2, argc)) { print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info."); }
633 else // everything went okay, continue with calling the vote
635 vote_caller = caller; // remember who called the vote
636 vote_called = VOTE_NORMAL;
637 vote_called_command = strzone(vote_parsed_command);
638 vote_called_display = strzone(vote_parsed_display);
639 vote_endtime = time + autocvar_sv_vote_timeout;
643 caller.vote_selection = VOTE_SELECT_ACCEPT;
644 caller.vote_waittime = time + autocvar_sv_vote_wait;
648 FOR_EACH_REALCLIENT(tmp_player) { ++tmp_playercount; }
649 if(tmp_playercount > 1) { Announce("votecall"); } // don't announce a "vote now" sound if player is alone
651 bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2 calls a vote for ", vote_called_display, "\n");
652 if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display)); }
653 Nagger_VoteChanged();
654 VoteCount(); // needed if you are the only one
661 case CMD_REQUEST_USAGE:
663 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote call command"));
664 print_to(caller, " Where 'command' is the command to request a vote upon.");
665 print_to(caller, strcat("Examples: ", GetCommandPrefix(caller), " vote call gotomap dance"));
666 print_to(caller, strcat(" ", GetCommandPrefix(caller), " vote call endmatch"));
672 void VoteCommand_master(float request, entity caller, float argc, string vote_command) // CLIENT ONLY
676 case CMD_REQUEST_COMMAND:
678 if(autocvar_sv_vote_master)
680 switch(strtolower(argv(2)))
684 vote_command = VoteCommand_extractcommand(vote_command, 3, argc);
686 if not(caller.vote_master) { print_to(caller, "^1You do not have vote master privelages."); }
687 else if not(VoteCommand_checknasty(vote_command)) { print_to(caller, "^1Syntax error in command, see 'vhelp' for more info."); }
688 else if not(VoteCommand_parse(caller, vote_command, autocvar_sv_vote_master_commands, 3, argc)) { print_to(caller, "^1This command is not acceptable, see 'vhelp' for more info."); }
690 else // everything went okay, proceed with command
692 localcmd(strcat(vote_parsed_command, "\n"));
693 print_to(caller, strcat("Executing command '", vote_parsed_display, "' on server."));
694 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 used their ^3master^2 status to do \"^2", vote_parsed_display, "^2\".\n");
695 if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vdo:", ftos(caller.playerid), ":", vote_parsed_display)); }
703 if not(autocvar_sv_vote_master_password != "") { print_to(caller, "^1Login to vote master is not allowed."); }
704 else if(caller.vote_master) { print_to(caller, "^1You are already logged in as vote master."); }
705 else if not(autocvar_sv_vote_master_password == argv(3)) { print_to(caller, strcat("Rejected vote master login from ", GetCallerName(caller))); }
707 else // everything went okay, proceed with giving this player master privilages
709 caller.vote_master = TRUE;
710 print_to(caller, strcat("Accepted vote master login from ", GetCallerName(caller)));
711 bprint("\{1}^2* ^3", GetCallerName(caller), "^2 logged in as ^3master^2\n");
712 if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vlogin:", ftos(caller.playerid))); }
718 default: // calling a vote for master
720 if not(autocvar_sv_vote_master_callable) { print_to(caller, "^1Vote to become vote master is not allowed."); }
721 else if(vote_called) { print_to(caller, "^1There is already a vote called."); }
723 else // everything went okay, continue with creating vote
725 vote_caller = caller;
726 vote_called = VOTE_MASTER;
727 vote_called_command = strzone("XXX");
728 vote_called_display = strzone("^3master");
729 vote_endtime = time + autocvar_sv_vote_timeout;
731 caller.vote_selection = VOTE_SELECT_ACCEPT;
732 caller.vote_waittime = time + autocvar_sv_vote_wait;
734 bprint("\{1}^2* ^3", GetCallerName(vote_caller), "^2 calls a vote to become ^3master^2.\n");
735 if(autocvar_sv_eventlog) { GameLogEcho(strcat(":vote:vcall:", ftos(vote_caller.playerid), ":", vote_called_display)); }
736 Nagger_VoteChanged();
737 VoteCount(); // needed if you are the only one
744 else { print_to(caller, "^1Master control of voting is not allowed."); }
750 case CMD_REQUEST_USAGE:
752 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote master [action [command | password]]"));
753 print_to(caller, " If action is left blank, it calls a vote for you to become master.");
754 print_to(caller, " Otherwise the actions are either 'do' a command or 'login' as master.");
760 void VoteCommand_no(float request, entity caller) // CLIENT ONLY
764 case CMD_REQUEST_COMMAND:
766 if not(vote_called) { print_to(caller, "^1No vote called."); }
767 else if not(caller.vote_selection == VOTE_SELECT_NULL || autocvar_sv_vote_change) { print_to(caller, "^1You have already voted."); }
768 else if(((caller == vote_caller) || caller.vote_master) && autocvar_sv_vote_no_stops_vote) { VoteStop(caller); }
770 else // everything went okay, continue changing vote
772 print_to(caller, "^1You rejected the vote.");
773 caller.vote_selection = VOTE_SELECT_REJECT;
775 if(!autocvar_sv_vote_singlecount) { VoteCount(); }
782 case CMD_REQUEST_USAGE:
784 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote no"));
785 print_to(caller, " No arguments required.");
791 void VoteCommand_status(float request, entity caller) // BOTH
795 case CMD_REQUEST_COMMAND:
798 print_to(caller, strcat("^7Vote for ", vote_called_display, "^7 called by ^7", GetCallerName(vote_caller), "^7."));
800 print_to(caller, "^1No vote called.");
806 case CMD_REQUEST_USAGE:
808 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote status"));
809 print_to(caller, " No arguments required.");
815 void VoteCommand_stop(float request, entity caller) // BOTH
819 case CMD_REQUEST_COMMAND:
821 if not(vote_called) { print_to(caller, "^1No vote called."); }
822 else if((caller == vote_caller) || !caller || caller.vote_master) { VoteStop(caller); }
823 else { print_to(caller, "^1You are not allowed to stop that vote."); }
829 case CMD_REQUEST_USAGE:
831 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote stop"));
832 print_to(caller, " No arguments required.");
838 void VoteCommand_yes(float request, entity caller) // CLIENT ONLY
842 case CMD_REQUEST_COMMAND:
844 if not(vote_called) { print_to(caller, "^1No vote called."); }
845 if not(caller.vote_selection == VOTE_SELECT_NULL || autocvar_sv_vote_change) { print_to(caller, "^1You have already voted."); }
847 else // everything went okay, continue changing vote
849 print_to(caller, "^1You accepted the vote.");
850 caller.vote_selection = VOTE_SELECT_ACCEPT;
852 if(!autocvar_sv_vote_singlecount) { VoteCount(); }
859 case CMD_REQUEST_USAGE:
861 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote yes"));
862 print_to(caller, " No arguments required.");
868 /* use this when creating a new command, making sure to place it in alphabetical order... also,
869 ** ADD ALL NEW COMMANDS TO commands.cfg WITH PROPER ALIASES IN THE SAME FASHION!
870 void VoteCommand_(float request)
874 case CMD_REQUEST_COMMAND:
881 case CMD_REQUEST_USAGE:
883 print_to(caller, strcat("\nUsage:^3 ", GetCommandPrefix(caller), " vote ");
884 print_to(caller, " No arguments required.");
892 // ================================
893 // Macro system for vote commands
894 // ================================
896 // Do not hard code aliases for these, instead create them in commands.cfg... also: keep in alphabetical order, please ;)
897 #define VOTE_COMMANDS(request,caller,arguments,command) \
898 VOTE_COMMAND("abstain", VoteCommand_abstain(request, caller), "Abstain your vote in current vote", VC_ASGNMNT_CLIENTONLY) \
899 VOTE_COMMAND("call", VoteCommand_call(request, caller, arguments, command), "Create a new vote for players to decide on", VC_ASGNMNT_BOTH) \
900 VOTE_COMMAND("help", VoteCommand_macro_help(caller, arguments), "Shows this information", VC_ASGNMNT_BOTH) \
901 VOTE_COMMAND("master", VoteCommand_master(request, caller, arguments, command), "TODO", VC_ASGNMNT_CLIENTONLY) \
902 VOTE_COMMAND("no", VoteCommand_no(request, caller), "Select no in current vote", VC_ASGNMNT_CLIENTONLY) \
903 VOTE_COMMAND("status", VoteCommand_status(request, caller), "Prints information about current vote", VC_ASGNMNT_BOTH) \
904 VOTE_COMMAND("stop", VoteCommand_stop(request, caller), "Immediately end a vote", VC_ASGNMNT_BOTH) \
905 VOTE_COMMAND("yes", VoteCommand_yes(request, caller), "Select yes in current vote", VC_ASGNMNT_CLIENTONLY) \
908 void VoteCommand_macro_help(entity caller, float argc)
910 string command_origin = GetCommandPrefix(caller);
912 if(argc == 2) // help display listing all commands
914 print_to(caller, strcat("\nUsage:^3 ", command_origin, " vote COMMAND...^7, where possible commands are:"));
916 #define VOTE_COMMAND(name,function,description,assignment) \
917 { if(Votecommand_check_assignment(caller, assignment)) { print_to(caller, strcat(" ^2", name, "^7: ", description)); } }
919 VOTE_COMMANDS(0, caller, 0, "")
922 print_to(caller, strcat("For help about specific commands, type ", command_origin, " vote help COMMAND"));
923 print_to(caller, "^7You can call a vote for or execute these commands:");
924 print_to(caller, strcat("^3", autocvar_sv_vote_commands, "^7 and maybe further ^3arguments^7"));
926 else // usage for individual command
928 #define VOTE_COMMAND(name,function,description,assignment) \
929 { if(Votecommand_check_assignment(caller, assignment)) { if(name == strtolower(argv(2))) { function; return; } } }
931 VOTE_COMMANDS(CMD_REQUEST_USAGE, caller, argc, "")
938 float VoteCommand_macro_command(entity caller, float argc, string vote_command)
940 #define VOTE_COMMAND(name,function,description,assignment) \
941 { if(Votecommand_check_assignment(caller, assignment)) { if(name == strtolower(argv(1))) { function; return TRUE; } } }
943 VOTE_COMMANDS(CMD_REQUEST_COMMAND, caller, argc, vote_command)
950 // ======================================
951 // Main function handling vote commands
952 // ======================================
954 void VoteCommand(float request, entity caller, float argc, string vote_command)
956 // Guide for working with argc arguments by example:
957 // argc: 1 - 2 - 3 - 4
958 // argv: 0 - 1 - 2 - 3
959 // cmd vote - master - login - password
963 case CMD_REQUEST_COMMAND:
965 if(VoteCommand_macro_command(caller, argc, vote_command))
970 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"));
971 case CMD_REQUEST_USAGE:
973 VoteCommand_macro_help(caller, argc);