feat: drive button current step from expression #3128

companion/lib/Controls/ControlTypes/Button/Base.ts

@@ -23,7 +23,7 @@ import { DrawStyleButtonStateProps } from '@companion-app/shared/Model/StyleMode
  * Individual Contributor License Agreement for Companion along with
  * this program.
  */
-export abstract class ButtonControlBase<TJson, TOptions extends Record<string, any>>
+export abstract class ButtonControlBase<TJson, TOptions extends ButtonOptionsBase>
 	extends ControlBase<TJson>
 	implements ControlWithOptions, ControlWithPushed
 {
@@ -34,7 +34,10 @@ export abstract class ButtonControlBase<TJson, TOptions extends Record<string, a
 	/**
 	 * The defaults options for a button
 	 */
-	static DefaultOptions: ButtonOptionsBase = {}
+	static DefaultOptions: ButtonOptionsBase = {
+		stepProgression: 'auto',
+		stepExpression: '',
+	}
 
 	/**
 	 * Button hold state for each surface
@@ -73,6 +76,13 @@ export abstract class ButtonControlBase<TJson, TOptions extends Record<string, a
 				instanceDefinitions: deps.instance.definitions,
 				internalModule: deps.internalModule,
 				moduleHost: deps.instance.moduleHost,
+				executeExpressionInControl: (expression, requiredType, injectedVariableValues) =>
+					deps.variables.values.executeExpression(
+						expression,
+						deps.page.getLocationOfControlId(this.controlId),
+						requiredType,
+						injectedVariableValues
+					),
 			},
 			this.sendRuntimePropsChange.bind(this)
 		)
@@ -196,17 +206,14 @@ export abstract class ButtonControlBase<TJson, TOptions extends Record<string, a
 			cloud: false,
 			cloud_error: false,
 
-			step_cycle: undefined,
+			stepCurrent: this.entities.getActiveStepIndex() + 1,
+			stepCount: this.entities.getStepIds().length,
 
 			pushed: !!this.pushed,
 			action_running: this.actionRunner.hasRunningChains,
 			button_status: this.button_status,
 		}
 
-		if (this.entities.getStepIds().length > 1) {
-			result.step_cycle = this.entities.getActiveStepIndex() + 1
-		}
-
 		return result
 	}
 
@@ -244,7 +251,7 @@ export abstract class ButtonControlBase<TJson, TOptions extends Record<string, a
 	 * @param force Trigger actions even if already in the state
 	 */
 	pressControl(pressed: boolean, surfaceId: string | undefined, force: boolean): void {
-		const [thisStepId, nextStepId] = this.entities.validateCurrentStepIdAndGetNext()
+		const [thisStepId, nextStepId] = this.entities.validateCurrentStepIdAndGetNextProgression()
 
 		let pressedDuration = 0
 		let pressedStep = thisStepId
@@ -279,7 +286,7 @@ export abstract class ButtonControlBase<TJson, TOptions extends Record<string, a
 			if (
 				thisStepId !== null &&
 				nextStepId !== null &&
-				this.options.stepAutoProgress &&
+				this.options.stepProgression === 'auto' &&
 				!pressed &&
 				(pressedStep === undefined || thisStepId === pressedStep)
 			) {

companion/lib/Controls/ControlTypes/Button/Normal.ts

@@ -82,7 +82,7 @@ export class ControlButtonNormal
 		this.options = {
 			...cloneDeep(ButtonControlBase.DefaultOptions),
 			rotaryActions: false,
-			stepAutoProgress: true,
+			stepProgression: 'auto',
 		}
 
 		if (!storage) {
@@ -98,6 +98,7 @@ export class ControlButtonNormal
 			this.options = Object.assign(this.options, storage.options || {})
 			this.entities.setupRotaryActionSets(!!this.options.rotaryActions, true)
 			this.entities.loadStorage(storage, true, isImport)
+			this.entities.stepExpressionUpdate(this.options)
 
 			// Ensure control is stored before setup
 			if (isImport) setImmediate(() => this.postProcessImport())
@@ -213,6 +214,8 @@ export class ControlButtonNormal
 	 * @param allChangedVariables - variables with changes
 	 */
 	onVariablesChanged(allChangedVariables: Set<string>): void {
+		this.entities.stepCheckExpressionOnVariablesChanged(allChangedVariables)
+
 		if (this.#last_draw_variables) {
 			for (const variable of allChangedVariables.values()) {
 				if (this.#last_draw_variables.has(variable)) {
@@ -225,6 +228,19 @@ export class ControlButtonNormal
 		}
 	}
 
+	/**
+	 * Update an option field of this control
+	 */
+	optionsSetField(key: string, value: any): boolean {
+		const changed = super.optionsSetField(key, value)
+
+		if (key === 'stepProgression' || key === 'stepExpression') {
+			this.entities.stepExpressionUpdate(this.options)
+		}
+
+		return changed
+	}
+
 	/**
 	 * Update the style fields of this control
 	 * @param diff - config diff to apply

companion/lib/Controls/ControlTypes/Triggers/Trigger.ts

@@ -150,6 +150,8 @@ export class ControlTrigger
 			instanceDefinitions: deps.instance.definitions,
 			internalModule: deps.internalModule,
 			moduleHost: deps.instance.moduleHost,
+			executeExpressionInControl: (expression, requiredType, injectedVariableValues) =>
+				deps.variables.values.executeExpression(expression, null, requiredType, injectedVariableValues),
 		})
 
 		this.#eventBus = eventBus

companion/lib/Controls/Entities/EntityListPoolBase.ts

@@ -12,7 +12,9 @@ import type { ModuleHost } from '../../Instance/Host.js'
 import type { InternalController } from '../../Internal/Controller.js'
 import { isEqual } from 'lodash-es'
 import type { InstanceDefinitionsForEntity } from './Types.js'
-import { ButtonStyleProperties } from '@companion-app/shared/Model/StyleModel.js'
+import type { ButtonStyleProperties } from '@companion-app/shared/Model/StyleModel.js'
+import type { CompanionVariableValues } from '@companion-module/base'
+import type { ExecuteExpressionResult } from '../../Variables/Util.js'
 
 export interface ControlEntityListPoolProps {
 	instanceDefinitions: InstanceDefinitionsForEntity
@@ -21,6 +23,11 @@ export interface ControlEntityListPoolProps {
 	controlId: string
 	commitChange: (redraw?: boolean) => void
 	triggerRedraw: () => void
+	executeExpressionInControl: (
+		expression: string,
+		requiredType?: string,
+		injectedVariableValues?: CompanionVariableValues
+	) => ExecuteExpressionResult
 }
 
 export abstract class ControlEntityListPoolBase {