TriggerBuilder


Methods

setTickTock (
tickTock Int
)

Resets the connected instrumentBuilder’s parameter to the original value every odd loop and the triggerBuilder value every even loop.

setColorMinMax (
min Int[] max Int[]
)

Sets the minimum and maximum color intensity that allows an object to activate.

Color intensity is calculated based on the amount of color present in RGB color segment assigned to the object, per frame.

setConnection (
instrumentID Int triggerKey String
)

Sets which instrumentBuilder this triggerBuilder effects and when the triggerBuilder is activated.

The first value is the array index of the connected instrument.

The second value is an connection key and falls into a few categories

Instrument Enable/Disable
onEnable: Fired when an instrumentBuilder is enabled.
onDisable: Fired when an instrumentBuilder is disabled.

Instrument Counters
onCount: Fired to count how many times an instrument enabled and activated.
onUncount: Fired to count how many times an instrument is enabled but not activated.
onNoteCount: Fired to count how many times a specific note attached to an instrument is activated.
onInactiveCount: Fired to count how many times an instrument is on beat and disabled regardless of firing.
onActiveCount: Fired to count how many times an instrument is on beat and enabled regardless of firing.

Instrument Color
onVelocity: Fired when instrumentBuilder velocity is calculated.
onColorJitter: Fired when instrumentBuilder colorJitter is calculated.

setOperation (
operation String
)

The operation by which the triggered thresholds, set in setThresholds, are checked against.

setThresholds (
threshold Int thresholdSecond Int thresholdThird Int
)

Sets the value that allows the triggerBuilder to be activated.
The threshold unit and value range is determined by the triggerKey set in setConnection.

Most triggers only use the first value.
onEnable: Fires 1 on value 1 when true. Values 2 and 3 are not used.
onDisable: Fires 1 on value 1 when true. Values 2 and 3 are not used.
onCount: Fires count 0 – X on value 1. Values 2 and 3 are not used.
onUncount: Fires count 0 – X on value 1. Values 2 and 3 are not used.
onNoteCount: Fires count 0 – X on value 1, note set on value 2, and note number on value 3
onInactiveCount: Fires count 0 – X on value 1. Values 2 and 3 are not used.
onActiveCount: Fires count 0 – X on value 1. Values 2 and 3 are not used.
onVelocity: Fires count 0 – 127 on value 1. Values 2 and 3 are not used.
onColorJitter: Fires count 0 – 127 on value 1. Values 2 and 3 are not used.

setParameter (
parameter String newValue Int[]
)

When a triggerBuilder is activated, set what parameter and value pair are changed for the instrumentBuilder selected in the triggerBuilder’s setConnection.

The second value sets a parameter’s value.

The first value is a parameter key for the parameter being changed. Available keys:
midiEnable
colorMin
colorMax
currentNoteSet
currentNote
enable (for triggerCluster)
midiChannel
beatTime
beatRestrict
lumaAffectationAmount
lumaAffectationInversion
cosineAffectationAmount
cosineAffectationInversion
cosineNoiseAffectationAmount
noteBase
colorData
colorLower
colorUpper
noteBaseRangeMin
noteBaseRangeMax
noteLength

activeFilter (document level, not a per instrument parameter):

  • 0: No filter
  • 1: Saturate Red
  • 2: Saturate Green
  • 3: Saturate Blue
setEnable (
enable Int
)

1: Enable
0: Disabled

setEnableOnCount (
enableOnCount Int
)

Enable triggerBuilder after X attempts.

setTriggerCluster (
cluster Int[]
)

If a triggerBuilder’s setParameter first value is set to “enable”, an array of triggerBuilder indexes, set in setTriggerCluster, can be enabled or disabled with setParameter second value set to 0: disable or 1: enable.

The triggers in a triggerCluster as well as the triggerBuilder with the set triggerCluster method must all be connected to the same instrumentBuilder.

setTriggerLockLength (
lockLength Int
)

How long a triggerBuilder should be locked (not able to activate) after it has been activated.

setDisableOnCount (
disableOnCount Int
)

Disable triggerBuilder after X activations.