UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FLockedViewState Class Reference

Public Member Functions

bool GetViewPoint (ULocalPlayer const *Player, FVector &OutViewLocation, FRotator &OutViewRotation, float &OutFOV)
 
bool IsViewLocked (ULocalPlayer const *Player)
 
void UnlockView (ULocalPlayer *Player)
 
void LockView (ULocalPlayer *Player, const TArray< FString > &Args)
 

Static Public Member Functions

static FLockedViewStateGet ()
 

Detailed Description

Singleton managing saved locked views and the current per-player state.

Member Function Documentation

◆ Get()

static FLockedViewState & FLockedViewState::Get ( )
inlinestatic

Singleton accessor.

◆ GetViewPoint()

bool FLockedViewState::GetViewPoint ( ULocalPlayer const *  Player,
FVector OutViewLocation,
FRotator OutViewRotation,
float OutFOV 
)
inline

Retrieves the locked view point for the given player.

Parameters
PlayerThe player for which to retrieve the locked view point.
OutViewLocationThe location at which the view was locked.
OutViewRotationThe rotation at which the view was locked.
OutFOVThe FOV at which the view was locked.
Returns
true if the view is locked, false if it is not.

◆ IsViewLocked()

bool FLockedViewState::IsViewLocked ( ULocalPlayer const *  Player)
inline

Returns true if the player's viewpoint is locked.

◆ LockView()

void FLockedViewState::LockView ( ULocalPlayer Player,
const TArray< FString > &  Args 
)
inline

Processes a LockView console command.

Parameters
PlayerThe player for which the command was given.
ArgsArguments to the LockView command.

◆ UnlockView()

void FLockedViewState::UnlockView ( ULocalPlayer Player)
inline

Forces the player's view to be unlocked.


The documentation for this class was generated from the following file: