Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: Trigger

[18:7] extends: FxObj

Wraps FXGL's Trigger interface (com.almasb.fxgl.input.Trigger), the abstract supertype of KeyTrigger and MouseTrigger. Carries the modifier (NONE / CTRL / SHIFT / ALT), a display name, and pressed / released match queries against a JavaFX InputEvent. Adopt-only — Trigger has no public constructor; obtain one from Input.getAllBindings, a KeyTrigger / MouseTrigger ctor, or an ObservableTrigger.

Methods

  • Trigger ()

    Empty default constructor; populated by adopt.

  • adopt (object Ajo)

    Wraps an existing Trigger AussomJavaObject.

    • @p Ajo is an AussomJavaObject around a Trigger.
    • @r A new wrapper.
  • getName ()

    Returns the trigger's display name.

  • getModifierName ()

    Returns the InputModifier name ("NONE" / "CTRL" / "SHIFT" / "ALT") this trigger requires.

  • getModifier ()

    Returns the raw InputModifier enum AJO.

  • isKey ()

    Returns true when this trigger is a keyboard binding.

  • isButton ()

    Returns true when this trigger is a mouse binding.

  • isTriggered (object EventAjo)

    Returns true if the supplied JavaFX InputEvent matches the trigger's pressed condition.

  • isReleased (object EventAjo)

    Returns true if the supplied JavaFX InputEvent matches the trigger's released condition.