1. Epic GamesDeveloper
  3. APlayerState

APlayerState

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

Unreal Engine C++ API Reference > Runtime > Engine > GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerState.h
Include #include "GameFramework/PlayerState.h"

Syntax

UCLASS (BlueprintType, Blueprintable, NotPlaceable, MinimalAPI)  
class APlayerState : public AInfo

Remarks

A PlayerState is created for every player on a server (or in a standalone game). PlayerStates are replicated to all clients, and contain network game relevant information about the player, such as playername, score, etc.

Variables

  Type Name Description
Public variable UProperty Replicated uint8: 1 bFromPreviousLevel Indicates this is a PlayerState from the previous level of a seamless travel, waiting for the player to finish the transition before creating a new one this is used to avoid preserving the PlayerState in the InactivePlayerArray if the player leaves
Public variable uint8: 1 bHasBeenWelcomed Client side flag - whether this player has been welcomed or not (player entered message)
Public variable UProperty Category Replicated blueprintgetter uint8: 1 bIsABot True if this PlayerState is associated with an AIController
Public variable UProperty replicatedusing uint8: 1 bIsInactive Means this PlayerState came from the GameMode's InactivePlayerArray
Public variable UProperty Category Replicated blueprintgetter uint8: 1 bIsSpectator Whether this player is currently a spectator
Public variable UProperty Replicated uint8: 1 bOnlySpectator Whether this player can only ever be a spectator
Public variable uint8: 1 bUseCustomPlayerNames If set, GetPlayerName() will call virtual GetPlayerNameCustom() to allow custom access
Public variable UProperty TSubclassOf< class ULocalMessage > EngineMessageClass This is used for sending game agnostic messages that can be localized
Public variable float ExactPing Exact ping in milliseconds as float (rounded and compressed in replicated CompressedPing)
Public variable UProperty Category BlueprintAssignable FOnPlayerStatePawnSet OnPawnSet Broadcast whenever this player's possessed pawn is set
Public variable UProperty Category blueprintgetter, replicatedusing int32 PlayerId Unique net id number.
Public variable UProperty FString SavedNetworkAddress Used to match up InactivePlayerState with rejoining playercontroller.
Public variable UProperty Category blueprintgetter, replicatedusing float Score Player's current score.
Public variable FName SessionName The session that the player needs to join/remove from as it is created/leaves
Public variable UProperty Replicated int32 StartTime Elapsed time on server when this PlayerState was first created.
Public variable UProperty replicatedusing FUniqueNetIdRepl UniqueId The id used by the network to uniquely identify a player.

Constructors

  Type Name Description
Public function  

APlayerState ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual   Destructor for handling property deprecation, please remove after all deprecated properties are gone

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category, Meta FUniqueNetIdRepl Gets the online unique id for a player.
Public function Virtual void Called by Controller when its PlayerState is initially replicated.
Protected function Virtual void

CopyProperties ( APlayerState* PlayerState
)

 Copy properties which need to be saved in inactive PlayerState
Public function void  
Public function void Calls OverrideWith and triggers OnOverrideWith for BP extension
Public function Virtual APlayerState * Create duplicate PlayerState (for saving Inactive PlayerState)
Public function Const UFunction blueprintgetter uint8 Gets the literal value of the compressed Ping value (Ping = PingInMS / 4).
Public function Virtual Const FString Returns previous player name
Public function Const AController * Returns the AI or player controller that created this player state, or null for remote clients
Public function Const T *

GetPawn ()

 Convenience helper to return a cast version of the pawn controlled by this Player State.
Public function Const UFunction BlueprintCallable, Category APawn *

GetPawn ()

 Return the pawn controlled by this Player State.
Public function Const UFunction BlueprintCallable, Category float Returns the ping (in milliseconds)
Public function Const UFunction BlueprintCallable, Category APlayerController * Return the player controller that created this player state, or null for remote clients
Public function Const UFunction blueprintgetter int32 Gets the literal value of PlayerId.
Public function Const UFunction BlueprintPure, Category FString Returns current player name
Public function Virtual Const FString Custom access to player name, called only when bUseCustomPlayerNames is set
Public function Const UFunction blueprintgetter float Gets the literal value of Score.
Public function Const int32 Gets the literal value of StartTime.
Public function Const const FUniqueNetIdRepl & Gets the literal value of UniqueId.
Protected function Virtual void Called after receiving player name
Public function Const UFunction blueprintgetter bool

IsABot ()

 Gets the literal value of bIsABot.
