unreal.PlaneFalloff
¶
- class unreal.PlaneFalloff(outer=None, name='None')¶
Bases:
unreal.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] Asset User Data: Array of user data stored with the componentauto_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 navigationcomponent_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 plane is higher than the distancedistance
(float): [Read-Write] Distance: Distance limit for the plane falloff fieldeditable_when_inherited
(bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor classfalloff
(FieldFalloffType): [Read-Write] Falloff: Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurfaceis_editor_only
(bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor buildsmagnitude
(float): [Read-Write] Magnitude: Magnitude of the plane falloff fieldmax_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 magnitudemin_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 magnitudenormal
(Vector): [Read-Write] Normal: Plane normal of the plane falloff fieldon_component_activated
(ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivatedposition
(Vector): [Read-Write] Position: Plane position of the plane falloff fieldprimary_component_tick
(ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Componentreplicates
(bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
- property default¶
[Read-Write] Default: The field value will be set to Default if the sample distance from the plane is higher than the distance
- Type
(float)
- property falloff¶
[Read-Write] Falloff: Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurface
- Type
- property max_range¶
[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¶
[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_plane_falloff(magnitude, min_range, max_range, 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