APlayerController::SetCinematicMode

Server/SP only function for changing whether the player is in cinematic mode.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerController.h

Include

#include "GameFramework/PlayerController.h"

Source

/Engine/Source/Runtime/Engine/Private/PlayerController.cpp

Syntax

virtual void SetCinematicMode
(
    bool bInCinematicMode,
    bool bHidePlayer,
    bool bAffectsHUD,
    bool bAffectsMovement,
    bool bAffectsTurning
)

Remarks

Server/SP only function for changing whether the player is in cinematic mode. Updates values of various state variables, then replicates the call to the client to sync the current cinematic mode.

Parameters

Parameter

Description

bInCinematicMode

specify true if the player is entering cinematic mode; false if the player is leaving cinematic mode.

bHidePlayer

specify true to hide the player's pawn (only relevant if bInCinematicMode is true)

bAffectsHUD

specify true if we should show/hide the HUD to match the value of bCinematicMode

bAffectsMovement

specify true to disable movement in cinematic mode, enable it when leaving

bAffectsTurning

specify true to disable turning in cinematic mode or enable it when leaving

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss