ULocalPlayer

Each player that is active on the current client/listen server has a LocalPlayer.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Engine

Inheritance Hierarchy

References

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

Syntax

UCLASS (Within=Engine, Config=Engine, Transient, MinimalAPI)  
class ULocalPlayer : public UPlayer

Remarks

Each player that is active on the current client/listen server has a LocalPlayer. It stays active across maps, and there may be several spawned in the case of splitscreen/coop. There will be 0 spawned on dedicated servers.

Variables

  Type Name Description
Public variable UProperty Config TEnumAsByte< enum EAspectRatioAxisConstraint > AspectRatioAxisConstraint How to constrain perspective viewport FOV
Public variable UProperty Category Transient visibleanywhere uint32: 1 bSentSplitJoin Set when we've sent a split join request
Public variable FUniqueNetIdRepl CachedUniqueNetId The FUniqueNetId which this player is associated with.
Public variable FVector LastViewLocation The location of the player's view the previous frame.
Public variable FVector2D Origin The coordinates for the upper left corner of the primary viewport subregion allocated to this player.
Public variable UProperty TSubclassOf< class APlayerController > PendingLevelPlayerControllerClass The class of PlayerController to spawn for players logging in.
Public variable FVector2D Size The size of the primary viewport subregion allocated to this player. 0-1
Protected variable FReply SlateOperations FReply used to defer some slate operations.
Public variable UProperty TObjectPtr< class UGameViewportClient > ViewportClient The primary viewport containing this player's view.

Constructors

  Type Name Description
Public function  

ULocalPlayer ( const FObjectInitializer& ObjectInitializer
)

  
Public function   DO NOT USE. This constructor is for internal usage only for hot-reload purposes.

Functions

  Type Name Description
Public function Static void  
Public function Virtual FSceneView *

CalcSceneView ( FSceneViewFamily* ViewFamily,
FVector& OutViewLocation,
FRotator& OutViewRotation,
FViewport* Viewport,
FViewElementDrawer* ViewDrawer,
int32 StereoViewIndex
)

 Calculate the view settings for drawing from this view actor
Public function Virtual bool

CalcSceneViewInitOptions ( FSceneViewInitOptions& OutInitOptions,
FViewport* Viewport,
FViewElementDrawer* ViewDrawer,
int32 StereoViewIndex
)

 Calculate the view init settings for drawing from this view actor
Public function Virtual void

CleanupViewState ( FStringView MidParentRootPath
)

 Clear cached view state.
Protected function void

ExecMacro ( const TCHAR* Filename,
FOutputDevice& Ar
)

  
Public function Const FUniqueNetIdRepl Retrieves this player's unique net ID that was previously cached
Public function Const int32 Returns the controller ID for the player.
Public function Const UGameInstance * Get the game instance associated with this local player
Public function Virtual Const FString Retrieves any game-specific login options for this player if this function returns a non-empty string, the returned option or options be added passed in to the level loading and connection code.
Public function Const int32 Returns the index of this player in the Game instances local players array
Public function Virtual Const int32 Returns the logical local player index where 0 is the first LocalPlayer that was created.
Public function Virtual Const FString Retrieves this player's name/tag from the online subsystem if this function returns a non-empty string, the returned name will replace the "Name" URL parameter passed around in the level loading and connection code, which normally comes from DefaultEngine.ini
Public function Static bool

GetPixelBoundingBox ( const FSceneViewProjectionData& ProjectionData,
const FBox& ActorBox,
FVector2D& OutLowerLeft,
FVector2D& OutUpperRight,
const FVector2f* OptionalAllotedSize
)

  
Public function Static bool

GetPixelBoundingBox ( const FSceneViewProjectionData& ProjectionData,
const FBox& ActorBox,
FVector2D& OutLowerLeft,
FVector2D& OutUpperRight,
FOptionalAllottedSize OptionalAllotedSize
)

  
Public function bool

GetPixelBoundingBox ( const FBox& ActorBox,
FVector2D& OutLowerLeft,
FVector2D& OutUpperRight,
FOptionalAllottedSize OptionalAllotedSize
)

  
Public function bool

GetPixelBoundingBox ( const FBox& ActorBox,
FVector2D& OutLowerLeft,
FVector2D& OutUpperRight,
const FVector2f* OptionalAllotedSize
)

 This function will give you two points in Pixel Space that surround the World Space box.
Public function bool

GetPixelPoint ( const FVector& InPoint,
FVector2D& OutPoint,
const FVector2f* OptionalAllotedSize
)

 This function will give you a point in Pixel Space from a World Space position
Public function Static bool

GetPixelPoint ( const FSceneViewProjectionData& ProjectionData,
const FVector& InPoint,
FVector2D& OutPoint,
FOptionalAllottedSize OptionalAllotedSize
)

  
Public function Static bool

