UAtomCueSheet Class Reference

#include <AtomCueSheet.h>

Inheritance diagram for UAtomCueSheet:

Public Member Functions
	UAtomCueSheet (const FObjectInitializer &ObjectInitializer)
virtual void	BeginDestroy () override
virtual bool	CanUnloadAtomResource () override
virtual FAtomResource *	CreateAtomResource () override
virtual void	DestroyAtomResource () override
virtual void	FinishDestroy () override
int32	GetNumCues () const
virtual int	GetNumSounds () const override
virtual const uint8 *	GetResourceData () override
virtual UAtomSoundBase *	GetSound (int Index) const override
virtual UClass *	GetSoundClass () const override
UAtomSoundCue *	GetSoundCue (int Index) const
UAtomSoundCue *	GetSoundCueByName (const FString &CueName) const
virtual bool	InitAtomResource () override
bool	IsLoaded () const
virtual bool	IsReadyForFinishDestroy () override
virtual void	PostInitProperties () override
virtual void	PostLoad () override
virtual void	RemoveAtomResource () override
virtual void	Serialize (FArchive &Ar) override
virtual bool	Validate () const
Public Member Functions inherited from UAtomSoundBank
	UAtomSoundBank (const FObjectInitializer &ObjectInitializer)
void	CacheInheritedLoadingBehavior () const
virtual void	GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const override
EAtomSoundWaveLoadingBehavior	GetLoadingBehavior () const
FByteBulkData *	GetRawData ()
virtual bool	IsRetainingResource () const
bool	IsStreaming (const FCriWareCookOverridesSettings &Overrides) const
bool	IsStreaming (const TCHAR *PlatformName=nullptr) const
virtual void	ReleaseResource ()
virtual void	RetainResource ()

Public Attributes
TArray< TObjectPtr< UAtomWaveBank > >	WaveBanks
Public Attributes inherited from UAtomSoundBank
FAtomResourceHandle	AtomResource
TSharedPtr< FThreadSafeBool, ESPMode::ThreadSafe >	bLoadingBehaviorOverriddenPtr { MakeShared<FThreadSafeBool, ESPMode::ThreadSafe>() }
EAtomSoundWaveLoadingBehavior	CachedSoundWaveLoadingBehavior { EAtomSoundWaveLoadingBehavior::Uninitialized }
EAtomSoundWaveLoadingBehavior	LoadingBehavior
FByteBulkData	RawData
FCriticalSection	RawDataCriticalSection

Private Attributes
FOwnedBulkDataPtr *	OwnedBulkDataPtr { nullptr }
const uint8 *	ResourceData { nullptr }
int32	ResourceSize
TArray< TObjectPtr< UAtomSoundCue > >	SoundCues

Friends
class	UAtomCueSheetFactory

Additional Inherited Members
Protected Attributes inherited from UAtomSoundBank
TSharedPtr< FThreadSafeBool, ESPMode::ThreadSafe >	bIsStreamingProxyFlag { MakeShared<FThreadSafeBool, ESPMode::ThreadSafe>() }

Detailed Description

UAtomCueSheet Class

Constructor & Destructor Documentation

UAtomCueSheet()

UAtomCueSheet::UAtomCueSheet

(

const FObjectInitializer &

ObjectInitializer

)

Member Function Documentation

BeginDestroy()

void UAtomCueSheet::BeginDestroy ( )

overridevirtual

CanUnloadAtomResource()

bool UAtomCueSheet::CanUnloadAtomResource ( )

overridevirtual

Reimplemented from IAtomSoundResource.

CreateAtomResource()

FAtomResource * UAtomCueSheet::CreateAtomResource ( )

overridevirtual

Reimplemented from IAtomSoundResource.

DestroyAtomResource()

void UAtomCueSheet::DestroyAtomResource ( )

overridevirtual

Reimplemented from IAtomSoundResource.

FinishDestroy()

void UAtomCueSheet::FinishDestroy ( )

overridevirtual

GetNumCues()

int32 UAtomCueSheet::GetNumCues

(

)

const

Gets the number of wave in this bank.

Returns

The number of waves.

GetNumSounds()

int UAtomCueSheet::GetNumSounds ( ) const

overridevirtual

Reimplemented from UAtomSoundBank.

GetResourceData()

const uint8 * UAtomCueSheet::GetResourceData ( )

overridevirtual

Get the pointer on acb data if available, otherwise nullptr.

Reimplemented from IAtomSoundResource.

GetSound()

UAtomSoundBase * UAtomCueSheet::GetSound ( int Index ) const

overridevirtual

Reimplemented from UAtomSoundBank.

GetSoundClass()

UClass * UAtomCueSheet::GetSoundClass ( ) const

overridevirtual

Reimplemented from UAtomSoundBank.

GetSoundCue()

UAtomSoundCue * UAtomCueSheet::GetSoundCue ( int Index ) const

inline

Gets the cue object from this bank at choosen index.

Returns

The UAtomSoundCue at the index in the bank or nullptr if an invalid index was provided.

GetSoundCueByName()

UAtomSoundCue * UAtomCueSheet::GetSoundCueByName

(

const FString &

CueName

)

const

Retreive the cue object from this bank by its name.

Returns

The UAtomSoundCue with the chosen name in the bank or nullptr if the cue was not found.

InitAtomResource()

bool UAtomCueSheet::InitAtomResource ( )

overridevirtual

Copy/Steal the acb data from the bulk data

Reimplemented from IAtomSoundResource.

IsLoaded()

bool UAtomCueSheet::IsLoaded

(

)

const

Returns load status of the the bank in Atom library and if ready to be accessed.

Returns

true if the bank is loaded.

IsReadyForFinishDestroy()

bool UAtomCueSheet::IsReadyForFinishDestroy ( )

overridevirtual

PostInitProperties()

void UAtomCueSheet::PostInitProperties ( )

overridevirtual

PostLoad()

void UAtomCueSheet::PostLoad ( )

overridevirtual

RemoveAtomResource()

void UAtomCueSheet::RemoveAtomResource ( )

overridevirtual

Remove the data associated with the passed acb

Reimplemented from IAtomSoundResource.

Serialize()

void UAtomCueSheet::Serialize ( FArchive & Ar )

overridevirtual

Reimplemented from UAtomSoundBank.

Validate()

bool UAtomCueSheet::Validate ( ) const

virtual

Validates the Atom cue sheet settings.

Returns

true if validation passed, false otherwise.

Friends And Related Symbol Documentation

UAtomCueSheetFactory

friend class UAtomCueSheetFactory

friend

Member Data Documentation

OwnedBulkDataPtr

FOwnedBulkDataPtr* UAtomCueSheet::OwnedBulkDataPtr { nullptr }

private

Memory containing the data copied or mapped from the raw bulk data.

ResourceData

const uint8* UAtomCueSheet::ResourceData { nullptr }

private

ResourceSize

int32 UAtomCueSheet::ResourceSize

private

Size of resource copied from the bulk data.

SoundCues

TArray<TObjectPtr<UAtomSoundCue> > UAtomCueSheet::SoundCues

private

WaveBanks

TArray<TObjectPtr<UAtomWaveBank> > UAtomCueSheet::WaveBanks

AtomWaveBank used by this AtomCueSheet. (Property is hidden in editor if ACB does not request any AtomWaveBanks.)

---

The documentation for this class was generated from the following files:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomCueSheet.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomCueSheet.cpp