Scripts.included.gg map vote

From GunGame5 Documentation

---

Revision as of 18:03, 22 March 2011

Description

gg_map_vote is used to allow players to vote for the next map.

• Players can also Rock the Vote if those settings are enabled.
  • RTF allows players to vote for a new map immediately.
  • Once the RTF is finished, the map will be changed.

Variables

gg_map_vote contains the following cvars that can be found in your server's ../cfg/gungame51/included_addon_configs/gg_map_vote.cfg file:

// ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// |                            MAP VOTE SETTINGS                             |
// ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


// ============================================================================
// >> GUNGAME MAP VOTE
// ============================================================================
// Description:
//    Allows players to vote for the next map.
// Notes:
//    * This does not require any additional plug-ins.
// Options:
//    0 = (Disabled) Do not use voting.
//    1 = (Enabled) Use GunGame's map voting system.
//    2 = (Enabled) Use a 3rd-party voting system.
// Default Value: 0

// Controls GunGame's map voting.
   gg_map_vote 0

// ============================================================================
// >> 3RD PARTY VOTE COMMAND
// ============================================================================
// Description:
//    If gg_map_vote is set to 2, this is the command that will be issued when.
//    the vote is triggered.
// Examples:
//  Mani:        gg_map_vote_command "ma_voterandom end 4"
//  BeetlesMod:  gg_map_vote_command "admin_votemaps"
//  SourceMod:   gg_map_vote_command "sm_mapvote" (with mapchooser.smx enabled)
// Default Value: "ma_voterandom end 4"

// Triggers 3rd party voting.
   gg_map_vote_command "ma_voterandom end 4"

// ============================================================================
// >> MAP VOTE SIZE
// ============================================================================
// Description:
//    This variable controls the number of maps that will be displayed as
//    options in the vote menu.
// Notes:
//    * It is recommended not to set this too high.
// Options:
//    0 = (Enabled) Use entire map list.
//    # = (Enabled) Use # amount of options.
// Default Value: 6

// Controls GunGame's map vote size.
   gg_map_vote_size 6

// ============================================================================
// >> MAP VOTE TRIGGER LEVEL
// ============================================================================
// Description:
//    This variable controls what level the GunGame Vote is fired on.
//    The value will be subtracted from the total number of levels.
// Notes:
//    * If there are 23 levels, and "gg_vote_trigger" is set to "3", voting
//      will start on level 20.
// Options:
//    # = (Enabled) # from the last level to start the voting.
// Default Value: 4

// Which level to trigger GunGame's map voting.
   gg_map_vote_trigger 4

// ============================================================================
// >> MAP VOTE TIME
// ============================================================================
// Description:
//    This variable controls how long the vote will last for.
// Notes:
//    * It is recommended not to set this too high.
//    * If nobody votes, it will default to the "mapcycle.txt".
// Options:
//    # = (Enabled) Time in seconds to allow voting.
// Default Value: 30

// GunGame's map voting time limit.
   gg_map_vote_time 30

// ============================================================================
// >> EXCLUDE RECENTLY PLAYED MAPS
// ============================================================================
// Description:
//    This variable will exclude the selected number of recently
//    played maps from the vote menu.
// Notes:
//    * Make sure you have enough maps listed in your source.
// Options:
//    0 = (Disabled) Do not exclude recent maps.
//    # = (Enabled) # of last maps to exclude.
// Default Value: 0

// Exclude recent maps from GunGame's map voting.
   gg_map_vote_dont_show_last_maps 0

// ============================================================================
// >> SHOW PLAYER VOTES
// ============================================================================
// Description:
//    This variable controls if votes will be publically announced.
// Examples:
//    * Monday voted for gg_funtimes.
//    * XE_ManUp voted for gg_hello_kitty_island_adventure.
//    * Warren voted for aim_shotty.
// Options:
//    0 = (Disabled) Do not use display player votes.
//    1 = (Enabled) Display player votes.
// Default Value: 0

// Shows player feedback from GunGame's map voting.
   gg_map_vote_show_player_vote 0

// ============================================================================
// >> MAP LIST SOURCE
// ============================================================================
// Description:
//    Controls which map list will be used to build the vote menu.
// Notes:
//    * You may only filter maps with option 3. See below for more information.
// Options:
//    1 = mapcycle.txt
//    2 = maplist.txt
//    3 = "gg_map_list_file" variable
//    4 = All maps in the "maps" folder
// Default Value: 1

