502 Bad Gateway

nginx

SetCinematicMode

Function Overloads

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/APlayerController

Overloads

Name Remarks Include Path Unreal Specifiers

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

 Adjust input based on cinematic mode GameFramework/PlayerController.h  

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

 Server/SP only function for changing whether the player is in cinematic mode. GameFramework/PlayerController.h
  • BlueprintCallable
  • Category="Game|Cinematic"
  • Meta=(bHidePlayer="true", bAffectsHUD="true")

SetCinematicMode(bool, bool, bool)

Description

Adjust input based on cinematic mode

   
Name SetCinematicMode
Type function
Header File /Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerController.h
Include Path #include "GameFramework/PlayerController.h" 
virtual void SetCinematicMode  
(  
    bool bInCinematicMode,  
    bool bAffectsMovement,  
    bool bAffectsTurning  
)

Parameters

Name Remarks
bInCinematicMode specify true if the player is entering cinematic mode; false if the player is leaving cinematic mode.
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

SetCinematicMode(bool, bool, bool, bool, bool)

Description

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.

   
Name SetCinematicMode
Type function
Header File /Engine/Source/Runtime/Engine/Classes/GameFramework/PlayerController.h
Include Path #include "GameFramework/PlayerController.h" 
UFUNCTION (BlueprintCallable, Category="Game|Cinematic",  
          Meta=(bHidePlayer="true", bAffectsHUD="true"))  
virtual void SetCinematicMode  
(  
    bool bInCinematicMode,  
    bool bHidePlayer,  
    bool bAffectsHUD,  
    bool bAffectsMovement,  
    bool bAffectsTurning  
)

Parameters

Name Remarks
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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page