@companion-module/base
    Preparing search index...

    Interface CompanionLayeredButtonPresetDefinition<TManifest>

    The definition of a companion element based (layered) button preset In many cases the simple preset type will be sufficient, but the layered preset allows for more complex buttons with multiple layers of graphics and feedbacks

    interface CompanionLayeredButtonPresetDefinition<
        TManifest extends InstanceTypes = InstanceTypes,
    > {
        canvas?: ButtonGraphicsCanvasElement;
        elements: SomeButtonGraphicsElement<TManifest["compositeElements"]>[];
        feedbacks: SomePresetLayeredFeedbackEntry<TManifest>[];
        keywords?: string[];
        localVariables?: CompanionPresetLocalVariable<TManifest["feedbacks"]>[];
        name: string;
        options?: CompanionLayeredButtonPresetDefinitionOptions;
        steps: CompanionButtonStepActions<TManifest>[];
        type: "layered";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    canvas? elements feedbacks keywords? localVariables? name options? steps type

    Properties

    canvas?: ButtonGraphicsCanvasElement

    Drawing properties for the base canvas

    elements: SomeButtonGraphicsElement<TManifest["compositeElements"]>[]

    The drawing elements for this preset, this will be copied to the button

    feedbacks: SomePresetLayeredFeedbackEntry<TManifest>[]

    The feedbacks on the button

    keywords?: string[]

    Keywords for the preset This is extra search terms to allow users to find the right preset

    localVariables?: CompanionPresetLocalVariable<TManifest["feedbacks"]>[]

    Local variables on this button

    name: string

    A name for this preset This is typically shown as a tooltip

    options?: CompanionLayeredButtonPresetDefinitionOptions

    Options for this preset

    steps: CompanionButtonStepActions<TManifest>[]
    type: "layered"

    The type of the preset

    Settings

    Member Visibility

    On This Page

    Properties