Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: NeighborDirection

[13:14] static extends: object

Helper for FXGL's NeighborDirection enum, used as the optional argument to Grid.getNeighbors. Two values: FOUR_DIRECTIONS (up, down, left, right) and EIGHT_DIRECTIONS (those plus the four diagonals).

Methods

  • get (string Name)

    Resolves a NeighborDirection enum value by name.

    • @p Name is the value name: "FOUR_DIRECTIONS" or "EIGHT_DIRECTIONS".
    • @r An AussomJavaObject wrapping the enum value.
  • values ()

    Returns NeighborDirection[] containing every constant.

  • valueOf (string Name)

    Standard Enum.valueOf strict lookup.