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 > GameFramework > AGameModeBase > AGameModeBase::ShouldStartInCinematicMode

Light Theme

Dark Theme

AGameModeBase::ShouldStartInCinematicMode

Check to see if we should start in cinematic mode (e.g. matinee movie capture).

Windows

MacOS

Linux

References

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

Syntax

virtual bool ShouldStartInCinematicMode
(
    APlayerController * Player,
    bool & OutHidePlayer,
    bool & OutHideHud,
    bool & OutDisableMovement,
    bool & OutDisableTurning
)

Remarks

Check to see if we should start in cinematic mode (e.g. matinee movie capture).

Returns

bool true if we should turn on cinematic mode, false if if we should not.

Parameters

Parameter	Description
OutHidePlayer	Whether to hide the player
OutHideHud	Whether to hide the HUD
OutDisableMovement	Whether to disable movement
OutDisableTurning	Whether to disable turning

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

Take our survey

Dismiss