unreal.PlaneFalloff

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

Bases: FieldNodeFloat

Plane scalar field that will be defined only within a distance from a plane

C++ Source:

  • Module: FieldSystemEngine

  • File: FieldSystemObjects.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

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

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

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

  • distance (float): [Read-Write] Distance limit for the plane falloff field

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

  • falloff (FieldFalloffType): [Read-Write] Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurface

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

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

  • max_range (float): [Read-Write] 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] The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

  • normal (Vector): [Read-Write] Plane normal of the plane falloff field

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

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

  • position (Vector): [Read-Write] Plane position of the plane falloff field

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

  • replicate_using_registered_sub_object_list (bool): [Read-Write] 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] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

property default: float

[Read-Write] The field value will be set to Default if the sample distance from the plane is higher than the distance

Type:

(float)

property distance: float

[Read-Write] Distance limit for the plane falloff field

Type:

(float)

property falloff: FieldFalloffType

[Read-Write] Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurface

Type:

(FieldFalloffType)

property magnitude: float

[Read-Write] Magnitude of the plane falloff field

Type:

(float)

property max_range: float

[Read-Write] 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] The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

Type:

(float)

property normal: Vector

[Read-Write] Plane normal of the plane falloff field

Type:

(Vector)

property position: Vector

[Read-Write] Plane position of the plane falloff field

Type:

(Vector)

set_plane_falloff(magnitude=1.000000, min_range=0.000000, max_range=1.000000, default, distance, position, normal, falloff) → PlaneFalloff

Plane scalar field that will be defined only within a distance from a plane

Parameters:

  • magnitude (float) – Magnitude of the plane 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 projected distance ((Sample Position - Center Position).dot(Plane Normal)) is higher than the Plane Distance

  • distance (float) – Distance limit for the plane falloff field starting from the center position and extending in the direction of the plane normal

  • position (Vector) – Plane center position of the plane falloff field

  • normal (Vector) – Plane normal of the plane falloff field

  • falloff (FieldFalloffType) – Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurface

Return type:

PlaneFalloff