There is no spoon

UE3:UTVoteCollector (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> Actor >> Info >> UTVoteCollector

Contents

Package: 
UTGame

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

Properties[edit]

ActiveGameProfileIdx[edit]

Type: int


bAllowGameVoting[edit]

Type: bool

Modifiers: globalconfig

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

bAllowKickVoting[edit]

Type: bool

Modifiers: globalconfig

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

bAllowMapVoting[edit]

Type: bool

Modifiers: globalconfig

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

Default value: True

bAllowMutatorVoting[edit]

Type: bool

Modifiers: globalconfig

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

bAnonymousKickVoting[edit]

Type: bool

Modifiers: globalconfig

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

Default value: True

bGameVotingActive[edit]

Type: bool

Whether or not game voting is currently active

bInEndGameVote[edit]

Type: bool

As above, but relating to end game votes

bInMidGameVote[edit]

Type: bool

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

bKickVotingActive[edit]

Type: bool

Whether kick voting is active

bMapVotingActive[edit]

Type: bool

Whether map voting is active

bMidGameVoting[edit]

Type: bool

Modifiers: globalconfig

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

Default value: True

bMutatorVotingActive[edit]

Type: bool

Whether mutator voting is active

bUpdateActiveMapList[edit]

Type: bool

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

bVoteDecided[edit]

Type: bool

Whether or not the winning map vote has been decided

bVotingAllowed[edit]

Type: bool

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

ForcedGameVoteIdx[edit]

Type: int

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

Default value: -1

ForcedMapVoteIdx[edit]

Type: int

As above, except for map votes

Default value: -1

ForcedOffMutVotes[edit]

Type: array<int>

The index of mutator votes which are forced off

ForcedOnMutVotes[edit]

Type: array<int>

The index of mutator votes which are forced on

ForceEnableMapIdx[edit]

Type: int

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

Default value: -1

GameInfoRef[edit]

Type: UTGame


GameVoteDuration[edit]

Type: int

Modifiers: globalconfig

How long players are given to pick a gametype

Default value: 15

GameVotes[edit]

Type: array<GameVoteInfo>

Information about active game votes

InitialVoteDelay[edit]

Type: int

Modifiers: globalconfig

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

Default value: 30

InitialVoteTransferTime[edit]

Type: int

Modifiers: globalconfig

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

Default value: 12

KickVotePercentage[edit]

Type: int

Modifiers: globalconfig

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

Default value: 51

KickVotes[edit]

Type: array<KickVoteInfo>

Information about active kick votes

MapListManager[edit]

Type: UTMapListManager


MapVoteDuration[edit]

Type: int

Modifiers: globalconfig

How long players are given to pick a map

Default value: 30

MapVoteMapList[edit]

Type: UTMapList

The maplist used for map voting

MapVotes[edit]

Type: array<MapVoteInfo>

Information about active map votes

MidGameVotePercentage[edit]

Type: int

Modifiers: globalconfig

The percentage of votes required to initiate a map switch midgame

Default value: 51

MinKickVotes[edit]

Type: int

Modifiers: globalconfig

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

Default value: 3

MinMidGameVotes[edit]

Type: int

Modifiers: globalconfig

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

Default value: 2

MutatorVotePercentage[edit]

Type: int

Modifiers: globalconfig

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

Default value: 51

MutatorVotes[edit]

Type: array<MutatorVoteInfo>

Information about votable mutators and their vote counts

MutProviders[edit]

Type: array<UTUIResourceDataProvider>

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

PendingGameClass[edit]

Type: string


RushVoteTransferTime[edit]

Type: int

Modifiers: globalconfig

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

Default value: 3

VotableMutators[edit]

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[edit]

Type: array<MapVoteInfo>

Modifiers: deprecated


VRIClass[edit]

Type: class<UTVoteReplicationInfo>


Default value: Class'UTGame.UTVoteReplicationInfo'

VRIList[edit]

Type: array<UTVoteReplicationInfo>


WinningIndex[edit]

Type: int

The winning map vote index

Default value: -1

Default values[edit]

Property Value
CollisionType COLLIDE_CustomDefault

Subobjects[edit]

Sprite[edit]

Class: Engine.SpriteComponent

Inherits from: Info.Sprite

No new values.

Structs[edit]

GameVoteInfo[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

Native functions[edit]

GetMapIndex[edit]

native function int GetMapIndex (int MapID)


Other instance functions[edit]

See UTVoteCollector instance functions.

States[edit]

GameVoteRound[edit]

GameVoteRound.BeginState[edit]

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[edit]

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[edit]

function BeginVoteCountdown (optional bool bInCountdown)

Overrides: BeginVoteCountdown (global)


GameVoteRound.EndVoteCountdown[edit]

function EndVoteCountdown ()

Overrides: EndVoteCountdown (global)


GameVoteRound.NotifyAllPlayersVoted[edit]

function NotifyAllPlayersVoted ()

Overrides: NotifyAllPlayersVoted (global)


MainVoteRound[edit]

MainVoteRound.BeginState[edit]

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[edit]

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[edit]

function BeginVoteCountdown (optional bool bInCountdown)

Overrides: BeginVoteCountdown (global)


MainVoteRound.EndVoteCountdown[edit]

function EndVoteCountdown ()

Overrides: EndVoteCountdown (global)


MainVoteRound.NotifyAllPlayersVoted[edit]

function NotifyAllPlayersVoted ()

Overrides: NotifyAllPlayersVoted (global)