GetPixelPoint ( const FSceneViewProjectionData& ProjectionData,
const FVector& InPoint,
FVector2D& OutPoint,
const FVector2f* OptionalAllotedSize
)

  
Public function bool

GetPixelPoint ( const FVector& InPoint,
FVector2D& OutPoint,
FOptionalAllottedSize OptionalAllotedSize
)

  
Public function Const FPlatformUserId Returns the platform user that is assigned to this player
Public function Virtual Const int32 Converts the platform user id to an index where 0 is the first logged in user.
Public function Virtual Const FUniqueNetIdRepl Retrieves the preferred unique net id.
Public function Virtual Const bool

GetProjectionData ( FViewport* Viewport,
FSceneViewProjectionData& ProjectionData,
int32 StereoViewIndex
)

 Helper function for deriving various bits of data needed for projection
Public function Const const FReply &  
Public function FReply & Getter for slate operations.
Public function Virtual TSharedPtr< FSlateUser > Get the SlateUser that this LocalPlayer corresponds to
Public function Virtual Const TSharedPtr< const FSlateUser >  
Public function Static TSubsystemClass *

GetSubsystem ( const ULocalPlayer* LocalPlayer
)

 Get a Subsystem of specified type from the provided LocalPlayer returns nullptr if the Subsystem cannot be found or the LocalPlayer is null
Public function Const TSubsystemClass * Get a Subsystem of specified type
Public function Const const TArray< TSubsystemClass * > & Get all Subsystem of specified type, this is only necessary for interfaces that can have multiple implementations instanced at a time.
Public function Const ULocalPlayerSubsystem * Get a Subsystem of specified type
Public function Virtual Const FUniqueNetIdRepl Retrieves this player's unique net ID from the online subsystem using the platform user Id
Public function Const FUniqueNetIdRepl This should be deprecated when engine code has been changed to expect FPlatformUserId UE_DEPRECATED(5.x, "Use GetUniqueNetIdForPlatformUser instead")
Protected function Virtual Const void

GetViewPoint ( FMinimalViewInfo& OutViewInfo
)

 Retrieve the viewpoint of this player.
Public function Virtual Const UWorld * Get the world the players actor belongs to
Public function bool

HandleDNCommand ( const TCHAR* Cmd,
FOutputDevice& Ar
)

 Exec command handlers
Public function bool

HandleExecCommand ( const TCHAR* Cmd,
FOutputDevice& Ar
)

  
Public function bool

HandleExitCommand ( const TCHAR* Cmd,
FOutputDevice& Ar
)

  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function Virtual void Called to initialize the online delegates
Public function Const bool  
Public function Const bool Determines whether this player is the first and primary player on their machine.
Public function Const FOnControllerIdChanged &  
Public function FOnPlatformUserIdChanged &  
Public function FOnPlayerControllerChanged &  
Public function Virtual void

PlayerAdded ( UGameViewportClient* InViewportClient,
int32 InControllerID
)

 Called at creation time for internal setup
Public function Virtual void

PlayerAdded ( UGameViewportClient* InViewportClient,
FPlatformUserId InUserId
)

 Called at creation time for internal setup
Public function Virtual void Called when the player is removed from the viewport client
Public function Virtual void Allow local player to run any async tasks needed before starting travel to a server.
Public function Virtual void

SendSplitJoin ( TArray< FString >& Options
)

 Send a splitscreen join command to the server to allow a splitscreen player to connect to the game the client must already be connected to a server for this function to work
Public function void

SetCachedUniqueNetId ( const FUniqueNetIdRepl& NewUniqueNetId
)

 Sets the players current cached unique net id
Public function void Sets the players current cached unique net id
Public function void Sets the players current cached unique net id
Public function Virtual void

SetControllerId ( int32 NewControllerId
)

 Change the physical ControllerId for this player; if the specified ControllerId is already taken by another player, changes the ControllerId for the other player to the ControllerId currently in use by this player.
Public function Virtual void

SetPlatformUserId ( FPlatformUserId InPlatformUserId
)

 Changes the platform user that is assigned to this player
Public function Virtual bool

SpawnPlayActor ( const FString& URL,
FString& OutError,
UWorld* InWorld
)

 Create an actor for this player.

Overridden from UPlayer

  Type Name Description
Public function Virtual void Called when this player has had it's outer Player Controller set for remote net connections

Overridden from FExec

  Type Name Description
Protected function Virtual bool

Exec_Editor ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 Implementation of Exec that is only called in editor

Classes

  Type Name Description
Public class FOnControllerIdChanged    
Public class FOnPlatformUserIdChanged Event called when this local player has been assigned to a new platform-level user  
Public class FOnPlayerControllerChanged Event called when this local player has had a new outer PlayerController set  
Public struct FOptionalAllottedSize    

Typedefs

Name Description
FOnPreBeginHandshakeCompleteDelegate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page