ALimenCinematicActor
Overview
ALimenCinematicActor is an abstract class that extends ALimenGameplayActor. It manages the cinematic experience by transitioning the player's view target to itself or another actor, applying post-process effects, and handling cinematic mode. This class provides a blueprint interface for starting, stopping, and canceling cinematics.
Properties
Type | Name | Access | Description |
|---|---|---|---|
| CameraComponent | EditAnywhere, BlueprintReadOnly | The camera component used during the cinematic. |
| ViewTargetInTransitionParams | EditAnywhere, BlueprintReadWrite | Parameters for transitioning to the cinematic view target. |
| ViewTargetOutTransitionParams | EditAnywhere, BlueprintReadWrite | Parameters for transitioning back from the cinematic view target. |
| CinematicCamerasPostProcessSettings | EditAnywhere, BlueprintReadWrite | Post-process settings applied to cinematic cameras. |
| bOverrideCamerasPostProcessSettings | EditAnywhere, BlueprintReadWrite | Whether to override post-process settings for cinematic cameras. |
| OriginalViewTarget | Private | The original view target before entering the cinematic mode. |
| CinematicContextPlayerController | Private | The player controller managing the cinematic context. |
| ViewTargetTransitionTimerHandle | Private | Timer handle for transitioning between view targets. |
| bIsCinematicPlaying | Private | Whether a cinematic is currently playing. |
| CinematicCameras | Private | Array of cinematic cameras with overridden post-process settings. |
Functions
Return Type | Signature | Description |
|---|---|---|
| BeginPlay() | Initializes the cinematic actor and applies post-process settings if required. |
| StartCinematic(APlayerController* InPlayerController) | Starts a cinematic by setting the view target to this actor and applying transition parameters. |
| StopCinematic() | Stops the current cinematic by restoring the original view target and applying transition parameters. |
| CancelCinematic() | Cancels the current cinematic, resetting the player controller and view target. |
| IsCinematicPlaying() const | Returns whether a cinematic is currently playing. |
| GetOriginalViewTarget() const | Returns the original view target before entering cinematic mode. |
| GetPostProcessSettings() const | Returns the post-process settings for cinematic cameras. |
| SetPostProcessSettings(const FPostProcessSettings& NewSettings) | Sets new post-process settings for cinematic cameras. |
| CinematicStart() | Blueprint-implementable event called when a cinematic starts. |
| OnViewTargetSetToSelf() | Disables input for the player's pawn when transitioning to the cinematic view target. |
| OnViewTargetRestored() | Restores input for the player's pawn and cleans up after the cinematic ends. |
| OnViewTargetSetToSelf_Internal() | Internal implementation of transitioning to the cinematic view target. |
| OnViewTargetRestored_Internal() | Internal implementation of restoring the original view target. |
Usage & Implementation Notes
Threading Constraints: This class does not have any specific threading constraints.
Replication Requirements: None.
Memory Lifetime Management: The class uses weak pointers to manage references to actors and player controllers, ensuring that memory is properly managed without causing memory leaks.
Initialization Dependencies: The
BeginPlayfunction initializes the cinematic actor by applying post-process settings if required.