Always snap to grid

UE3:UTVoteReplicationInfo (UT3)

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

Contents

Package: 
UTGame

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

Properties

bGameVotingEnabled

Type: bool


bGameVotingReady

Type: bool

Set when all gamevote info has finished transferring

bKickVotingEnabled

Type: bool


bMapVotePending

Type: bool


bMapVotingEnabled

Type: bool


bMapVotingReady

Type: bool

Set when all mapvote info has finished transferring

bMutatorVotingEnabled

Type: bool


bMutatorVotingReady

Type: bool

As above, but relating to mutator voting

bOldClient

Type: bool


bSupportsNewVoting

Type: bool

Whether or not the client is compatible with the new vote and replication systems

bTransfersEnabled

Type: bool

Whether or not transferring has begun

bTransferTimerActive

Type: bool

Whether or not the main transfer timer (which controls the rate of transfer) is active

bVotingAllowed

Type: bool

Random client/server vote status information

bVotingOver

Type: bool


Collector

Type: UTVoteCollector

Cached reference to the vote collector

CompletedTransfers

Type: array<name>

The names of transfer states which have completed transferring

CurGameVoteIndex

Type: byte

Information about the clients active votes

Default value: 255

CurKickVoteIDs

Type: array<int>

The list of PlayerID's the client has contributed kickvotes for

CurMapVoteIndex

Type: byte

Index of the clients current map vote

Default value: 255

CurMutVoteIndicies

Type: array<byte>

The indicies representing mutators the client has voted

dummy

Type: int


ElementIndex

Type: byte

Serverside transfer progress/state tracking variables

GameVotes

Type: array<LocalGameEntry>

Local vote information

KickVoteCounter

Type: int


KickVoteHistory

Type: array<int>


KickVotes

Type: array<UTVoteCollector.KickVoteInfo>

Current kick votes

LastConfirmedState

Type: name

The last state which the client has reported a successful transition to

LastSendIndex

Type: int


LeadingMap

Type: string


LeadingMaps

Type: array<string>


ListIndex

Type: byte

Variables for tracking vote info transfers (usually done when the client first joins)

MapCount

Type: int

How many maps are we expecting

MapProviders

Type: array<UTUIDataProvider_MapInfo>

Cached list of map data providers, for sanitizing map names

Maps

Type: array<UTVoteCollector.MapVoteInfo>

Our local view of the map data

MapVotes

Type: array<LocalMapEntry>

Current map votes

MutatorVotePercentage

Type: int

The percentage of votes required in order to enable/disable a mutator

MutatorVotes

Type: array<LocalMutEntry>

Current mutator votes

MutProviders

Type: array<UTUIResourceDataProvider>

Cached list of mutator data providers, for retrieving localized mutator descriptions

MyCurrnetVoteID

Type: int

Modifiers: deprecated


OldOwner

Type: Actor

Used to detect the setting of the owner without RepNotifing Owner

PendingBeginVoting

Type: byte


PendingResends

Type: array<byte>

A list of transfer items which the client wants the server to resend

PendingTransferStates

Type: array<name>

Holds the names of special transfer-control states, which are waiting to become active

RecordVoteCounter

Type: int


RecordVoteTimestamp

Type: float

Vote function replication limitation

SendIndex

Type: int


TotalTransferCount

Type: int

The estimated number of times that replicated functions which will be called (for transfer timing)

TransferFailCount

Type: int

The number of failed item transfers

WinningGameIndex

Type: byte

The index into 'GameTypes' for the winning gametype

Default value: 255

WinningMapIndex

Type: byte

As above, except relating to 'MapVotes'

Default value: 255

Default values

Property Value
bSkipActorPropertyReplication False
NetUpdateFrequency 1.0
TickGroup TG_DuringAsyncWork

Structs

LocalGameEntry

Modifiers: native

string GameName 
Displayed game name
byte NumVotes 

LocalMapEntry

Modifiers: native

string MapName 
byte NumVotes 
bool bSelectable 
Whether or not this map entry can be voted for

LocalMutEntry

Modifiers: native

string MutName 
Displayed mutator name
string MutDescription 
Localized (or replicated, if localization fails) description of the mutator
byte NumVotes 
bool bIsActive 
Is the mutator currently active? Determines whether the mutator is displayed in the 'Add' or 'Remove' list

Functions

Native functions

GetMapIndex

native function int GetMapIndex (int MapID)


Events

ClientHasOwner

simulated event ClientHasOwner ()

Called when the client receives his owner. Let the server know it can begin sending maps

PostBeginPlay

simulated event PostBeginPlay ()

Overrides: Actor.PostBeginPlay


Other instance functions

See UTVoteReplicationInfo instance functions.

States

GameVoteInfoTransfer

Extends: TransferBase

GameVoteInfoTransfer.ClientBeginGameVoteTransfer

simulated reliable client function ClientBeginGameVoteTransfer (byte InGameCount)

Overrides: ClientBeginGameVoteTransfer (global)


GameVoteInfoTransfer.ClientCheckTransferStatus

simulated reliable client function ClientCheckTransferStatus ()

Overrides: ClientCheckTransferStatus (global)


GameVoteInfoTransfer.ClientReceiveGameVoteInfo

simulated reliable client function ClientReceiveGameVoteInfo (byte Index, string GameName, byte NumVotes)

Overrides: ClientReceiveGameVoteInfo (global)


GameVoteInfoTransfer.ListenInstantTransfer

function ListenInstantTransfer ()

Overrides: ListenInstantTransfer (global)


GameVoteInfoTransfer.ServerTransferComplete

reliable server function ServerTransferComplete ()

Overrides: ServerTransferComplete (global)


GameVoteInfoTransfer.StateChangeConfirmed

function StateChangeConfirmed ()

Overrides: StateChangeConfirmed (global)


GameVoteInfoTransfer.TransferTimer

function TransferTimer ()

Overrides: TransferBase.TransferTimer


MapVoteInfoTransfer

Extends: TransferBase

MapVoteInfoTransfer.ClientBeginMapVoteTransfer

simulated reliable client function ClientBeginMapVoteTransfer (byte InMapCount)

Overrides: ClientBeginMapVoteTransfer (global)


MapVoteInfoTransfer.ClientCheckTransferStatus

simulated reliable client function ClientCheckTransferStatus ()

Overrides: ClientCheckTransferStatus (global)


MapVoteInfoTransfer.ClientReceiveMapVoteInfo

simulated reliable client function ClientReceiveMapVoteInfo (byte Index, string MapName, byte NumVotes, bool bSelectable)

Overrides: ClientReceiveMapVoteInfo (global)


MapVoteInfoTransfer.ListenInstantTransfer

function ListenInstantTransfer ()

Overrides: ListenInstantTransfer (global)


MapVoteInfoTransfer.ServerTransferComplete

reliable server function ServerTransferComplete ()

Overrides: ServerTransferComplete (global)


MapVoteInfoTransfer.StateChangeConfirmed

function StateChangeConfirmed ()

Overrides: StateChangeConfirmed (global)


MapVoteInfoTransfer.TransferTimer

function TransferTimer ()

Overrides: TransferBase.TransferTimer


MutatorInfoTransfer

Extends: TransferBase

MutatorInfoTransfer.ClientBeginMutVoteTransfer

simulated reliable client function ClientBeginMutVoteTransfer (byte InMutCount, byte InMutVotePercentage)

Overrides: ClientBeginMutVoteTransfer (global)


MutatorInfoTransfer.ClientCheckTransferStatus

simulated reliable client function ClientCheckTransferStatus ()

Overrides: ClientCheckTransferStatus (global)


MutatorInfoTransfer.ClientReceiveMutDescription

simulated reliable client function ClientReceiveMutDescription (byte Index, string MutDescription)

Overrides: ClientReceiveMutDescription (global)


MutatorInfoTransfer.ClientReceiveMutVoteInfo

simulated reliable client function ClientReceiveMutVoteInfo (byte Index, string MutClass, string MutName, byte NumVotes, bool bIsActive)

Overrides: ClientReceiveMutVoteInfo (global)


MutatorInfoTransfer.ListenInstantTransfer

function ListenInstantTransfer ()

Overrides: ListenInstantTransfer (global)


MutatorInfoTransfer.ServerRequestMutDescription

reliable server function ServerRequestMutDescription (byte Index)

Overrides: ServerRequestMutDescription (global)


MutatorInfoTransfer.ServerTransferComplete

reliable server function ServerTransferComplete ()

Overrides: ServerTransferComplete (global)


MutatorInfoTransfer.StateChangeConfirmed

function StateChangeConfirmed ()

Overrides: StateChangeConfirmed (global)


MutatorInfoTransfer.TransferTimer

function TransferTimer ()

Overrides: TransferBase.TransferTimer


ReplicatingToClient

Replicate the votes to the client. We send 1 vote at a time and wait for a response.

ReplicatingToClient.BeginState

event BeginState (name PrevStateName)

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).

ReplicatingToClient.Tick

event Tick (float DeltaTime)

Overrides: Actor.Tick (global)


ReplicatingToClient.ServerAckTransfer

reliable server function ServerAckTransfer ()

Overrides: ServerAckTransfer (global)


TransferBase

TransferBase.BeginState

simulated 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).

TransferBase.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.

TransferBase.Tick

event Tick (float DeltaTime)

Overrides: Actor.Tick (global)


TransferBase.DisableTransferTimer

function DisableTransferTimer ()


TransferBase.ServerResendInfo

reliable server function ServerResendInfo (byte Index)

Overrides: ServerResendInfo (global)


TransferBase.ServerRushTransfers

reliable server function ServerRushTransfers ()

Overrides: ServerRushTransfers (global)


TransferBase.SetDesiredTransferTime

function SetDesiredTransferTime (optional int Seconds, optional int NumTransfers, optional bool bEnableTick)

Overrides: SetDesiredTransferTime (global)


TransferBase.TransferTimer

function TransferTimer ()


Voting

Voting.BeginState

event BeginState (name PrevStateName)

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).