unreal.AvaBooleanModifier

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

Bases: AvaGeometryBaseModifier

This modifier allows you to apply a mask on a certain shape, this will affect every shape it collides with that matches options

C++ Source:

  • Plugin: Avalanche

  • Module: AvalancheModifiers

  • File: AvaBooleanModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • channel (uint8): [Read-Write] Channel to only apply this tool on shapes with the same channel

  • mode (AvaBooleanMode): [Read-Write] Mode to use when shapes are colliding, none means you will be masked otherwise you are masking

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

get_channel() uint8

Get Channel

Return type:

uint8

get_mode() AvaBooleanMode

Get Mode

Return type:

AvaBooleanMode

set_channel(channel) None

Set Channel

Parameters:

channel (uint8)

set_mode(mode) None

Set Mode

Parameters:

mode (AvaBooleanMode)