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:
- classmethod get_instance_checked() CustomizableObjectSystem ¶
Get Instance Checked
- Return type:
- 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_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
- 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:
- is_updating(instance) bool ¶
Return true if the instance is being updated.
- Parameters:
instance (CustomizableObjectInstance) –
- Return type:
- set_release_mutable_textures_immediately(release_textures) None ¶
If set to true, Mutable will release Mutable-generated textures immediately when they are no longer used without waiting for GC IMPORTANT!!! Do NOT keep references to any Mutable generated textures or skeletal meshes if this is enabled, they are owned by Mutable and will be destroyed without notice
- Parameters:
release_textures (bool) –