unreal.WindDirectionalSourceComponent

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

Bases: unreal.SceneComponent

Component that provides a directional wind source. Only affects SpeedTree assets.

C++ Source:

  • Module: Engine

  • File: WindDirectionalSourceComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] If RelativeScale3D should be considered relative to the world, rather than the parent

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

  • detail_mode (DetailMode): [Read-Write] If detail mode is >= system detail mode, primitive won’t be rendered.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • hidden_in_game (bool): [Read-Write] Whether to hide the primitive in game, if the primitive is Visible.

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

  • max_gust_amount (float): [Read-Write] Max Gust Amount

  • min_gust_amount (float): [Read-Write] Min Gust Amount

  • mobility (ComponentMobility): [Read-Write] How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • 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

  • physics_volume_changed_delegate (PhysicsVolumeChanged): [Read-Write] Delegate that will be called when PhysicsVolume has been changed *

  • point_wind (bool): [Read-Write] Point Wind

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

  • radius (float): [Read-Write] Radius

  • relative_location (Vector): [Read-Write] Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

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

  • should_update_physics_volume (bool): [Read-Write] Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()

  • speed (float): [Read-Write] Speed

  • strength (float): [Read-Write] Strength

  • use_attach_parent_bound (bool): [Read-Write] If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.

  • visible (bool): [Read-Write] Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

property max_gust_amount

[Read-Only] Max Gust Amount

Type

(float)

property min_gust_amount

[Read-Only] Min Gust Amount

Type

(float)

property point_wind

[Read-Only] Point Wind

Type

(bool)

property radius

[Read-Write] Radius

Type

(float)

set_maximum_gust_amount(new_max_gust) → None

Set maximum deviation for wind gusts

Parameters

new_max_gust (float) –

set_minimum_gust_amount(new_min_gust) → None

Set minimum deviation for wind gusts

Parameters

new_min_gust (float) –

set_radius(new_radius) → None

Set the effect radius for point wind

Parameters

new_radius (float) –

set_speed(new_speed) → None

Sets the windspeed of the generated wind

Parameters

new_speed (float) –

set_strength(new_strength) → None

Sets the strength of the generated wind

Parameters

new_strength (float) –

set_wind_type(new_type) → None

Set the type of wind generator to use

Parameters

new_type (WindSourceType) –

property speed

[Read-Write] Speed

Type

(float)

property strength

[Read-Write] Strength

Type

(float)