unreal.RadialVector

class unreal.RadialVector(outer=None, name='None')

Bases: unreal.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] 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

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

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

  • 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

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

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

property magnitude

[Read-Write] Magnitude of the radial vector field

Type

(float)

property position

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

Type

(Vector)

set_radial_vector(magnitude, 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

Returns

Return type

RadialVector