unreal.AvaGridArrangeModifier

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

Bases: AvaArrangeBaseModifier

Arranges child actors in a 2D grid format.

C++ Source:

  • Plugin: Avalanche

  • Module: AvalancheModifiers

  • File: AvaGridArrangeModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • count (IntPoint): [Read-Write] The width and height of the grid.

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

  • spread (Vector2D): [Read-Write] The distance between each horizontal and vertical child.

  • start_corner (AvaCorner2D): [Read-Write] The 2D corner from which to start the arrangement.

  • start_direction (AvaGridArrangeDirection): [Read-Write] The direction from which to start the arrangement.

property count: IntPoint

[Read-Write] The width and height of the grid.

Type:

(IntPoint)

get_arrangement_layout() -> (out_start_corner=AvaCorner2D, out_start_direction=AvaGridArrangeDirection)

Returns the 2D corner and direction from which to start the arrangement.

Returns:

out_start_corner (AvaCorner2D):

out_start_direction (AvaGridArrangeDirection):

Return type:

tuple

get_count() → IntPoint

Returns the width and height of the grid.

Return type:

IntPoint

get_spread() → Vector2D

Returns the distance between each horizontal and vertical child.

Return type:

Vector2D

get_start_corner() → AvaCorner2D

Get Start Corner

Return type:

AvaCorner2D

get_start_direction() → AvaGridArrangeDirection

Get Start Direction

Return type:

AvaGridArrangeDirection

set_arrangement_layout(new_start_corner, new_start_direction) → None

Sets the 2D corner and direction from which to start the arrangement.

Parameters:
set_count(new_count) → None

Sets the width and height of the grid.

Parameters:

new_count (IntPoint) –

set_spread(new_spread) → None

Sets the distance between each horizontal and vertical child.

Parameters:

new_spread (Vector2D) –

set_start_corner(corner) → None

Set Start Corner

Parameters:

corner (AvaCorner2D) –

set_start_direction(direction) → None

Set Start Direction

Parameters:

direction (AvaGridArrangeDirection) –

property spread: Vector2D

[Read-Write] The distance between each horizontal and vertical child.

Type:

(Vector2D)

property start_corner: AvaCorner2D

[Read-Write] The 2D corner from which to start the arrangement.

Type:

(AvaCorner2D)

property start_direction: AvaGridArrangeDirection

[Read-Write] The direction from which to start the arrangement.

Type:

(AvaGridArrangeDirection)