unreal.UniformVector

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

Bases: FieldNodeVector

Set a uniform vector value independently of the sample position.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

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

  • direction (Vector): [Read-Write] Normalized direction of the uniform vector field

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

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

property direction: Vector

[Read-Write] Normalized direction of the uniform vector field

Type:

(Vector)

property magnitude: float

[Read-Write] Magnitude of the uniform vector field

Type:

(float)

set_uniform_vector(magnitude=1.000000, direction) → UniformVector

Set a uniform vector value independently of the sample position.The output is equal to magnitude * direction

Parameters:

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

  • direction (Vector) – Normalized direction of the uniform vector field

Return type:

UniformVector