Skip to content

TriggerChannel

rech edited this page Jun 15, 2026 · 1 revision

Description

Class for creating different trigger channels.

Remarks

Trigger channels combine multiple triggers into a single value channel.

Methods


accumulate(triggers...)

Description

Creates an accumulating trigger channel. Ongoing trigger events will be halted upon a new one arriving.

Parameters

Name Type Description
triggers Trigger... Variable number of triggers to accumulate

Return types

AccumulatingTriggerChannel

Remarks

_

Example

local trig1 = Trigger.observe(Context.currentCombo).goAbove(100).dispatch(Channel.constant(1), 500, "so")
local trig2 = Trigger.observe(Context.currentCombo).goBelow(50).dispatch(Channel.constant(0), 500, "si")
local channel = TriggerChannel.accumulate(trig1, trig2)

loop(triggers...)

Description

Creates a looping trigger channel. The channel's value will be reset once a trigger event arrives.

Parameters

Name Type Description
triggers Trigger... Variable number of triggers

Return types

LoopingTriggerChannel

Remarks

_

Example

local channel = TriggerChannel.loop(trig1, trig2)

stack(triggers...)

Description

Creates a stacking trigger channel. Similar to accumulating channels, but new trigger events will not halt ongoing ones.

Parameters

Name Type Description
triggers Trigger... Variable number of triggers

Return types

StackingTriggerChannel

Remarks

_

Example

local channel = TriggerChannel.stack(trig1, trig2)

setTo(triggers...)

Description

Creates a trigger channel that instantly sets its value to the trigger event's value, ignoring duration.

Parameters

Name Type Description
triggers Trigger... Variable number of triggers

Return types

SettingTriggerChannel

Remarks

_

Example

local channel = TriggerChannel.setTo(trig1, trig2)

Clone this wiki locally