unreal.WaveScalar

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

Bases: FieldNodeFloat

Set a temporal wave scalar value according to the sample distance from the field position.

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

  • asset_user_data_editor_only (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.

  • 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 if the falloff function is picked

  • function (WaveFunctionType): [Read-Write] Wave function used for the field

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

  • magnitude (float): [Read-Write] Magnitude of the wave function

  • 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

  • period (float): [Read-Write] Time over which the wave will travel from one peak to another one. The wave velocity is proportional to wavelength/period

  • position (Vector): [Read-Write] Center position of the wave 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!

  • wavelength (float): [Read-Write] Distance between 2 wave peaks

property falloff: FieldFalloffType

[Read-Write] Type of falloff function used if the falloff function is picked

Type:

(FieldFalloffType)

property function: WaveFunctionType

[Read-Write] Wave function used for the field

Type:

(WaveFunctionType)

property magnitude: float

[Read-Write] Magnitude of the wave function

Type:

(float)

property period: float

[Read-Write] Time over which the wave will travel from one peak to another one. The wave velocity is proportional to wavelength/period

Type:

(float)

property position: Vector

[Read-Write] Center position of the wave field

Type:

(Vector)

set_wave_scalar(magnitude=1.000000, position, wavelength=1000.000000, period=1.000000, time, function, falloff) → WaveScalar

Set a temporal wave scalar value according to the sample distance from the field position.

Parameters:

  • magnitude (float) – Magnitude of the wave function

  • position (Vector) – Center position of the wave field

  • wavelength (float) – Distance between 2 wave peaks

  • period (float) – Time over which the wave will travel from one peak to another one. The wave velocity is proportional to wavelength/period

  • time (float) –

  • function (WaveFunctionType) – Wave function used for the field

  • falloff (FieldFalloffType) – Type of falloff function used if the falloff function is picked

Return type:

WaveScalar

property wavelength: float

[Read-Write] Distance between 2 wave peaks

Type:

(float)