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

Public Attributes
SimCache
const float32	StartSeconds
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

NiagaraSimCache
const TArray< FName >	EmitterNames
	Returns a list of emitters we have captured in the SimCache.
const int	NumEmitters
	Get number of emitters stored inside the cache.
const int	NumFrames
	Get number of frames stored in the cache.
const ENiagaraSimCacheAttributeCaptureMode	AttributeCaptureMode
	How were the attributes captured for this sim cache.
void	ReadIDAttribute (TArray< FNiagaraID > &OutValues, FName AttributeName, FName EmitterName, int FrameIndex=0) const
	Reads Niagara ID attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.
FName	GetEmitterName (int EmitterIndex) const
	Get the emitter name at the provided index.
TArray< FName >	GetEmitterNames () const
	Returns a list of emitters we have captured in the SimCache.
int	GetNumEmitters () const
	Get number of emitters stored inside the cache.
int	GetNumFrames () const
	Get number of frames stored in the cache.
float32	GetStartSeconds () const
	Get the time the simulation was at when recorded.
bool	IsCacheValid () const
	A valid cache is one that contains at least 1 frames worth of data.
bool	IsEmpty () const
	An empty cache contains no frame data and can not be used.
void	ReadColorAttribute (TArray< FLinearColor > &OutValues, FName AttributeName=FName(""), FName EmitterName=NAME_None, int FrameIndex=0) const
	Reads Niagara Color attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.
void	ReadFloatAttribute (TArray< float32 > &OutValues, FName AttributeName, FName EmitterName, int FrameIndex=0) const
	Reads Niagara float attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.
ENiagaraSimCacheAttributeCaptureMode	GetAttributeCaptureMode () const
	How were the attributes captured for this sim cache.
void	ReadIntAttribute (TArray< int > &OutValues, FName AttributeName, FName EmitterName, int FrameIndex=0) const
	Reads Niagara int attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.
void	ReadPositionAttribute (TArray< FVector > &OutValues, FName AttributeName=FName(""), FName EmitterName=NAME_None, bool bLocalSpaceToWorld=true, int FrameIndex=0) const
	Reads Niagara Position attributes by name from the cache frame and appends them into the OutValues array. Local space emitters provide data at local locations unless bLocalSpaceToWorld is true. EmitterName - If left blank will return the system simulation attributes. LocalSpaceToWorld - Caches are always stored in the emitters space, i.e. local or world space. You can set this to false if you want the local position rather than the world position.
void	ReadPositionAttributeWithRebase (TArray< FVector > &OutValues, FTransform Transform, FName AttributeName=FName(""), FName EmitterName=NAME_None, int FrameIndex=0) const
	Reads Niagara Position attributes by name from the cache frame and appends them into the OutValues array. All attributes read with this method will be re-based from the captured space into the provided transform space, this will occur even if the cache was not captured with re-basing enabled. EmitterName - If left blank will return the system simulation attributes.
void	ReadQuatAttribute (TArray< FQuat > &OutValues, FName AttributeName=FName(""), FName EmitterName=NAME_None, bool bLocalSpaceToWorld=true, int FrameIndex=0) const
	Reads Niagara Quaternion attributes by name from the cache frame and appends them into the OutValues array. Local space emitters provide data at local rotation unless bLocalSpaceToWorld is true. EmitterName - If left blank will return the system simulation attributes. LocalSpaceToWorld - Caches are always stored in the emitters space, i.e. local or world space. You can set this to false if you want the local Quat rather than the world Quat.
void	ReadQuatAttributeWithRebase (TArray< FQuat > &OutValues, FQuat Quat, FName AttributeName=FName(""), FName EmitterName=NAME_None, int FrameIndex=0) const
	Reads Niagara Quaternion attributes by name from the cache frame and appends them into the OutValues array. Only attributes that in the rebase list will be transform into the provided Quat space. Therefore the cache must be captured with rebasing enabled to have any impact. EmitterName - If left blank will return the system simulation attributes.
void	ReadVector2Attribute (TArray< FVector2D > &OutValues, FName AttributeName, FName EmitterName, int FrameIndex=0) const
	Reads Niagara Vec2 attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.
void	ReadVector4Attribute (TArray< FVector4 > &OutValues, FName AttributeName, FName EmitterName, int FrameIndex=0) const
	Reads Niagara Vec4 attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.
void	ReadVectorAttribute (TArray< FVector > &OutValues, FName AttributeName, FName EmitterName, int FrameIndex=0) const
	Reads Niagara Vec3 attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.

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

Member Function Documentation

◆ GetAttributeCaptureMode()

ENiagaraSimCacheAttributeCaptureMode GetAttributeCaptureMode ( ) const

How were the attributes captured for this sim cache.

◆ GetEmitterName()

FName GetEmitterName ( int EmitterIndex ) const

Get the emitter name at the provided index.

◆ GetEmitterNames()

TArray< FName > GetEmitterNames ( ) const

Returns a list of emitters we have captured in the SimCache.

