unreal.ChaosClothAssetInteractor

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

Bases: ClothingInteractor

Chaos Cloth Asset Interactor

C++ Source:

  • Plugin: ChaosClothAsset

  • Module: ChaosClothAssetEngine

  • File: ClothAssetInteractor.h

get_all_properties(lod_index=-1) → Array[str]

Generate a list of all properties held by this interactor. Properties for all LODs will be returned if LODIndex = -1. deprecated: Use GetAllPropertyNames instead

Parameters:

lod_index (int32)

Return type:

Array[str]

get_all_property_names(lod_index=-1) → Array[Name]

Generate a list of all properties held by this interactor. Properties for all LODs will be returned if LODIndex = -1.

Parameters:

lod_index (int32)

Return type:

Array[Name]

get_float_property_value(property_name, lod_index=0, default_value=0.000000) → float

Get the value for a property cast to float. DefaultValue will be returned if the property is not found.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • default_value (float)

Return type:

float

get_float_value(property_name, lod_index=0, default_value=0.000000) → float

Get the value for a property cast to float. DefaultValue will be returned if the property is not found. deprecated: Use GetFloatPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • default_value (float)

Return type:

float

get_high_float_property_value(property_name, lod_index=0, default_value=0.000000) → float

Get the high value for a weighted property value. DefaultValue will be returned if the property is not found.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • default_value (float)

Return type:

float

get_high_float_value(property_name, lod_index=0, default_value=0.000000) → float

Get the high value for a weighted property value. DefaultValue will be returned if the property is not found. deprecated: Use GetHighFloatPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • default_value (float)

Return type:

float

get_int_property_value(property_name, lod_index=0, default_value=0) → int32

Get the value for a property cast to int. DefaultValue will be returned if the property is not found.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • default_value (int32)

Return type:

int32

get_int_value(property_name, lod_index=0, default_value=0) → int32

Get the value for a property cast to int. DefaultValue will be returned if the property is not found. deprecated: Use GetIntPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • default_value (int32)

Return type:

int32

get_low_float_property_value(property_name, lod_index=0, default_value=0.000000) → float

Get the low value for a weighted property value (same as GetFloatValue). DefaultValue will be returned if the property is not found.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • default_value (float)

Return type:

float

get_low_float_value(property_name, lod_index=0, default_value=0.000000) → float

Get the low value for a weighted property value (same as GetFloatValue). DefaultValue will be returned if the property is not found. deprecated: Use GetLowFloatPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • default_value (float)

Return type:

float

get_string_property_value(property_name, lod_index=0, default_value='') → str

Get the string value for a property (typically the associated map name for weighted values). DefaultValue will be returned if the property is not found.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • default_value (str)

Return type:

str

get_string_value(property_name, lod_index=0, default_value='') → str

Get the string value for a property (typically the associated map name for weighted values). DefaultValue will be returned if the property is not found. deprecated: Use GetStringPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • default_value (str)

Return type:

str

get_vector_property_value(property_name, lod_index=0, default_value=[0.000000, 0.000000, 0.000000]) → Vector

Get the value for a property cast to vector. DefaultValue will be returned if the property is not found.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • default_value (Vector)

Return type:

Vector

get_vector_value(property_name, lod_index=0, default_value=[0.000000, 0.000000, 0.000000]) → Vector

Get the value for a property cast to vector. DefaultValue will be returned if the property is not found. deprecated: Use GetVectorPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • default_value (Vector)

Return type:

Vector

get_weighted_float_property_value(property_name, lod_index=0, default_value=[0.000000, 0.000000]) → Vector2D

Get the low and high values for a weighted property value. DefaultValue will be returned if the property is not found.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • default_value (Vector2D)

Return type:

Vector2D

get_weighted_float_value(property_name, lod_index=0, default_value=[0.000000, 0.000000]) → Vector2D

Get the low and high values for a weighted property value. DefaultValue will be returned if the property is not found. deprecated: Use GetWeightedFloatPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • default_value (Vector2D)

Return type:

Vector2D

set_float_property_value(property_name, lod_index=-1, value=0.000000) → None

Set the value for a property (if it exists). This sets the Low and High values for weighted values. All LODs will be set when LODIndex = -1.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • value (float)

set_float_value(property_name, lod_index=-1, value=0.000000) → None

Set the value for a property (if it exists). This sets the Low and High values for weighted values. All LODs will be set when LODIndex = -1. deprecated: Use SetFloatPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • value (float)

set_high_float_property_value(property_name, lod_index=-1, value=0.000000) → None

Set the high value for a weighted property (if it exists). All LODs will be set when LODIndex = -1.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • value (float)

set_high_float_value(property_name, lod_index=-1, value=0.000000) → None

Set the high value for a weighted property (if it exists). All LODs will be set when LODIndex = -1. deprecated: Use SetHighFloatPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • value (float)

set_int_property_value(property_name, lod_index=-1, value=0) → None

Set the value for a property (if it exists). All LODs will be set when LODIndex = -1.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • value (int32)

set_int_value(property_name, lod_index=-1, value=0) → None

Set the value for a property (if it exists). All LODs will be set when LODIndex = -1. deprecated: Use SetIntPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • value (int32)

set_low_float_property_value(property_name, lod_index=-1, value=0.000000) → None

Set the low value for a weighted property (if it exists). All LODs will be set when LODIndex = -1.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • value (float)

set_low_float_value(property_name, lod_index=-1, value=0.000000) → None

Set the low value for a weighted property (if it exists). All LODs will be set when LODIndex = -1. deprecated: Use SetLowFloatPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • value (float)

set_string_property_value(property_name, lod_index=-1, value='') → None

Set the string value for a property (if it exists). This is typically the map name associated with a property. All LODs will be set when LODIndex = -1.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • value (str)

set_string_value(property_name, lod_index=-1, value='') → None

Set the string value for a property (if it exists). This is typically the map name associated with a property. All LODs will be set when LODIndex = -1. deprecated: Use SetStringPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • value (str)

set_vector_property_value(property_name, lod_index=-1, value=[0.000000, 0.000000, 0.000000]) → None

Set the value for a property (if it exists). All LODs will be set when LODIndex = -1.

Parameters:

  • property_name (Name)

  • lod_index (int32)

  • value (Vector)

set_vector_value(property_name, lod_index=-1, value=[0.000000, 0.000000, 0.000000]) → None

Set the value for a property (if it exists). All LODs will be set when LODIndex = -1. deprecated: Use SetVectorPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • value (Vector)

set_weighted_float_property_value(property_name, lod_index=-1, value=[0.000000, 0.000000]) → None

Set the low and high values for a weighted property (if it exists). All LODs will be set when LODIndex = -1.

Parameters:
set_weighted_float_value(property_name, lod_index=-1, value=[0.000000, 0.000000]) → None

Set the low and high values for a weighted property (if it exists). All LODs will be set when LODIndex = -1. deprecated: Use SetWeightedFloatPropertyValue instead

Parameters:

  • property_name (str)

  • lod_index (int32)

  • value (Vector2D)