unreal.WaveScalar
¶
- class unreal.WaveScalar(outer=None, name='None')¶
Bases:
unreal.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 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.editable_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 if the falloff function is pickedfunction
(WaveFunctionType): [Read-Write] Wave function used for the fieldis_editor_only
(bool): [Read-Write] If true, the component will be excluded from non-editor buildsmagnitude
(float): [Read-Write] Magnitude of the wave functionon_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 deactivatedperiod
(float): [Read-Write] Time over which the wave will travel from one peak to another one. The wave velocity is proportional to wavelength/periodposition
(Vector): [Read-Write] Center position of the wave fieldprimary_component_tick
(ActorComponentTickFunction): [Read-Write] Main tick function for the Componentreplicates
(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¶
[Read-Write] Type of falloff function used if the falloff function is picked
- Type
- property function¶
[Read-Write] Wave function used for the field
- Type
- property period¶
[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)
- set_wave_scalar(magnitude, position, wavelength, period, 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
- Returns
- Return type