◆ GetNumEmitters()

int GetNumEmitters ( ) const

Get number of emitters stored inside the cache.

◆ GetNumFrames()

int GetNumFrames ( ) const

Get number of frames stored in the cache.

◆ GetStartSeconds()

float32 GetStartSeconds ( ) const

Get the time the simulation was at when recorded.

◆ IsCacheValid()

bool IsCacheValid ( ) const

A valid cache is one that contains at least 1 frames worth of data.

◆ IsEmpty()

bool IsEmpty ( ) const

An empty cache contains no frame data and can not be used.

◆ ReadColorAttribute()

void ReadColorAttribute	(	TArray< FLinearColor > &	OutValues,
		FName	AttributeName = FName ( "" ),
		FName	EmitterName = NAME_None,
		int	FrameIndex = 0 ) const

Reads Niagara Color attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.

◆ ReadFloatAttribute()

void ReadFloatAttribute	(	TArray< float32 > &	OutValues,
		FName	AttributeName,
		FName	EmitterName,
		int	FrameIndex = 0 ) const

Reads Niagara float attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.

◆ ReadIDAttribute()

void ReadIDAttribute	(	TArray< FNiagaraID > &	OutValues,
		FName	AttributeName,
		FName	EmitterName,
		int	FrameIndex = 0 ) const

Reads Niagara ID attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.

◆ ReadIntAttribute()

void ReadIntAttribute	(	TArray< int > &	OutValues,
		FName	AttributeName,
		FName	EmitterName,
		int	FrameIndex = 0 ) const

Reads Niagara int attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.

◆ ReadPositionAttribute()

void ReadPositionAttribute	(	TArray< FVector > &	OutValues,
		FName	AttributeName = FName ( "" ),
		FName	EmitterName = NAME_None,
		bool	bLocalSpaceToWorld = true,
		int	FrameIndex = 0 ) const

Reads Niagara Position attributes by name from the cache frame and appends them into the OutValues array. Local space emitters provide data at local locations unless bLocalSpaceToWorld is true. EmitterName - If left blank will return the system simulation attributes. LocalSpaceToWorld - Caches are always stored in the emitters space, i.e. local or world space. You can set this to false if you want the local position rather than the world position.

◆ ReadPositionAttributeWithRebase()

void ReadPositionAttributeWithRebase	(	TArray< FVector > &	OutValues,
		FTransform	Transform,
		FName	AttributeName = FName ( "" ),
		FName	EmitterName = NAME_None,
		int	FrameIndex = 0 ) const

Reads Niagara Position attributes by name from the cache frame and appends them into the OutValues array. All attributes read with this method will be re-based from the captured space into the provided transform space, this will occur even if the cache was not captured with re-basing enabled. EmitterName - If left blank will return the system simulation attributes.

◆ ReadQuatAttribute()

void ReadQuatAttribute	(	TArray< FQuat > &	OutValues,
		FName	AttributeName = FName ( "" ),
		FName	EmitterName = NAME_None,
		bool	bLocalSpaceToWorld = true,
		int	FrameIndex = 0 ) const

Reads Niagara Quaternion attributes by name from the cache frame and appends them into the OutValues array. Local space emitters provide data at local rotation unless bLocalSpaceToWorld is true. EmitterName - If left blank will return the system simulation attributes. LocalSpaceToWorld - Caches are always stored in the emitters space, i.e. local or world space. You can set this to false if you want the local Quat rather than the world Quat.

◆ ReadQuatAttributeWithRebase()

void ReadQuatAttributeWithRebase	(	TArray< FQuat > &	OutValues,
		FQuat	Quat,
		FName	AttributeName = FName ( "" ),
		FName	EmitterName = NAME_None,
		int	FrameIndex = 0 ) const

Reads Niagara Quaternion attributes by name from the cache frame and appends them into the OutValues array. Only attributes that in the rebase list will be transform into the provided Quat space. Therefore the cache must be captured with rebasing enabled to have any impact. EmitterName - If left blank will return the system simulation attributes.

◆ ReadVector2Attribute()

void ReadVector2Attribute	(	TArray< FVector2D > &	OutValues,
		FName	AttributeName,
		FName	EmitterName,
		int	FrameIndex = 0 ) const

Reads Niagara Vec2 attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.

◆ ReadVector4Attribute()

void ReadVector4Attribute	(	TArray< FVector4 > &	OutValues,
		FName	AttributeName,
		FName	EmitterName,
		int	FrameIndex = 0 ) const

Reads Niagara Vec4 attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.

◆ ReadVectorAttribute()

void ReadVectorAttribute	(	TArray< FVector > &	OutValues,
		FName	AttributeName,
		FName	EmitterName,
		int	FrameIndex = 0 ) const

Reads Niagara Vec3 attributes by name from the cache frame and appends them into the OutValues array. EmitterName - If left blank will return the system simulation attributes.

◆ StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

◆ AttributeCaptureMode

const ENiagaraSimCacheAttributeCaptureMode AttributeCaptureMode