Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > ALevelScriptActor > ALevelScriptActor::SetCinematicMode

Light Theme

Dark Theme

ALevelScriptActor::SetCinematicMode

Sets the cinematic mode on all PlayerControllers

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/LevelScriptActor.h
Include	#include "Engine/LevelScriptActor.h"
Source	/Engine/Source/Runtime/Engine/Private/LevelScriptActor.cpp

Syntax

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

Remarks

Sets the cinematic mode on all PlayerControllers

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