unreal.WaveScalar
¶
- class unreal.WaveScalar(outer: Optional[Object] = None, name: Union[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] 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.editable_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 if the falloff function is pickedfunction
(WaveFunctionType): [Read-Write] Function: Wave function used for the fieldis_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 wave functionon_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 deactivatedperiod
(float): [Read-Write] Period: Time over which the wave will travel from one peak to another one. The wave velocity is proportional to wavelength/periodposition
(Vector): [Read-Write] Position: Center position of the wave fieldprimary_component_tick
(ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Componentreplicate_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!wavelength
(float): [Read-Write] Wavelength: Distance between 2 wave peaks
- property falloff: FieldFalloffType¶
[Read-Write] Falloff: Type of falloff function used if the falloff function is picked
- Type:
- property function: WaveFunctionType¶
[Read-Write] Function: Wave function used for the field
- Type:
- property period: float¶
[Read-Write] Period: 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=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: