UGameplayCamerasSubsystem Class Reference

World subsystem that holds global objects for handling camera animation sequences. More...

Public Member Functions
Camera Animation
FCameraAnimationHandle	PlayCameraAnimation (APlayerController PlayerController, UCameraAnimationSequence Sequence, FCameraAnimationParams Params)
	Play a new camera animation sequence.
void	StopAllCameraAnimations (APlayerController PlayerController, bool bImmediate=false)
	Stop all camera animation instances.
void	StopAllCameraAnimationsOf (APlayerController PlayerController, UCameraAnimationSequence Sequence, bool bImmediate=false)
	Stop playing all instances of the given camera animation sequence.
void	StopCameraAnimation (APlayerController PlayerController, FCameraAnimationHandle Handle, bool bImmediate=false)
	Stops the given camera animation instance.
bool	IsCameraAnimationActive (APlayerController PlayerController, FCameraAnimationHandle Handle) const
	Returns whether the given camera animation is playing.
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

Static Public Member Functions
Static Functions
static UGameplayCamerasSubsystem	Get ()
static UClass	StaticClass ()
Static Public Member Functions inherited from UWorldSubsystem
static UClass	StaticClass ()
Static Public Member Functions inherited from USubsystem
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Additional Inherited Members
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

World subsystem that holds global objects for handling camera animation sequences.

Member Function Documentation

Get()

UGameplayCamerasSubsystem Get ( )

static

IsCameraAnimationActive()

bool IsCameraAnimationActive	(	APlayerController	PlayerController,
		FCameraAnimationHandle	Handle ) const

Returns whether the given camera animation is playing.

Parameters

PlayerController	The player controller on which to play the animation.
Handle	A handle to a previously started camera animation.

Returns

Whether the corresponding camera animation is playing or not.

PlayCameraAnimation()

FCameraAnimationHandle PlayCameraAnimation	(	APlayerController	PlayerController,
		UCameraAnimationSequence	Sequence,
		FCameraAnimationParams	Params )

Play a new camera animation sequence.

Parameters

PlayerController	The player controller on which to play the animation.
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	(	APlayerController	PlayerController,
		bool	bImmediate = false )

Stop all camera animation instances.

Parameters

PlayerController	The player controller on which to play the animation.
bImmediate	True to stop it right now and ignore blend out, false to let it blend out as indicated.

StopAllCameraAnimationsOf()

void StopAllCameraAnimationsOf	(	APlayerController	PlayerController,
		UCameraAnimationSequence	Sequence,
		bool	bImmediate = false )

Stop playing all instances of the given camera animation sequence.

Parameters

PlayerController	The player controller on which to play the animation.
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	(	APlayerController	PlayerController,
		FCameraAnimationHandle	Handle,
		bool	bImmediate = false )

Stops the given camera animation instance.

Parameters

PlayerController	The player controller on which to play the animation.
bImmediate	True to stop it right now and ignore blend out, false to let it blend out as indicated.