unreal.AssetTagsSubsystem

class unreal.AssetTagsSubsystem(outer: Object | None = None, name: Name | str = 'None')

Bases: EngineSubsystem

Asset Tags Subsystem

C++ Source:

  • Plugin: AssetTags

  • Module: AssetTags

  • File: AssetTagsSubsystem.h

add_asset_data_to_collection(name, asset_data) → bool

Add Asset Data to Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

add_asset_datas_to_collection(name, asset_datas) → bool

Add Asset Datas to Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

add_asset_ptr_to_collection(name, asset_ptr) → bool

Add Asset Ptr to Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

add_asset_ptrs_to_collection(name, asset_ptrs) → bool

Add Asset Ptrs to Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

add_asset_to_collection(name, asset_path_name) → bool

Add Asset to Collection deprecated: Names containing full asset paths are deprecated. Use Soft Object Path instead.

Parameters:
Return type:

bool

add_assets_to_collection(name, asset_path_names) → bool

Add Assets to Collection deprecated: Names containing full asset paths are deprecated. Use Soft Object Path instead.

Parameters:
Return type:

bool

collection_exists(name) → bool

Check whether the given collection exists. Use this for in-game access. Use the Collections Manager Scripting Subsystem for any other use case.

Parameters:

name (Name) – Name of the collection to test.

Returns:

True if the collection exists, false otherwise.

Return type:

bool

create_collection(name, share_type) → bool

Create Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

destroy_collection(name) → bool

Destroy Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:

name (Name)

Return type:

bool

empty_collection(name) → bool

Empty Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:

name (Name)

Return type:

bool

get_assets_in_collection(name) → Array[AssetData]

Get the assets in the given collection. Use this for in-game access. Use the Collections Manager Scripting Subsystem for any other use case.

Parameters:

name (Name) – Name of the collection to test.

Returns:

Assets in the given collection.

Return type:

Array[AssetData]

get_collections() → Array[Name]

Get the names of all available collections. Use this for in-game access. Use the Collections Manager Scripting Subsystem for any other use case.

Returns:

Names of all available collections.

Return type:

Array[Name]

get_collections_containing_asset(asset_path_name) → Array[Name]

Get Collections Containing Asset deprecated: Names containing full asset paths are deprecated. Use Soft Object Path instead.

Parameters:

asset_path_name (Name)

Return type:

Array[Name]

get_collections_containing_asset_data(asset_data) → Array[Name]

Get the names of the collections that contain the given asset. Use this for in-game access. Use the Collections Manager Scripting Subsystem for any other use case.

Parameters:

asset_data (AssetData) – Asset to test.

Returns:

Names of the collections that contain the asset.

Return type:

Array[Name]

get_collections_containing_asset_ptr(asset_ptr) → Array[Name]

Get the names of the collections that contain the given asset. Use this for in-game access. Use the Collections Manager Scripting Subsystem for any other use case.

Parameters:

asset_ptr (Object) – Asset to test.

Returns:

Names of the collections that contain the asset.

Return type:

Array[Name]

k2_add_asset_to_collection(name, asset_path) → bool

Add Asset To Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

k2_add_assets_to_collection(name, asset_paths) → bool

Add Assets To Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

k2_get_collections_containing_asset(asset_path) → Array[Name]

Get the names of the collections that contain the given asset. Use this for in-game access. Use the Collections Manager Scripting Subsystem for any other use case.

Parameters:

asset_path (SoftObjectPath)

Returns:

Names of the collections that contain the asset.

Return type:

Array[Name]

k2_remove_asset_from_collection(name, asset_path) → bool

Remove Asset From Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

k2_remove_assets_from_collection(name, asset_paths) → bool

Remove Assets From Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

remove_asset_data_from_collection(name, asset_data) → bool

Remove Asset Data from Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

remove_asset_datas_from_collection(name, asset_datas) → bool

Remove Asset Datas from Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

remove_asset_from_collection(name, asset_path_name) → bool

Remove Asset from Collection deprecated: Names containing full asset paths are deprecated. Use Soft Object Path instead.

Parameters:
Return type:

bool

remove_asset_ptr_from_collection(name, asset_ptr) → bool

Remove Asset Ptr from Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

remove_asset_ptrs_from_collection(name, asset_ptrs) → bool

Remove Asset Ptrs from Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

remove_assets_from_collection(name, asset_path_names) → bool

Remove Assets from Collection deprecated: Names containing full asset paths are deprecated. Use Soft Object Path instead.

Parameters:
Return type:

bool

rename_collection(name, new_name) → bool

Rename Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool

reparent_collection(name, new_parent_name) → bool

Reparent Collection deprecated: Collection Manager Scripting Subsystem has been introduced as a new top level object for managing collections. Use that instead.

Parameters:
Return type:

bool