unreal.CustomizableObject¶
- class unreal.CustomizableObject(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
ObjectCustomizable Object
C++ Source:
Plugin: Mutable
Module: CustomizableObject
File: CustomizableObject.h
Editor Properties: (see get_editor_property/set_editor_property)
disable_table_materials_parent_check(bool): [Read-Write]enable16_bit_bone_weights(bool): [Read-Write]enable_alt_skin_weight_profiles(bool): [Read-Write]enable_anim_bp_physics_assets_manipualtion(bool): [Read-Write]enable_asset_user_data_merge(bool): [Read-Write]enable_clothing(bool): [Read-Write]enable_mesh_cache(bool): [Read-Write] If true, reuse previously generated USkeletalMesh (if still valid and the the number of LOD have not changed) USkeletalMeshes are only reused between the same CO.enable_mesh_streaming(bool): [Read-Write] Experimental - If true, Mesh LODs will be streamed on demand. It requires streaming of SkeletalMeshes and Mutable.StreamMeshLODsEnabled to be enabled. Does not support Clothing and Morphs, yet.enable_physics_asset_merge(bool): [Read-Write]enable_real_time_morph_targets(bool): [Read-Write]enable_use_ref_skeletal_mesh_as_placeholder(bool): [Read-Write] true to use the Reference Skeletal Mesh as a placeholder while the Generated Skeletal Mesh is not ready. If false, a null mesh will be used to replace the discarded mesh due to ‘ReplaceDiscardedWithReferenceMesh’ being enabled.lod_settings(MutableLODSettings): [Read-Write] deprecated: Moved to Mesh Component Nodelow_priority_textures(Array[Name]): [Read-Write] Textures marked as low priority will generate defaulted resident mips (if texture streaming is enabled). Generating defaulted resident mips greatly reduce initial generation times.mesh_compile_type(MutableCompileMeshType): [Read-Write]preserve_user_lo_ds_on_first_generation(bool): [Read-Write] Use the Instance MinLOD, and RequestedLODs in the descriptor when performing the initial generation (ignore LOD Management).version_bridge(Object): [Read-Write] Optional Version Bridge asset.Used to decide which Mutable child Customizable Objects and Data Table rows must be included in a compilation/cook. An asset will be included if the struct/column version matches the game-specific system version.
The provided asset must implement ICustomizableObjectVersionBridgeInterface.
version_struct(InstancedStruct): [Read-Write] Optional struct.Used to define which version this child Customizable Object belongs to. It will be used during cook/compilation to decide whether this Customizable Object should be included in the final compiled Customizable Object.
To work, the root Customizable Object must have a Version Bridge.
working_set(Array[CustomizableObject]): [Read-Write]
- compile(params) None¶
Compile the Customizable Object.
- Parameters:
params (CompileParams)
- contains_enum_parameter_value(parameter_name, value) bool¶
Return true if the enum parameter contains this value a possible option.
- create_instance() CustomizableObjectInstance¶
Create a new instance of this object. The instance parameters will be initialized with the object default values.
- Return type:
- get_bool_parameter_default_value(parameter_name) bool¶
Get the default value of a parameter of type Bool.
- get_color_parameter_default_value(parameter_name) LinearColor¶
Get the default value of a parameter of type Color.
- Parameters:
parameter_name (str) – The name of the Color parameter to get the default value of.
- Returns:
The default value of the provided parameter name.
- Return type:
- get_component_count() int32¶
Get the number of components this Customizable Object has.
- Return type:
int32
- get_component_mesh_reference_skeletal_mesh(name) SkeletalMesh¶
Given a Mesh Component name, return its reference Skeletal Mesh.
- Parameters:
name (Name)
- Return type:
- get_component_name(component_index) Name¶
Return the name of the component.
- Parameters:
component_index (int32) – [0 - GetComponentCount). Index may not represent the same component between runs. To identify them use the name.
- Returns:
NAME_None if the component does not exist.
- Return type:
- get_enum_parameter_default_value(parameter_name) int32¶
Get the default value of a parameter of type Int.
- Parameters:
parameter_name (str) – The name of the Int parameter to get the default value of.
- Returns:
The default value of the provided parameter name.
- Return type:
int32
- get_enum_parameter_group_type(param_name) CustomizableObjectGroupType¶
Returns the group type of the given integer parameter
- Parameters:
param_name (str)
- Return type:
- get_enum_parameter_num_values(parameter_name) int32¶
If the given parameter is enum int parameter, return how many possible values an enum parameter has. Otherwise, return 0.
- Parameters:
parameter_name (str)
- Return type:
int32
- get_enum_parameter_value(parameter_name, value_index) str¶
Gets the Name of the value at position ValueIndex in the list of available values for the int parameter.
- get_enum_parameter_value_data_table(param_name, value) Array[DataTable]¶
Return the DataTables used by the given parameter and its value (if any).
- get_enum_parameter_value_ui_metadata(param_name, option_name) MutableParamUIMetadata¶
Return the metadata associated to the given enum parameter value.
- Parameters:
- Return type:
- get_float_parameter_default_value(parameter_name) float¶
Get the default value of a parameter of type Float.
- get_int_parameter_available_option(param_index, k) str¶
Get Int Parameter Available Option
- Parameters:
param_index (int32)
k (int32)
- Return type:
- get_int_parameter_default_value(parameter_name: str) int¶
deprecated: ‘get_int_parameter_default_value’ was renamed to ‘get_enum_parameter_default_value’.
- get_int_parameter_group_type(param_name: str) CustomizableObjectGroupType¶
deprecated: ‘get_int_parameter_group_type’ was renamed to ‘get_enum_parameter_group_type’.
- get_int_parameter_num_options(param_index) int32¶
Get Int Parameter Num Options
- Parameters:
param_index (int32)
- Return type:
int32
- get_int_parameter_option_data_table(param_name: str, value: str) None¶
deprecated: ‘get_int_parameter_option_data_table’ was renamed to ‘get_enum_parameter_value_data_table’.
- get_int_parameter_option_ui_metadata(param_name: str, option_name: str) MutableParamUIMetadata¶
deprecated: ‘get_int_parameter_option_ui_metadata’ was renamed to ‘get_enum_parameter_value_ui_metadata’.
- get_parameter_count() int32¶
Get the number of parameters available in instances of this object.
- Return type:
int32
- get_parameter_name(param_index) str¶
TODO >5.6 rename to GetParameterType (with redirector). Name -> ParameterName (create redirector)
- Parameters:
param_index (int32)
- Return type:
- get_parameter_type(param_index) MutableParameterType¶
Get Parameter Type
- Parameters:
param_index (int32)
- Return type:
- get_parameter_type_by_name(name) MutableParameterType¶
Get the type of a parameter from its name.
- Parameters:
name (str)
- Return type:
- get_parameter_ui_metadata(param_name) MutableParamUIMetadata¶
Return the metadata associated to a parameter.
- Parameters:
param_name (str)
- Return type:
- get_projector_parameter_default_value(parameter_name) CustomizableObjectProjector¶
Get the default value of a projector with the provided name
- Parameters:
parameter_name (str) – The name of the parameter to get the default value of.
- Returns:
A data structure containing all the default data for the targeted projector parameter.
- Return type:
- get_state_count() int32¶
Return the number of object states that are defined in the CustomizableObject.
- Return type:
int32
- get_state_parameter_count(state_name) int32¶
Return the number of parameters that are editable at runtime for a specific state.
- Parameters:
state_name (str)
- Return type:
int32
- get_state_parameter_name(state_name, parameter_index) str¶
Return the name of one of the state’s runtime parameters, by its index (from 0 to GetStateParameterCount - 1).
- get_state_ui_metadata(state_name) MutableStateUIMetadata¶
Return the metadata associated to a state.
- Parameters:
state_name (str)
- Return type:
- get_transform_parameter_default_value(parameter_name) Transform¶
Get the default value of a parameter of type Transform.
- is_child_object() bool¶
Return true if this Customizable Object has references to a parent Customizable Object. Only root Customizable Objects will return false.
- Return type:
- is_compiled() bool¶
Check if the CustomizableObject asset has been compiled. This will always be true in a packaged game, but it could be false in the editor. It may return false due to the Customizable Object still being loaded.
- Return type:
- is_loading() bool¶
Return true if the Customizable Object is still being loaded. It may take a few frames to load the Customizable Object.
- Return type:
- is_parameter_multidimensional(parameter_name) bool¶
Return true if the parameter at the index provided is multidimensional.
- property lod_settings: MutableLODSettings¶
[Read-Write] deprecated: Moved to Mesh Component Node
- Type: