unreal.AvaSplineSweepModifier

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

Bases: AvaGeometryBaseModifier

Ava Spline Sweep Modifier

C++ Source:

• Plugin: Avalanche

• Module: AvalancheModifiers

• File: AvaSplineSweepModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

• capped (bool): [Read-Write] Whether start and end are closed, loop must be false

• looped (bool): [Read-Write] Whether we close the whole spline path, if spline loops this will be true

• modifier_enabled (bool): [Read-Write] Is the modifier enabled or disabled

• progress_end (float): [Read-Write] Sample end range of the spline

• progress_offset (float): [Read-Write] Sample range offset of the spline, for closed loop spline range can wrap around

• progress_start (float): [Read-Write] Sample start range of the spline

• sample_distance (float): [Read-Write] Custom sample distance for steps per distance mode

• sample_mode (AvaSplineSweepSampleMode): [Read-Write] How do we sample the spline

• scale_end (float): [Read-Write] End scale of the spline mesh

• scale_start (float): [Read-Write] Start scale of the spline mesh

• spline_actor_weak (Actor): [Read-Write] Spline actor to retrieve the USplineComponent from

• steps (int32): [Read-Write] The sample count defines the precision of the sweep

property capped: bool

[Read-Write] Whether start and end are closed, loop must be false

Type:

(bool)

get_capped() → bool

Get Capped

Return type:

bool

get_looped() → bool

Get Looped

Return type:

bool

get_progress_end() → float

Get Progress End

Return type:

float

get_progress_offset() → float

Get Progress Offset

Return type:

float

get_progress_start() → float

Get Progress Start

Return type:

float

get_sample_distance() → float

Get Sample Distance

Return type:

float

get_sample_mode() → AvaSplineSweepSampleMode

Get Sample Mode

Return type:

AvaSplineSweepSampleMode

get_scale_end() → float

Get Scale End

Return type:

float

get_scale_start() → float

Get Scale Start

Return type:

float

get_steps() → int32

Get Steps

Return type:

int32

property looped: bool

[Read-Write] Whether we close the whole spline path, if spline loops this will be true

Type:

(bool)

property progress_end: float

[Read-Write] Sample end range of the spline

Type:

(float)

property progress_offset: float

[Read-Write] Sample range offset of the spline, for closed loop spline range can wrap around

Type:

(float)

property progress_start: float

[Read-Write] Sample start range of the spline

Type:

(float)

property sample_distance: float

[Read-Write] Custom sample distance for steps per distance mode

Type:

(float)

property sample_mode: AvaSplineSweepSampleMode

[Read-Write] How do we sample the spline

Type:

(AvaSplineSweepSampleMode)

property scale_end: float

[Read-Write] End scale of the spline mesh

Type:

(float)

property scale_start: float

[Read-Write] Start scale of the spline mesh

Type:

(float)

set_capped(capped) → None

Set Capped

Parameters:

capped (bool) –

set_looped(looped) → None

Set Looped

Parameters:

looped (bool) –

set_progress_end(end) → None

Set Progress End

Parameters:

end (float) –

set_progress_offset(offset) → None

Set Progress Offset

Parameters:

offset (float) –

set_progress_start(start) → None

Set Progress Start

Parameters:

start (float) –

set_sample_distance(distance) → None

Set Sample Distance

Parameters:

distance (float) –

set_sample_mode(mode) → None

Set Sample Mode

Parameters:

mode (AvaSplineSweepSampleMode) –

set_scale_end(scale_end) → None

Set Scale End

Parameters:

scale_end (float) –

set_scale_start(scale_start) → None

Set Scale Start

Parameters:

scale_start (float) –

set_steps(steps) → None

Set Steps

Parameters:

steps (int32) –

property spline_actor_weak: Actor

[Read-Write] Spline actor to retrieve the USplineComponent from

Type:

(Actor)

property steps: int

[Read-Write] The sample count defines the precision of the sweep

Type:

(int32)