Skip to main content
Version: latest - a1.64.x โš–๏ธ

๐Ÿ€ 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โ€‹

ReturnsNameDescription
table of tableGetAnimationsGets a list containing all Animation Assets Keys from an AssetPack
table of tableGetAssetPacksGets a list containing information about all loaded Asset Packs
stringGetAssetPathGets the file path of an asset
table of tableGetBlueprintsGets a list containing all Blueprints Assets Keys from an AssetPack
table of tableGetMapsGets a list containing all Map Asset Keys from an AssetPack
table of tableGetMaterialsGets a list containing all Materials Asset Keys from an AssetPack
table of tableGetOthersGets a list containing all Other Assets Keys from an AssetPack
table of tableGetParticlesGets a list containing all Particle Assets Keys from an AssetPack
table of tableGetSkeletalMeshesGets a list containing all Skeletal Mesh Asset Keys from an AssetPack
table of tableGetSoundsGets a list containing all Sound Assets Keys from an AssetPack
table of tableGetStaticMeshesGets a list containing all Static Mesh Assets Keys from an AssetPack
PrecacheManually adds an Asset to be loaded during the Player's loading screen

GetAnimations

Gets a list containing all Animation Assets Keys from an AssetPack

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetAnimations(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

GetAssetPacks

Gets a list containing information about all loaded Asset Packs

โ€” Returns table of table (with this format).

local ret = Assets.GetAssetPacks()

GetAssetPath

Gets the file path of an asset

โ€” Returns string (The file path defined in the Assets.toml).

local ret = Assets.GetAssetPath(asset, asset_type)
TypeParameterDefaultDescription
stringasset Required parameter The asset reference in the format asset-pack::AssetKey
AssetTypeasset_type Required parameter The Asset Type

GetBlueprints

Gets a list containing all Blueprints Assets Keys from an AssetPack

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetBlueprints(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

GetMaps

Gets a list containing all Map Asset Keys from an AssetPack

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetMaps(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

GetMaterials

Gets a list containing all Materials Asset Keys from an AssetPack

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetMaterials(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

GetOthers

Gets a list containing all Other Assets Keys from an AssetPack

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetOthers(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

GetParticles

Gets a list containing all Particle Assets Keys from an AssetPack

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetParticles(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

GetSkeletalMeshes

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

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetSkeletalMeshes(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

GetSounds

Gets a list containing all Sound Assets Keys from an AssetPack

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetSounds(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

GetStaticMeshes

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

โ€” Returns table of table (array of tables containing all assets and it's metadata with this format).

local ret = Assets.GetStaticMeshes(asset_pack_path)
TypeParameterDefaultDescription
stringasset_pack_path Required parameter The Asset Pack path to get the assets

Precache

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

Assets.Precache(asset_path, asset_type)
TypeParameterDefaultDescription
stringasset_path Required parameter The Asset Key
AssetTypeasset_type Required parameter The Asset Type
Assets.Precache Examples
Precaches a Static Mesh
Assets.Precache("my-asset-pack::SM_MyStaticMesh", AssetType.StaticMesh)