![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include <LocalPlayer.h>
A context object that binds to a LocalPlayer. Useful for UI or other things that need to pass around player references
| FLocalPlayerContext::FLocalPlayerContext | ( | ) |
| FLocalPlayerContext::FLocalPlayerContext | ( | const class ULocalPlayer * | InLocalPlayer, |
| UWorld * | InWorld = nullptr |
||
| ) |
| FLocalPlayerContext::FLocalPlayerContext | ( | const class APlayerController * | InPlayerController | ) |
| UGameInstance * FLocalPlayerContext::GetGameInstance | ( | ) | const |
Returns the game instance
| class AGameStateBase * FLocalPlayerContext::GetGameState | ( | ) | const |
Getter for the Game State Base
Templated Getter for the Game State
| AHUD * FLocalPlayerContext::GetHUD | ( | ) | const |
Getter for this player's HUD
Templated Getter for the HUD
| ULocalPlayer * FLocalPlayerContext::GetLocalPlayer | ( | ) | const |
Returns the local player.
| class APawn * FLocalPlayerContext::GetPawn | ( | ) | const |
Getter for the base pawn of this player
Templated getter for the player's pawn
| APlayerController * FLocalPlayerContext::GetPlayerController | ( | ) | const |
Returns the player controller.
|
inline |
Templated version of GetPlayerController()
| APlayerState * FLocalPlayerContext::GetPlayerState | ( | ) | const |
Getter for the Player State
|
inline |
Templated Getter for the Player State
| UWorld * FLocalPlayerContext::GetWorld | ( | ) | const |
Returns the world context.
This function tests if the given Actor is connected to the Local Player in any way. It tests against the APlayerController, APlayerState, and APawn.
| bool FLocalPlayerContext::IsInitialized | ( | ) | const |
Is this context initialized
| bool FLocalPlayerContext::IsValid | ( | ) | const |
Is this context initialized and still valid?