Mixer Options

This page was last updated for version v1.2.0

Description

To ensure smooth effect creation in the effect mixer and to avoid confusion for players, there are mixer options available for tick handlers. These settings allow for the following:

• Whether the tick handler appears in the list while mixing effects.

• Preventing the selection of another tick handler that works with the same event as the selected tick handler.

Additionally, other tick handlers required for the tick handler to function can be specified as dependencies. This way, after creating a mix, the dependencies are automatically added to the mix.

Options

lock-event

Format

mixer-options:
    lock-event: <BOOLEAN> # Default: true

Description

Prevents the selection of another tick handler that works with the same event as the selected tick handler.

private

Format

mixer-options:
    private: <BOOLEAN> # Default: false

Description

Determines whether the tick handler appears in the list while mixing effects.

depend

Format

mixer-options:
    depend: <LIST> # Default: empty list

Example

mixer-options:
    depend: [ 'some-tick-handler-key', 'another-tick-handler-key' ]

Description

Other tick handlers required for the tick handler to function can be specified as dependencies.