unreal.CEEffectorForceEffect

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

Bases: CEEffectorEffectBase

Effector supported forces to affect clones

C++ Source:

• Plugin: ClonerEffector

• Module: ClonerEffector

• File: CEEffectorForceEffect.h

Editor Properties: (see get_editor_property/set_editor_property)

• attraction_force_enabled (bool): [Read-Write] Enable attraction force to allow each clone instances to gravitate toward a location

• attraction_force_falloff (float): [Read-Write]

• attraction_force_strength (float): [Read-Write]

• curl_noise_force_enabled (bool): [Read-Write] Enable curl noise force to allow each clone instance to add random location variation

• curl_noise_force_frequency (float): [Read-Write]

• curl_noise_force_strength (float): [Read-Write]

• drag_force_enabled (bool): [Read-Write] Enable drag force to decrease particles velocity

• drag_force_linear (float): [Read-Write]

• drag_force_rotational (float): [Read-Write]

• forces_enabled (bool): [Read-Write] Forces global state

• gravity_force_acceleration (Vector): [Read-Write]

• gravity_force_enabled (bool): [Read-Write] Enable gravity force to pull particles based on an acceleration vector

• orientation_force_enabled (bool): [Read-Write] Enable orientation force to allow each clone instance to rotate around its pivot

• orientation_force_max (Vector): [Read-Write]

• orientation_force_min (Vector): [Read-Write]

• orientation_force_rate (float): [Read-Write]

• vector_noise_force_amount (float): [Read-Write]

• vector_noise_force_enabled (bool): [Read-Write] Enable vector random noise force to add variation to clones behavior

• vortex_force_amount (float): [Read-Write]

• vortex_force_axis (Vector): [Read-Write]

• vortex_force_enabled (bool): [Read-Write] Enable vortex force to allow each clone instance to rotate around a specific axis on the cloner pivot

get_attraction_force_enabled() → bool

Get Attraction Force Enabled

Return type:

bool

get_attraction_force_falloff() → float

Get Attraction Force Falloff

Return type:

float

get_attraction_force_strength() → float

Get Attraction Force Strength

Return type:

float

get_curl_noise_force_enabled() → bool

Get Curl Noise Force Enabled

Return type:

bool

get_curl_noise_force_frequency() → float

Get Curl Noise Force Frequency

Return type:

float

get_curl_noise_force_strength() → float

Get Curl Noise Force Strength

Return type:

float

get_drag_force_enabled() → bool

Get Drag Force Enabled

Return type:

bool

get_drag_force_linear() → float

Get Drag Force Linear

Return type:

float

get_drag_force_rotational() → float

Get Drag Force Rotational

Return type:

float

get_forces_enabled() → bool

Get Forces Enabled

Return type:

bool

get_gravity_force_acceleration() → Vector

Get Gravity Force Acceleration

Return type:

Vector

get_gravity_force_enabled() → bool

Get Gravity Force Enabled

Return type:

bool

get_orientation_force_enabled() → bool

Get Orientation Force Enabled

Return type:

bool

get_orientation_force_max() → Vector

Get Orientation Force Max

Return type:

Vector

get_orientation_force_min() → Vector

Get Orientation Force Min

Return type:

Vector

get_orientation_force_rate() → float

Get Orientation Force Rate

Return type:

float

get_vector_noise_force_amount() → float

Get Vector Noise Force Amount

Return type:

float

get_vector_noise_force_enabled() → bool

Get Vector Noise Force Enabled

Return type:

bool

get_vortex_force_amount() → float

Get Vortex Force Amount

Return type:

float

get_vortex_force_axis() → Vector

Get Vortex Force Axis

Return type:

Vector

get_vortex_force_enabled() → bool

Get Vortex Force Enabled

Return type:

bool

set_attraction_force_enabled(force_enabled) → None

Set Attraction Force Enabled

Parameters:

force_enabled (bool)

set_attraction_force_falloff(force_falloff) → None

Set Attraction Force Falloff

Parameters:

force_falloff (float)

set_attraction_force_strength(force_strength) → None

Set Attraction Force Strength

Parameters:

force_strength (float)

set_curl_noise_force_enabled(force_enabled) → None

Set Curl Noise Force Enabled

Parameters:

force_enabled (bool)

set_curl_noise_force_frequency(force_curl_noise_frequency) → None

Set Curl Noise Force Frequency

Parameters:

force_curl_noise_frequency (float)

set_curl_noise_force_strength(force_curl_noise_strength) → None

Set Curl Noise Force Strength

Parameters:

force_curl_noise_strength (float)

set_drag_force_enabled(enabled) → None

Set Drag Force Enabled

Parameters:

enabled (bool)

set_drag_force_linear(strength) → None

Set Drag Force Linear

Parameters:

strength (float)

set_drag_force_rotational(strength) → None

Set Drag Force Rotational

Parameters:

strength (float)

set_forces_enabled(forces_enabled) → None

Set Forces Enabled

Parameters:

forces_enabled (bool)

set_gravity_force_acceleration(acceleration) → None

Set Gravity Force Acceleration

Parameters:

acceleration (Vector)

set_gravity_force_enabled(force_enabled) → None

Set Gravity Force Enabled

Parameters:

force_enabled (bool)

set_orientation_force_enabled(force_enabled) → None

Set Orientation Force Enabled

Parameters:

force_enabled (bool)

set_orientation_force_max(force_orientation_max) → None

Set Orientation Force Max

Parameters:

force_orientation_max (Vector)

set_orientation_force_min(force_orientation_min) → None

Set Orientation Force Min

Parameters:

force_orientation_min (Vector)

set_orientation_force_rate(force_orientation_rate) → None

Set Orientation Force Rate

Parameters:

force_orientation_rate (float)

set_vector_noise_force_amount(amount) → None

Set Vector Noise Force Amount

Parameters:

amount (float)

set_vector_noise_force_enabled(enabled) → None

Set Vector Noise Force Enabled

Parameters:

enabled (bool)

set_vortex_force_amount(force_vortex_amount) → None

Set Vortex Force Amount

Parameters:

force_vortex_amount (float)

set_vortex_force_axis(force_vortex_axis) → None

Set Vortex Force Axis

Parameters:

force_vortex_axis (Vector)

set_vortex_force_enabled(force_enabled) → None

Set Vortex Force Enabled

Parameters:

force_enabled (bool)