UE3:UTVoteCollector (UT3)

Object >> Actor >> Info >> UTVoteCollector

Package: 

UTGame

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties

ActiveGameProfileIdx

Type: int

bAllowGameVoting

Type: bool

Modifiers: globalconfig

If true, then users can vote to play a map in a specific game type

bAllowKickVoting

Type: bool

Modifiers: globalconfig

If true, then players can vote to kick a player out of the server

bAllowMapVoting

Type: bool

Modifiers: globalconfig

If true, users can vote in order to pick the next map

Default value: True

bAllowMutatorVoting

Type: bool

Modifiers: globalconfig

If true, then players can vote for a mutator to be enabled/disabled during the next game

bAnonymousKickVoting

Type: bool

Modifiers: globalconfig

If true, then kickvote messages will not display the name of the voter (except to admins)

Default value: True

bGameVotingActive

Type: bool

Whether or not game voting is currently active

bInEndGameVote

Type: bool

As above, but relating to end game votes

bInMidGameVote

Type: bool

A vote countdown has been enabled mid-game, and a map switch is imminent

bKickVotingActive

Type: bool

Whether kick voting is active

bMapVotingActive

Type: bool

Whether map voting is active

bMidGameVoting

Type: bool

Modifiers: globalconfig

If false, users will only be able to vote at the end of the game

Default value: True

bMutatorVotingActive

Type: bool

Whether mutator voting is active

bUpdateActiveMapList

Type: bool

Tells the code to update the maplist manager's active maplist

bVoteDecided

Type: bool

Whether or not the winning map vote has been decided

bVotingAllowed

Type: bool

If true, then the vote collector is accepting votes from clients

ForcedGameVoteIdx

Type: int

The index of the game vote which an admin has forced to win

Default value: -1

ForcedMapVoteIdx

Type: int

As above, except for map votes

Default value: -1

ForcedOffMutVotes

Type: array<int>

The index of mutator votes which are forced off

ForcedOnMutVotes

Type: array<int>

The index of mutator votes which are forced on

ForceEnableMapIdx

Type: int

The index of the map to be forcibly enabled, when all a maplists maps are disabled

Default value: -1

GameInfoRef

Type: UTGame

GameVoteDuration

Type: int

Modifiers: globalconfig

How long players are given to pick a gametype

Default value: 15

GameVotes

Type: array<GameVoteInfo>

Information about active game votes

InitialVoteDelay

Type: int

Modifiers: globalconfig

The amount of time that must pass before voting is initialized (only applies to midgame voting)

Default value: 30

InitialVoteTransferTime

Type: int

Modifiers: globalconfig

Slows down vote data transfers, to spread out bandwidth usage and prevent lag

Default value: 12

KickVotePercentage

Type: int

Modifiers: globalconfig

The percentage of votes required to kick a player from the server

Default value: 51

KickVotes

Type: array<KickVoteInfo>

Information about active kick votes

MapListManager

Type: UTMapListManager

MapVoteDuration

Type: int

Modifiers: globalconfig

How long players are given to pick a map

Default value: 30

MapVoteMapList

Type: UTMapList

The maplist used for map voting

MapVotes

Type: array<MapVoteInfo>

Information about active map votes

MidGameVotePercentage

Type: int

Modifiers: globalconfig

The percentage of votes required to initiate a map switch midgame

Default value: 51

MinKickVotes

Type: int

Modifiers: globalconfig

The minimum number of votes required in order to votekick a player

Default value: 3

MinMidGameVotes

Type: int

Modifiers: globalconfig

The minimum number of votes requires to initiate a map switch midgame

Default value: 2

MutatorVotePercentage

Type: int

Modifiers: globalconfig

The percentage of votes required to enable/disable mutators (only counted at end of the game)

Default value: 51

MutatorVotes

Type: array<MutatorVoteInfo>

Information about votable mutators and their vote counts

MutProviders

Type: array<UTUIResourceDataProvider>

Cached list of mutator data providers, for retrieving descriptions for clients on request

PendingGameClass

Type: string

RushVoteTransferTime

Type: int

Modifiers: globalconfig

Speeds up vote transfers when the client opens the vote menu; used to quickly finish transfers

Default value: 3

VotableMutators

Type: array<MutatorProfile>

Modifiers: globalconfig

The list of votable mutators

Default value, index 0:

Member	Value
MutClass	"UTGame.UTMutator_BigHead"

Default value, index 1:

Member	Value
MutClass	"UTGame.UTMutator_FriendlyFire"

Default value, index 2:

Member	Value
MutClass	"UTGame.UTMutator_Handicap"

Default value, index 3:

Member	Value
MutClass	"UTGame.UTMutator_Instagib"

Default value, index 4:

Member	Value
MutClass	"UTGame.UTMutator_LowGrav"

Default value, index 5:

Member	Value
MutClass	"UTGame.UTMutator_NoHoverboard"

Default value, index 6:

Member	Value
MutClass	"UTGame.UTMutator_NoOrbs"

Default value, index 7:

Member	Value
MutClass	"UTGame.UTMutator_NoPowerups"

Default value, index 8:

Member	Value
MutClass	"UTGame.UTMutator_NoTranslocator"

Default value, index 9:

Member	Value
MutClass	"UTGame.UTMutator_Slomo"

Default value, index 10:

Member	Value
MutClass	"UTGame.UTMutator_SpeedFreak"

Default value, index 11:

Member	Value
MutClass	"UTGame.UTMutator_SuperBerserk"

Default value, index 12:

Member	Value
MutClass	"UTGame.UTMutator_Survival"

Default value, index 13:

Member	Value
MutClass	"UTGame.UTMutator_Hero"

Default value, index 14:

Member	Value
MutClass	"UTGame.UTMutator_WeaponsRespawn"

Votes

Type: array<MapVoteInfo>

Modifiers: deprecated

VRIClass

Type: class<UTVoteReplicationInfo>

Default value: Class'UTGame.UTVoteReplicationInfo'

VRIList

Type: array<UTVoteReplicationInfo>

WinningIndex

Type: int

The winning map vote index

Default value: -1

Default values

Property	Value
CollisionType	COLLIDE_CustomDefault

Subobjects

Sprite

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

Structs

GameVoteInfo

Modifiers: native

Information about a game vote

byte GameIdx 

The index into 'UTMapListManager.AvailableGameProfiles' of the gametype being voted for

int NumVotes 

The total number of votes this gametype currently has

KickVoteInfo

Modifiers: native

Information about a kickvote

int PlayerID 

The ID of the player being voted against

byte NumVotes 

The number of votes against the player

MapVoteInfo

Modifiers: native

The collection of maps + votes (used in the old and new vote systems)

int MapID 

An INT id that represents this map.

string Map 

The Name of the map

byte NoVotes 

Number of votes this map has

Default values:

Property	Value
MapID	-1

MutatorProfile

Modifiers: native

Config structs

string MutClass 

The mutator class this profile uses, must be in the format: 'Package.Class'

string MutName 

The displayed mutator name (e.g. "Instagib")

MutatorVoteInfo

Modifiers: native

Information about a mutator vote

byte MutIdx 

Index into 'VotableMutators' (for retrieving the mutator class and display name)

int ProviderIdx 

Index into the 'MutProviders' list, for retrieving description data on request for clients

byte NumVotes 

The current number of votes for this mutator

bool bIsActive 

Whether or not the mutator is currently running; determines whether votes are for enabling or disabling the mutator

Functions

Native functions

GetMapIndex

native function int GetMapIndex (int MapID)

Other instance functions

See UTVoteCollector instance functions.

States

GameVoteRound

GameVoteRound.BeginState

event BeginState (name PreviousStateName)

Overrides: Object.BeginState (global)

Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).

GameVoteRound.EndState

event EndState (name NextStateName)

Overrides: Object.EndState (global)

Called immediately before going out of the current state, while within the GotoState() call that caused the state change, and before BeginState() is called within the new state.

GameVoteRound.BeginVoteCountdown

function BeginVoteCountdown (optional bool bInCountdown)

Overrides: BeginVoteCountdown (global)

GameVoteRound.EndVoteCountdown

function EndVoteCountdown ()

Overrides: EndVoteCountdown (global)

GameVoteRound.NotifyAllPlayersVoted

function NotifyAllPlayersVoted ()

Overrides: NotifyAllPlayersVoted (global)

MainVoteRound

MainVoteRound.BeginState

event BeginState (name PreviousStateName)

Overrides: Object.BeginState (global)

Called immediately when entering a state, while within the GotoState() call that caused the state change (before any state code is executed).

MainVoteRound.EndState

event EndState (name NextStateName)

Overrides: Object.EndState (global)

Called immediately before going out of the current state, while within the GotoState() call that caused the state change, and before BeginState() is called within the new state.

MainVoteRound.BeginVoteCountdown

function BeginVoteCountdown (optional bool bInCountdown)

Overrides: BeginVoteCountdown (global)

MainVoteRound.EndVoteCountdown

function EndVoteCountdown ()

Overrides: EndVoteCountdown (global)

MainVoteRound.NotifyAllPlayersVoted

function NotifyAllPlayersVoted ()

Overrides: NotifyAllPlayersVoted (global)