unreal.CustomizableObjectSystem

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

Bases: Object

Customizable Object System

C++ Source:

  • Plugin: Mutable

  • Module: CustomizableObject

  • File: CustomizableObjectSystem.h

get_average_build_time() → int32

Return the average build/update time of an instance in ms.

Return type:

int32

classmethod get_instance() → CustomizableObjectSystem

Get the singleton object. It will be created if it doesn’t exist yet.

Return type:

CustomizableObjectSystem

classmethod get_instance_checked() → CustomizableObjectSystem

Get Instance Checked

Return type:

CustomizableObjectSystem

get_num_instances() → int32

Get the number of instances built and alive.

Return type:

int32

get_num_pending_instances() → int32

Get the number of instances waiting to be updated.

Return type:

int32

get_plugin_version() → str

Find out the version of the plugin

Return type:

str

get_texture_memory_used() → int64

Get the amount of GPU memory in use in bytes for textures generated by mutable.

Return type:

int64

get_total_instances() → int32

Get the total number of instances including built and not built.

Return type:

int32

get_working_memory() → int32

Get Mutable’s working memory limit (kilobytes). See SetWorkingMemory(int32).

Return type:

int32

classmethod is_update_result_valid(update_result) → bool

Determines if the result of the instance update is valid or not.

Parameters:

update_result (UpdateResult)

Returns:

true if the result is successful or has warnings, false if the result is from the Error category

Return type:

bool

is_updating(instance) → bool

Return true if the instance is being updated.

Parameters:

instance (CustomizableObjectInstance)

Return type:

bool

set_working_memory(kilo_bytes) → None

Set Mutable’s working memory limit (kilobytes). Mutable will flush internal caches to try to keep its memory consumption below the WorkingMemory (i.e., it is not a hard limit). The working memory limit will especially reduce the memory required to perform Instance Updates and Texture Streaming. Notice that Mutable does not track all its memory (e.g., UObjects memory is no tracked). This value can also be set using “mutable.WorkingMemory” CVar.

Parameters:

kilo_bytes (int32)