unreal.BoxFalloff
¶
- class unreal.BoxFalloff(outer: Object | None = None, name: 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] Array of user data stored with the componentauto_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 navigationcomponent_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 box is higher than the scale of the transformeditable_when_inherited
(bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor classfalloff
(FieldFalloffType): [Read-Write] Type of falloff function used to model the evolution of the field from the box surface to the sample positionis_editor_only
(bool): [Read-Write] If true, the component will be excluded from non-editor buildsmagnitude
(float): [Read-Write] Magnitude of the box falloff fieldmax_range
(float): [Read-Write] The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitudemin_range
(float): [Read-Write] The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitudeon_component_activated
(ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivatedprimary_component_tick
(ActorComponentTickFunction): [Read-Write] Main tick function for the Componentreplicate_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!transform
(Transform): [Read-Write] Translation, Rotation and Scale of the unit box
- property default: float¶
[Read-Write] 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] Type of falloff function used to model the evolution of the field from the box surface to the sample position
- Type:
- 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)
- 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: