unreal.RadialVector

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

Bases: FieldNodeVector

Set a radial vector value, the direction being the vector from the sample position to the field one. The output is equal to magnitude * direction

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

  • magnitude (float): [Read-Write] Magnitude: Magnitude of the radial vector field

  • 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

  • position (Vector): [Read-Write] Position: Center position of the radial vector field

  • 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!

property magnitude: float

[Read-Write] Magnitude: Magnitude of the radial vector field

Type:

(float)

property position: Vector

[Read-Write] Position: Center position of the radial vector field

Type:

(Vector)

set_radial_vector(magnitude=1.000000, position) → RadialVector

Set a radial vector value. The direction is the normalized vector from the field position to the sample one. The output is equal to this direction * magnitude.

Parameters:

  • magnitude (float) – Magnitude of the radial vector field

  • position (Vector) – Center position of the radial vector field

Return type:

RadialVector