UCameraAnimationCameraModifier Class Reference

A camera modifier that plays camera animation sequences. More...

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UCameraModifier
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Camera Animation
void	StopCameraAnimation (FCameraAnimationHandle Handle, bool bImmediate=false)
	Stops the given camera animation instance.
FCameraAnimationHandle	PlayCameraAnimation (UCameraAnimationSequence Sequence, FCameraAnimationParams Params)
	Play a new camera animation sequence.
void	StopAllCameraAnimations (bool bImmediate=false)
	Stop all camera animation instances.
void	StopAllCameraAnimationsOf (UCameraAnimationSequence Sequence, bool bImmediate=false)
	Stop playing all instances of the given camera animation sequence.
bool	IsCameraAnimationActive (FCameraAnimationHandle Handle) const
	Returns whether the given camera animation is playing.
static UCameraAnimationCameraModifier	GetCameraAnimationCameraModifier (int PlayerIndex)
static UCameraAnimationCameraModifier	GetCameraAnimationCameraModifierFromID (int ControllerID)
static UCameraAnimationCameraModifier	GetCameraAnimationCameraModifierFromPlayerController (const APlayerController PlayerController)

Additional Inherited Members
Public Member Functions inherited from UCameraModifier
void	BlueprintModifyPostProcess (float32 DeltaTime, float32 &PostProcessBlendWeight, FPostProcessSettings &PostProcessSettings)
	Called per tick that the modifier is active to allow Blueprinted modifiers to modify the camera's postprocess effects. Scaling by Alpha happens after this in code, so no need to deal with that in the blueprint.
void	SetbDebug (bool Value)
	If true, enables certain debug visualization features.
bool	GetbExclusive () const
	If true, no other modifiers of same priority allowed.
void	SetbExclusive (bool Value)
	If true, no other modifiers of same priority allowed.
void	BlueprintModifyCamera (float32 DeltaTime, FVector ViewLocation, FRotator ViewRotation, float32 FOV, FVector &NewViewLocation, FRotator &NewViewRotation, float32 &NewFOV)
	Called per tick that the modifier is active to allow Blueprinted modifiers to modify the camera's transform. Scaling by Alpha happens after this in code, so no need to deal with that in the blueprint.
bool	IsDisabled () const
bool	IsPendingDisable () const
void	DisableModifier (bool bImmediate=false)
	Disables this modifier.
void	EnableModifier ()
	Enables this modifier.
AActor	GetViewTarget () const
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const
APlayerCameraManager	CameraOwner
	Camera this object is associated with.
float32	AlphaInTime
	When blending in, alpha proceeds from 0 to 1 over this time.
float32	AlphaOutTime
	When blending out, alpha proceeds from 1 to 0 over this time.
float32	Alpha
	Current blend alpha.
const AActor	ViewTarget
bool	bExclusive
	If true, no other modifiers of same priority allowed.
uint8	Priority
	Priority value that determines the order in which modifiers are applied. 0 = highest priority, 255 = lowest.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Detailed Description

A camera modifier that plays camera animation sequences.

Member Function Documentation

GetCameraAnimationCameraModifier()

UCameraAnimationCameraModifier GetCameraAnimationCameraModifier ( int PlayerIndex )

static

GetCameraAnimationCameraModifierFromID()

UCameraAnimationCameraModifier GetCameraAnimationCameraModifierFromID ( int ControllerID )

static

GetCameraAnimationCameraModifierFromPlayerController()

UCameraAnimationCameraModifier GetCameraAnimationCameraModifierFromPlayerController ( const APlayerController PlayerController )

static

IsCameraAnimationActive()

bool IsCameraAnimationActive

(

FCameraAnimationHandle

Handle

)

const

Returns whether the given camera animation is playing.

Parameters

Handle

A handle to a previously started camera animation.

Returns

Whether the corresponding camera animation is playing or not.

PlayCameraAnimation()

FCameraAnimationHandle PlayCameraAnimation	(	UCameraAnimationSequence	Sequence,
		FCameraAnimationParams	Params )

Play a new camera animation sequence.

Parameters

Sequence	The sequence to use for the new camera animation.
Params	The parameters for the new camera animation instance.

StaticClass()

UClass StaticClass ( )

static

StopAllCameraAnimations()

void StopAllCameraAnimations

(

bool

bImmediate = false

)

Stop all camera animation instances.

Parameters

bImmediate

True to stop it right now and ignore blend out, false to let it blend out as indicated.

StopAllCameraAnimationsOf()

void StopAllCameraAnimationsOf	(	UCameraAnimationSequence	Sequence,
		bool	bImmediate = false )

Stop playing all instances of the given camera animation sequence.

Parameters

Sequence	The sequence of which to stop all instances.
bImmediate	True to stop it right now and ignore blend out, false to let it blend out as indicated.

StopCameraAnimation()

void StopCameraAnimation	(	FCameraAnimationHandle	Handle,
		bool	bImmediate = false )

Stops the given camera animation instance.

Parameters

bImmediate

True to stop it right now and ignore blend out, false to let it blend out as indicated.