unreal.BoxFalloff

class unreal.BoxFalloff(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: FieldNodeFloat

Box scalar field that will be defined only within a box

C++ Source:

• Module: FieldSystemEngine

• File: FieldSystemObjects.h

Editor Properties: (see get_editor_property/set_editor_property)

• asset_user_data (Array[AssetUserData]): [Read-Write] Asset User Data: Array of user data stored with the component

• auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

• can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

• component_tags (Array[Name]): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

• default (float): [Read-Write] Default: The field value will be set to Default if the sample distance from the box is higher than the scale of the transform

• editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

• falloff (FieldFalloffType): [Read-Write] Falloff: Type of falloff function used to model the evolution of the field from the box surface to the sample position

• is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

• magnitude (float): [Read-Write] Magnitude: Magnitude of the box falloff field

• max_range (float): [Read-Write] Max Range: The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

• min_range (float): [Read-Write] Min Range: The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

• on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

• on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

• primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

• replicate_using_registered_sub_object_list (bool): [Read-Write] Replicate Using Registered Sub Object List: When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

• replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

• transform (Transform): [Read-Write] Transform: Translation, Rotation and Scale of the unit box

property default: float

[Read-Write] Default: The field value will be set to Default if the sample distance from the box is higher than the scale of the transform

Type:

(float)

property falloff: FieldFalloffType

[Read-Write] Falloff: Type of falloff function used to model the evolution of the field from the box surface to the sample position

Type:

(FieldFalloffType)

property magnitude: float

[Read-Write] Magnitude: Magnitude of the box falloff field

Type:

(float)

property max_range: float

[Read-Write] Max Range: The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

Type:

(float)

property min_range: float

[Read-Write] Min Range: The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

Type:

(float)

set_box_falloff(magnitude=1.000000, min_range=0.000000, max_range=1.000000, default, transform, falloff) → BoxFalloff

Box scalar field that will be defined only within a box

Parameters:

• magnitude (float) – Magnitude of the box falloff field

• min_range (float) – The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

• max_range (float) – The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

• default (float) – The field value will be set to Default if the sample distance from the box is higher than the scale of the transform

• transform (Transform) – Translation, Rotation and Scale of the unit box

• falloff (FieldFalloffType) – Type of falloff function used to model the evolution of the field from the box surface to the sample position

Return type:

BoxFalloff

property transform: Transform

[Read-Write] Transform: Translation, Rotation and Scale of the unit box

Type:

(Transform)