Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: VirtualButton

[20:14] static extends: object

Helper for FXGL's VirtualButton enum (com.almasb.fxgl.input.virtual.VirtualButton). Ten on-screen controller buttons that map to either a virtual D-pad direction or an Xbox / PS face button:

  • LEFT, RIGHT, UP, DOWN (D-pad)
  • A, B, X, Y (face buttons)
  • LB, RB (left / right bumper) Pass values from Input.addAction(action, key, VirtualButton) and the Virtual* on-screen controller wrappers.

Methods

  • LEFT ()

    Returns the LEFT enum AJO.

  • RIGHT ()

    Returns the RIGHT enum AJO.

  • UP ()

    Returns the UP enum AJO.

  • DOWN ()

    Returns the DOWN enum AJO.

  • A ()

    Returns the A enum AJO.

  • B ()

    Returns the B enum AJO.

  • X ()

    Returns the X enum AJO.

  • Y ()

    Returns the Y enum AJO.

  • LB ()

    Returns the LB enum AJO.

  • RB ()

    Returns the RB enum AJO.

  • get (string Name)

    Resolves a VirtualButton by name.

    • @p Name is one of "LEFT", "RIGHT", "UP", "DOWN", "A", "B", "X", "Y", "LB", "RB".
  • values ()

    Returns VirtualButton[] containing every constant.

  • valueOf (string Name)

    Standard Enum.valueOf strict lookup.