Public function Const bool Gets the literal value of bFromPreviousLevel.
Public function Const bool Gets the literal value of bIsInactive.
Public function Const UFunction BlueprintCallable, Category bool Gets the literal value of bOnlySpectator.
Public function Virtual Const bool Return true if PlayerState is primary (ie. non-splitscreen) player
Public function Const UFunction blueprintgetter bool Gets the literal value of bIsSpectator.
Public function Virtual void Called on the server when the owning player has disconnected, by default this method destroys this player state
Public function Virtual void Called on the server when the owning player has reconnected and this player state is added to the active players array
Public function Virtual UFunction void  
Public function Virtual UFunction void  
Public function Virtual UFunction void  
Public function Virtual UFunction void Replication Notification Callbacks
Public function Virtual UFunction void  
Public function Virtual void Called on both the client and server when unique ID has been modified
Protected function Virtual void

OverrideWith ( APlayerState* PlayerState
)

  
Public function Virtual void Recalculates the replicated Ping value once per second (both clientside and serverside), based upon collected ping data
Protected function UFunction Category, Meta, BlueprintImplementableEvent void

ReceiveCopyProperties ( APlayerState* NewPlayerState
)

 Can be implemented in Blueprint Child to move more properties from old to new PlayerState when traveling to a new level
Protected function UFunction Category, Meta, BlueprintImplementableEvent void

ReceiveOverrideWith ( APlayerState* OldPlayerState
)

 Can be implemented in Blueprint Child to move more properties from old to new PlayerState when reconnecting
Public function Virtual void

RegisterPlayerWithSession ( bool bWasFromInvite
)

 Register a player with the online subsystem
Public function Virtual void

SeamlessTravelTo ( APlayerState* NewPlayerState
)

 Called by seamless travel when initializing a player on the other side - copy properties to the new PlayerState that should persist
Public function void

SetCompressedPing ( const uint8 NewPing
)

 Sets the value of CompressedPing without causing other side effects to this instance.
Public function void

SetIsABot ( const bool bNewIsABot
)

 Sets the value of bIsABot without causing other side effects to this instance.
Public function void

SetIsFromPreviousLevel ( const bool bNewFromPreviousLevel
)

 Sets the value of bFromPreviousLevel without causing other side effects to this instance.
Public function void

SetIsInactive ( const bool bNewInactive
)

 Sets the value of bIsInactive without causing other side effects to this instance.
Public function void

SetIsOnlyASpectator ( const bool bNewSpectator
)

 Sets the value of bOnlySpectator without causing other side effects to this instance.
Public function void

SetIsSpectator ( const bool bNewSpectator
)

 Sets the value of bIsSpectator without causing other side effects to this instance.
Public function Virtual void

SetOldPlayerName ( const FString& S
)

 Set the player name to S
Public function void

SetPlayerId ( const int32 NewId
)

 Sets the value of PlayerId without causing other side effects to this instance.
Public function Virtual void

SetPlayerName ( const FString& S
)

 Set the player name to S
Public function Virtual void Set the player name to S locally, does not trigger net updates
Public function void

SetScore ( const float NewScore
)

 Sets the value of Score without causing other side effects to this instance.
Protected function void

SetShouldUpdateReplicatedPing ( bool bInShouldUpdateReplicatedPing
)

 Sets whether or not the replicated ping value is updated automatically.
Public function void

SetStartTime ( const int32 NewStartTime
)

 Sets the value of StartTime without causing other side effects to this instance.
Public function void

SetUniqueId ( const FUniqueNetIdRepl& NewUniqueId
)

 Associate an online unique id with this player
Public function void

SetUniqueId ( FUniqueNetIdRepl&& NewUniqueId
)

 Associate an online unique id with this player
Public function Virtual bool

ShouldBroadCastWelcomeMessage ( bool bExiting
)

 Returns true if should broadcast player welcome/left messages.
Public function Virtual void Unregister a player with the online subsystem
Public function Virtual void

UpdatePing ( float InPing
)

 Receives ping updates for the client (both clientside and serverside), from the net driver NOTE: This updates much more frequently clientside, thus the clientside ping will often be different to what the server displays

Overridden from AActor

  Type Name Description
Public function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Public function Virtual Const FString Returns the human readable string representation of an object.
Public function Virtual void Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
Public function Virtual void

Reset ()

 Reset actor to initial state - used when restarting level without reloading.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns the properties used for network replication, this needs to be overridden by all actor classes with native replicated properties

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.