I don't need to test my programs. I have an error-correcting modem.

UE3:UTPlayerReplicationInfo (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 06:24, 17 January 2010 by (Talk)

Jump to: navigation, search
UDK Object >> Actor >> Info >> ReplicationInfo >> PlayerReplicationInfo >> UTPlayerReplicationInfo
Package: 
UTGame
This class in other games:
UT3


Properties

bHolding

Type: bool

True if associated bot is currently holding its position

CharClassInfo

Type: class<UTFamilyInfo>

Modifiers: repnotify

Class that the player has chosen to be

Default value: Class'UTGame.UTFamilyInfo_Liandri_Male'

CharPortrait

Type: Texture

Texture of render of custom character head.

Default value: Texture2D'CH_IronGuard_Headshot.HUD_Portrait_Liandri'

ClanTag

Type: string

Modifiers: databinding

The clan tag for this player

DeathStats

Type: array<IntStat>

holds all death stats (this player's deaths instigated by another player, sorted by weapon/damagetype)

DefaultHudColor

Type: Object.Color

Used for revenge reward, and for avoiding respawning near killer

Default value:

Member Value
A 255
B 255
G 255
R 64

DrivingStats

Type: array<TimeStat>

Time spent driving, sorted by vehicle

EventStats

Type: array<IntStat>

holds event stats (mostly reward announcer related

HasFlag

Type: UTCarriedObject

Modifiers: private


HUDLocation

Type: Object.Vector


KillStats

Type: array<IntStat>

holds all kill stats (this player's kills, sorted by weapon/damagetype)

LastKillerPRI

Type: UTPlayerReplicationInfo


LastKillTime

Type: float


Default value: -5.0

MultiKillLevel

Type: int


NodeStats

Type: array<IntStat>

holds node captured/built/healed and core damaged/destroyed stats

OrdersIndex

Type: byte


OrdersString

Type: string

Array size: 8

Modifiers: localized


PickupStats

Type: array<IntStat>

Armor, health, and powerups picked up by this player

PowerupTimeStats

Type: array<TimeStat>

Time spent holding powerups and flag/orb

SinglePlayerCharacterIndex

Type: int

Determines which character this player will be in the single player game

Default value: -1

spree

Type: int


Squad

Type: UTSquadAI


StartObjective

Type: UTGameObjective

Modifiers: repnotify


SuicideStats

Type: array<IntStat>

holds all suicide stats (this player's suicides, sorted by weapon/damagetype)

TemporaryStartObjective

Type: UTGameObjective


VehicleKillStats

Type: array<IntStat>

Stats of vehicles killed by this player

VoiceClass

Type: class<UTVoice>


Default value: Class'UTGame.UTVoice_Robot'

Default values

Property Value
StringUnknown "Midfield"

Structs

IntStat

Modifiers: native

Stats related variables

name StatName 
int StatValue 

TimeStat

Modifiers: native

name StatName 
float TotalTime 
float CurrentStart 

Functions

Events

Destroyed

simulated event Destroyed ()

Overrides: PlayerReplicationInfo.Destroyed


GetHudColor

simulated event Object.Color GetHudColor ()


ReplicatedEvent

simulated event ReplicatedEvent (name VarName)

Overrides: PlayerReplicationInfo.ReplicatedEvent


Reset

event Reset ()

Overrides: PlayerReplicationInfo.Reset


Other instance functions

AddToNodeStat

function int AddToNodeStat (name NewStatName, int Amount)


AllowClientToTeleport

function bool AllowClientToTeleport (Actor DestinationActor, out UTPawn OwnerPawn)

The function is used to setup the conditions that allow a teleport. It also defers to the gameinfo

Parameters:

  • DestinationActor - The actor to teleport to
  • OwnerPawn - returns the pawn owned by the controlling owner casts to UTPawn

Returns:

True if the teleport is allowed

AttemptMidGameMenu

simulated function bool AttemptMidGameMenu ()


CopyProperties

function CopyProperties (PlayerReplicationInfo PRI)

Overrides: PlayerReplicationInfo.CopyProperties


GetCallSign

simulated function string GetCallSign ()


GetFlag

function UTCarriedObject GetFlag ()


GetLocationName

simulated function string GetLocationName ()

Overrides: PlayerReplicationInfo.GetLocationName


GetStartObjective

function UTGameObjective GetStartObjective ()


IncrementDeathStat

function int IncrementDeathStat (name NewStatName)


IncrementEventStat

function int IncrementEventStat (name NewStatName)


IncrementKills

function IncrementKills (bool bEnemyKill)


IncrementKillStat

function int IncrementKillStat (name NewStatName)


IncrementNodeStat

function int IncrementNodeStat (name NewStatName)


IncrementPickupStat

function int IncrementPickupStat (name NewStatName)


IncrementSuicideStat

function int IncrementSuicideStat (name NewStatName)


IncrementVehicleKillStat

function int IncrementVehicleKillStat (name NewStatName)


OverrideWith

function OverrideWith (PlayerReplicationInfo PRI)

Overrides: PlayerReplicationInfo.OverrideWith


SeamlessTravelTo

function SeamlessTravelTo (PlayerReplicationInfo NewPRI)

Overrides: PlayerReplicationInfo.SeamlessTravelTo

called by seamless travel when initializing a player on the other side - copy properties to the new PRI that should persist

ServerTeleportToActor

server reliable function ServerTeleportToActor (Actor DestinationActor)

This function is used to teleport directly to actor. Currently, only 2 types of actors support teleporting. UTGameObjectives and UTVehicle_Leviathans.

Parameters:

  • DestinationActor - This is the Actor the player is trying to teleport to

SetFlag

function SetFlag (UTCarriedObject NewFlag)


SetStartObjective

reliable server function SetStartObjective (UTGameObjective Objective, bool bTemporary)


ShouldBroadCastWelcomeMessage

simulated function bool ShouldBroadCastWelcomeMessage (optional bool bExiting)

Overrides: PlayerReplicationInfo.ShouldBroadCastWelcomeMessage

Returns true if should broadcast player welcome/left messages. Current conditions: must be a human player a network game

ShowMidGameMenu

reliable simulated client function ShowMidGameMenu (bool bInitial)


StartDrivingStat

function StartDrivingStat (name NewStatName)


StartPowerupTimeStat

function StartPowerupTimeStat (name NewStatName)


StopDrivingStat

function StopDrivingStat (name NewStatName)


StopPowerupTimeStat

function StopPowerupTimeStat (name NewStatName)


UpdatePlayerLocation

function UpdatePlayerLocation ()

Overrides: PlayerReplicationInfo.UpdatePlayerLocation