// Source of maps for GunGame's map voting.
   gg_map_vote_list_source 1

// ============================================================================
// >> MAP LIST FILE
// ============================================================================
// Description:
//    This variable is not used, unless the above variable is set to 3.
// Notes:
//    * You may filter out maps by player count.
//    * See "/cfg/gungame51/gg_vote_list.txt" for examples and information.
//    * You can NOT add filters to "maplist.txt" and "mapcycle.txt"
// Examples:
//    gg_map_vote_file "cfg/gungame51/my_list.txt"
//    gg_map_vote_file "cfg/my_other_list.txt"
// Default Value: cfg/gungame51/gg_vote_list.txt

// Map list for GunGame's map voting.
   gg_map_vote_file "cfg/gungame51/gg_vote_list.txt"

// ============================================================================
// >> PLAYER VOTE COMMAND
// ============================================================================
// Description:
//    Allows players to vote for the next map.
// Notes:
//    * Players can vote or revote using this say command.
// Examples:
//    gg_map_vote_player_command "!ggvote"
//    gg_map_vote_player_command "!vote"
// Default Value: "!vote"

// Player say command for GunGame's map voting.
   gg_map_vote_player_command "!vote"

// ============================================================================
// >> DEAD FILTER
// ============================================================================
// Description:
//    * This will only send the vote menu to dead players. 
//    * Players will receive the menu once they die.
// Notes:
//    * Players can use the player vote command to load the menu if they
//      wish to vote while alive.
// Options:
//    0 = (Disabled) Send the vote menu to everyone.
//    1 = (Enabled) Only send the vote menu to dead players.
// Default Value: 0

// Only the dead get popups during GunGame's map voting.
   gg_map_vote_after_death 0


// ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// |                          ROCK THE VOTE SETTINGS                          |
// ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


// ============================================================================
// >> ROCK THE VOTE
// ============================================================================
// Description:
//    Allows players to request a map vote in the middle of a map.
// Note:
//    * Only takes effect with "gg_map_vote 1" set.
// Examples:
//    0 = (Disabled)
//    1 = (Enabled)
// Default Value: 1

// Allow rocking the vote.
   gg_map_vote_rtv 1

// ============================================================================
// >> ROCK THE VOTE COMMAND
// ============================================================================
// Description:
//    Allows players to rock the vote.
// Examples:
//    gg_map_vote_rtv_command "rtv"
// Default Value: "!rtv"

// Player say command for GunGame's RTV.
   gg_map_vote_rtv_command "!rtv"

// ============================================================================
// >> ROCK THE VOTE DISABLE LEVEL
// ============================================================================
// Description:
//    The percentage of total number of levels which, when the leader reaches
//    it, disables RTV for that map.
// Examples:
//    60 = (If there are 24 total levels, when the leader hits level
//            15 (we round down), RTV is disabled)
// Default Value: 60

// Level percentage when RTV gets disabled.
   gg_map_vote_rtv_levels_required 60

// ============================================================================
// >> ROCK THE VOTE PERCENTAGE
// ============================================================================
// Description:
//    The percentage of total players required to rtv before the vote gets
//    rocked.
// Examples:
//    60 = 60% of players (rounded down) on the server need to RTV.
// Default Value: 60

// Player say command for GunGame's rtv.
   gg_map_vote_rtv_percent 60


// ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// |                            NOMINATION SETTINGS                             |
// ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


// ============================================================================
// >> NOMINATE FOR VOTE
// ============================================================================
// Description:
//    Allows players to request a map to be in the next vote.
// Notes:
//    * Only takes effect with "gg_map_vote 1" set.
//    * Only gg_map_vote_size nominations can be made.
//    * gg_map_vote_dont_show_last_maps can't be nominated.
// Examples:
//    0 = (Disabled)
//    1 = (Enabled)
// Default Value: 1

// Allow vote nominations.
   gg_map_vote_nominate 1

// ============================================================================
// >> ROCK THE VOTE COMMAND
// ============================================================================
// Description:
//    Allows players to nominate.
// Examples:
//    gg_map_vote_nominate_command "!nominate"
// Default Value: "!nominate"

// Player say command for GunGame's nominate.
   gg_map_vote_nominate_command "!nominate"