Function onHolding

  • Registers a handler for every frame in which the given Bindable is held down.

    Your decorated method should return whether or not the bindable is actually held. (For example, if the mouse was in the right spot and the action can currently be executed.) If you return true, no other @Bind.onHolding handlers will be run. If you return false, other matching @Bind.onHolding handlers will be run.

    Parameters

    • bindable: default

      The Bindable.

    • Optional priority: number

      The "priority" of this handler compared to other handlers. Higher priorities are executed first.

    Returns ((host: any, property2: string | number | symbol, descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler>) => void)

      • (host: any, property2: string | number | symbol, descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler>): void

      • Parameters

        • host: any
        • property2: string | number | symbol
        • descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler>

        Returns void

  • Registers a handler for every frame in which anything is held down.

    Parameters

    • bindable: "anything"

      Must be the string "anything".

    • Optional priority: number

      The "priority" of this handler compared to other handlers. Higher priorities are executed first.

    Returns ((host: any, property2: string | number | symbol, descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler<any>>) => void)

      • (host: any, property2: string | number | symbol, descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler<any>>): void

      • Parameters

        • host: any
        • property2: string | number | symbol
        • descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler<any>>

        Returns void

  • Registers a handler for every frame in which the given Bindable or "anything" is held down. This handler will always be executed, even if other handlers also matched the catalyst.

    Parameters

    • bindable: default | "anything"

      The Bindable, or the string "anything" (to handle when anything is held).

    • priority: undefined | number

      The "priority" of this handler compared to other handlers. Higher priorities are executed first.

    • always: true

      Must be true.

    Returns ((host: any, property2: string | number | symbol, descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler<any>>) => void)

      • (host: any, property2: string | number | symbol, descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler<any>>): void

      • Parameters

        • host: any
        • property2: string | number | symbol
        • descriptor: TypedPropertyDescriptorFunctionAnyNOfParams<BindingHandler<any>>

        Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc