Class PlayerState

A PlayerState is created for every player on a server (or in a standalone game).

Inheritance
System.Object
UObject
Actor
Info
PlayerState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class PlayerState : Info
Remarks

PlayerStates are replicated to all clients, and contain network game relevant information about the player, such as playername, score, etc.

Properties

| Improve this Doc View Source

bFromPreviousLevel

Declaration
public bool bFromPreviousLevel { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsABot

Declaration
public bool bIsABot { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsInactive

Declaration
public bool bIsInactive { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsSpectator

Declaration
public bool bIsSpectator { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bOnlySpectator

Declaration
public bool bOnlySpectator { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShouldUpdateReplicatedPing

Declaration
public bool bShouldUpdateReplicatedPing { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static PlayerState DefaultObject { get; }
Property Value
Type Description
PlayerState
| Improve this Doc View Source

EngineMessageClass

This is used for sending game agnostic messages that can be localized

Declaration
public SubclassOf<LocalMessage> EngineMessageClass { get; set; }
Property Value
Type Description
SubclassOf<LocalMessage>
| Improve this Doc View Source

PawnPrivate

The pawn that is controlled by by this player state.

Declaration
public Pawn PawnPrivate { get; }
Property Value
Type Description
Pawn
| Improve this Doc View Source

Ping

Replicated compressed ping for this player (holds ping in msec divided by 4)

Declaration
public byte Ping { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

PlayerId

Unique net id number. Actual value varies based on current online subsystem, use it only as a guaranteed unique number per player.

Declaration
public int PlayerId { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Score

Player's current score.

Declaration
public float Score { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

StartTime

Elapsed time on server when this PlayerState was first created.

Declaration
public int StartTime { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

UniqueId

The id used by the network to uniquely identify a player.

Declaration
public UniqueNetIdRepl UniqueId { get; set; }
Property Value
Type Description
UniqueNetIdRepl
Remarks

NOTE: the internals of this property should never be exposed to the player as it's transient and opaque in meaning (ie it might mean date/time followed by something else). It is OK to use and pass around this property, though.

Methods

| Improve this Doc View Source

GetPlayerName()

returns current player name

Declaration
public string GetPlayerName()
Returns
Type Description
System.String
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static PlayerState New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
PlayerState

Events

| Improve this Doc View Source

ReceiveCopyProperties

  • Can be implemented in Blueprint Child to move more properties from old to new PlayerState when traveling to a new level
  • @
Declaration
public event PlayerState.ReceiveCopyProperties_delegate ReceiveCopyProperties
Event Type
Type Description
PlayerState.ReceiveCopyProperties_delegate
Remarks

param NewPlayerState New PlayerState, which we fill with the current properties

| Improve this Doc View Source

ReceiveOverrideWith

  • Can be implemented in Blueprint Child to move more properties from old to new PlayerState when reconnecting
  • @
Declaration
public event PlayerState.ReceiveOverrideWith_delegate ReceiveOverrideWith
Event Type
Type Description
PlayerState.ReceiveOverrideWith_delegate
Remarks

param OldPlayerState Old PlayerState, which we use to fill the new one with

Operators

| Improve this Doc View Source

Implicit(IntPtr to PlayerState)

Convert from IntPtr to UObject

Declaration
public static implicit operator PlayerState(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
PlayerState