UArticyAsset Class Reference

#include <ArticyAsset.h>

Inheritance diagram for UArticyAsset:

Public Member Functions
UObject *	LoadAsset () const
UTexture *	LoadAsTexture () const
UTexture2D *	LoadAsTexture2D () const
USoundWave *	LoadAsSoundWave () const
UFileMediaSource *	LoadAsFileMediaSource () const
Public Member Functions inherited from UArticyObject
FName	GetTechnicalName () const
UArticyObject *	GetParent () const
TArray< TWeakObjectPtr< UArticyObject > >	GetChildren () const
FArticyId	GetParentID () const
TArray< FArticyId >	GetChildrenIDs () const
Public Member Functions inherited from UArticyPrimitive
FArticyId	GetId () const
uint32	GetCloneId () const
void	SetCloneID (uint32 cCloneId)
Public Member Functions inherited from UArticyBaseObject
bool	WasLoaded () const
void	Initialize ()
UArticyPrimitive *	GetSubobject (FArticyId Id) const
FArticyType	GetArticyType () const
Public Member Functions inherited from IArticyReflectable
template<typename TValue>
TValue	SetProp (FName Property, TValue Value, int32 ArrayIndex=0)
template<typename TValue>
TValue &	GetProp (FName Property, int32 ArrayIndex=0)
template<typename TValue>
const TValue &	GetProp (FName Property, int32 ArrayIndex=0) const
template<typename TValue>
TValue *	GetPropPtr (FName Property, int32 ArrayIndex=0) const
FProperty *	GetProperty (FName Property) const
virtual UClass *	GetObjectClass () const

Public Attributes
FString	AssetRef
EArticyAssetCategory	Category
Public Attributes inherited from UArticyBaseObject
FArticyType	ArticyType
Public Attributes inherited from IArticyReflectable
FReportChangedDelegate	ReportChanged

Additional Inherited Members
Static Public Member Functions inherited from IArticyReflectable
static bool	HasProperty (const UClass *Class, const FName &Property)
Protected Member Functions inherited from UArticyObject
void	InitFromJson (TSharedPtr< FJsonValue > Json) override
Protected Member Functions inherited from UArticyPrimitive
void	InitFromJson (TSharedPtr< FJsonValue > Json) override
Protected Member Functions inherited from UArticyBaseObject
void	AddSubobject (UArticyPrimitive *Obj)
FText	GetPropertyText (const FText Property)
Protected Attributes inherited from UArticyObject
FArticyId	Parent
TArray< FArticyId >	Children
FString	TechnicalName
Protected Attributes inherited from UArticyPrimitive
FArticyId	Id
int32	CloneId = 0
Protected Attributes inherited from UArticyBaseObject
TMap< FArticyId, UArticyPrimitive * >	Subobjects

Detailed Description

Base class for all imported assets.

Member Function Documentation

LoadAsFileMediaSource()

UFileMediaSource * UArticyAsset::LoadAsFileMediaSource

(

)

const

Loads the asset as a file media source.

Returns

A pointer to the loaded UFileMediaSource, or nullptr if the asset could not be loaded as a file media source.

LoadAsset()

UObject * UArticyAsset::LoadAsset

(

)

const

Loads the asset referenced by this Articy asset.

Returns

A pointer to the loaded UObject, or nullptr if the asset could not be loaded.

LoadAsSoundWave()

USoundWave * UArticyAsset::LoadAsSoundWave

(

)

const

Loads the asset as a sound wave.

Returns

A pointer to the loaded USoundWave, or nullptr if the asset could not be loaded as a sound wave.

LoadAsTexture()

UTexture * UArticyAsset::LoadAsTexture

(

)

const

Loads the asset as a texture.

Returns

A pointer to the loaded UTexture, or nullptr if the asset could not be loaded as a texture.

LoadAsTexture2D()

UTexture2D * UArticyAsset::LoadAsTexture2D

(

)

const

Loads the asset as a 2D texture.

Returns

A pointer to the loaded UTexture2D, or nullptr if the asset could not be loaded as a 2D texture.

Member Data Documentation

AssetRef

FString UArticyAsset::AssetRef

The relative path of the referenced asset.

Category

EArticyAssetCategory UArticyAsset::Category

The category of the referenced asset.

---

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

• Source/ArticyRuntime/Public/ArticyAsset.h
• Source/ArticyRuntime/Private/ArticyAsset.cpp