🍀 Assets

Retrieve Assets Data from Asset Packs.

🗿Static Class

This is a Static Class. Access it's methods directly with .. It's not possible to spawn new instances.

💂Authority

This static class can be accessed on both 🟧 Client and 🟦 Server side.

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

🎒 Examples

(Assets.Precache) Precaches a Static Mesh

Assets.Precache("my-asset-pack::SM_MyStaticMesh", AssetType.StaticMesh)

🗿 Static Functions

	Returns	Name	Description
	table of table	GetAnimations	Gets a list containing all Animation Assets Keys from an AssetPack
	table of table	GetAssetPacks	Gets a list containing information about all loaded Asset Packs
	string	GetAssetPath	Gets the file path of an asset
	table of table	GetBlueprints	Gets a list containing all Blueprints Assets Keys from an AssetPack
	table of table	GetMaps	Gets a list containing all Map Asset Keys from an AssetPack
	table of table	GetMaterials	Gets a list containing all Materials Asset Keys from an AssetPack
	table of table	GetOthers	Gets a list containing all Other Assets Keys from an AssetPack
	table of table	GetParticles	Gets a list containing all Particle Assets Keys from an AssetPack
	table of table	GetSkeletalMeshes	Gets a list containing all Skeletal Mesh Asset Keys from an AssetPack
	table of table	GetSounds	Gets a list containing all Sound Assets Keys from an AssetPack
	table of table	GetStaticMeshes	Gets a list containing all Static Mesh Assets Keys from an AssetPack
		Precache	Manually adds an Asset to be loaded during the Player's loading screen

---

GetAnimations

Gets a list containing all Animation Assets Keys from an AssetPack

local ret = Assets.GetAnimations(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

GetAssetPacks

Gets a list containing information about all loaded Asset Packs

local ret = Assets.GetAssetPacks()

Returns

Type	Description
table of table	with this format

---

GetAssetPath

Gets the file path of an asset

local ret = Assets.GetAssetPath(asset, asset_type)

Parameters

Type	Parameter	Default	Description
string	asset	Required parameter	The asset reference in the format asset-pack::AssetKey
AssetType	asset_type	Required parameter	The Asset Type

Returns

Type	Description
string	The file path defined in the Assets.toml

---

GetBlueprints

Gets a list containing all Blueprints Assets Keys from an AssetPack

local ret = Assets.GetBlueprints(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

GetMaps

Gets a list containing all Map Asset Keys from an AssetPack

local ret = Assets.GetMaps(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

GetMaterials

Gets a list containing all Materials Asset Keys from an AssetPack

local ret = Assets.GetMaterials(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

GetOthers

Gets a list containing all Other Assets Keys from an AssetPack

local ret = Assets.GetOthers(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

GetParticles

Gets a list containing all Particle Assets Keys from an AssetPack

local ret = Assets.GetParticles(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

GetSkeletalMeshes

Gets a list containing all Skeletal Mesh Asset Keys from an AssetPack

local ret = Assets.GetSkeletalMeshes(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

GetSounds

Gets a list containing all Sound Assets Keys from an AssetPack

local ret = Assets.GetSounds(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

GetStaticMeshes

Gets a list containing all Static Mesh Assets Keys from an AssetPack

local ret = Assets.GetStaticMeshes(asset_pack_path)

Parameters

Type	Parameter	Default	Description
string	asset_pack_path	Required parameter	The Asset Pack path to get the assets

Returns

Type	Description
table of table	array of tables containing all assets and its metadata with this format

---

Precache

Manually adds an Asset to be loaded during the Player's loading screen

Assets.Precache(asset_path, asset_type)

Parameters

Type	Parameter	Default	Description
string	asset_path	Required parameter	The Asset Key
AssetType	asset_type	Required parameter	The Asset Type

Assets.Precache Examples

Precaches a Static Mesh

Assets.Precache("my-asset-pack::SM_MyStaticMesh", AssetType.StaticMesh)