1. Epic GamesDeveloper
  3. UCameraShakeAsset

UCameraShakeAsset

API > API/Plugins > API/Plugins/GameplayCameras

   
Name UCameraShakeAsset
Type class
Header File /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/CameraShakeAsset.h
Include Path #include "Core/CameraShakeAsset.h"

Syntax

UCLASS (MinimalAPI)  
class UCameraShakeAsset :  
    public UBaseCameraObject ,  
    public IHasCameraBuildStatus ,  
    public IObjectTreeGraphObject ,  
    public IObjectTreeGraphRootObject

Inheritance Hierarchy

Implements Interfaces

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsSingleInstance bool Whether only one instance of this shake can be started via the camera shake functions. Core/CameraShakeAsset.h
  • EditAnywhere
  • Category="Common"
BlendIn TObjectPtr< USimpleFixedTimeBlendCameraNode > The blend to use for easing into the shake. Core/CameraShakeAsset.h
  • Instanced
BlendOut TObjectPtr< USimpleFixedTimeBlendCameraNode > The blend to use for easing out of the shake. Core/CameraShakeAsset.h
  • Instanced
BuildStatus ECameraBuildStatus The current build state of this camera shake. Core/CameraShakeAsset.h
  • Transient
RootNode TObjectPtr< UShakeCameraNode > Root camera node. Core/CameraShakeAsset.h
  • Instanced

Protected

Name Type Remarks Include Path Unreal Specifiers
AllNodeObjects TArray< TObjectPtr< UObject > > A list of all the camera nodes, including the 'loose' ones that aren't connected to the root node, and therefore would be GC'ed if we didn't hold them here. Core/CameraShakeAsset.h
  • Instanced
  • Meta=(ObjectTreeGraphHidden=true)
GraphNodeComment FString User-written comment in the node graph editor. Core/CameraShakeAsset.h  
GraphNodePos FIntVector2 Position of the camera shake node in the node graph editor. Core/CameraShakeAsset.h  
Guid FGuid The camera shake's unique ID. Core/CameraShakeAsset.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Builds this camera shake asset. Core/CameraShakeAsset.h  
Builds this camera shake asset. Core/CameraShakeAsset.h  

const FGuid & GetGuid()

 Gets the camera shake's unique ID. Core/CameraShakeAsset.h  

Overridden from UBaseCameraObject

Name Remarks Include Path Unreal Specifiers

virtual UCameraNode * GetRootNode()

 Get the root node of this camera object. Core/CameraShakeAsset.h  

Overridden from IHasCameraBuildStatus

Name Remarks Include Path Unreal Specifiers

virtual void DirtyBuildStatus()

 Dirties the build status of the object. Core/CameraShakeAsset.h  

virtual ECameraBuildStatus GetBuildStatus()

 Gets the build status of the object. Core/CameraShakeAsset.h  

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   Core/CameraShakeAsset.h  

virtual void PostInitProperties()

   Core/CameraShakeAsset.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   Core/CameraShakeAsset.h  

Overridden from IObjectTreeGraphObject

Name Remarks Include Path Unreal Specifiers

virtual const FString & GetGraphNodeCommentText ( FName InGraphName
) const

 Gets the graph node's comment text. Core/CameraShakeAsset.h  

virtual void GetGraphNodeName ( FName InGraphName,
FText& OutName
) const

 Gets the custom name for the graph node. Core/CameraShakeAsset.h  

virtual void GetGraphNodePosition ( FName InGraphName,
int32& NodePosX,
int32& NodePosY
) const

 Gets the canvas position for the graph node representing this object. Core/CameraShakeAsset.h  

virtual EObjectTreeGraphObjectSupportFlags GetSupportFlags ( FName InGraphName
) const

 Gets optional APIs support flags. Core/CameraShakeAsset.h  

virtual void OnGraphNodeMoved ( FName InGraphName,
int32 NodePosX,
int32 NodePosY,
bool bMarkDirty
)

 Called to save the canvas position of the graph node representing this object. Core/CameraShakeAsset.h  

virtual void OnUpdateGraphNodeCommentText ( FName InGraphName,
const FString& NewComment
)

 Called to save a new comment text. Core/CameraShakeAsset.h  

Overridden from IObjectTreeGraphRootObject

Name Remarks Include Path Unreal Specifiers

virtual void AddConnectableObject ( FName InGraphName,
UObject* InObject
)

   Core/CameraShakeAsset.h  

virtual void GetConnectableObjects ( FName InGraphName,
TSet< UObject* >& OutObjects
) const

   Core/CameraShakeAsset.h  

virtual void RemoveConnectableObject ( FName InGraphName,
UObject* InObject
)

   Core/CameraShakeAsset.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page