unreal.NoiseField

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

Bases: FieldNodeFloat

Defines a perlin noise scalar value if the sample is 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.

  • 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

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

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

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

  • 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: Transform of the box in which the perlin noise will be defined

property max_range: float

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

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

Type:

(float)

set_noise_field(min_range=0.000000, max_range=1.000000, transform) → NoiseField

Defines a perlin noise scalar value if the sample is within a box

Parameters:

  • 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

  • transform (Transform) – Transform of the box in which the perlin noise will be defined

Return type:

NoiseField

property transform: Transform

[Read-Write] Transform: Transform of the box in which the perlin noise will be defined

Type:

(Transform)