Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: TiledMap

[17:7] extends: FxObj

Wraps FXGL's TiledMap data class (com.almasb.fxgl.entity.level.tiled.TiledMap), the parsed representation of a Tiled .tmx file. Holds dimensions, layers, tilesets, and properties. Typically obtained as a raw AJO from FXGL's Tiled parsing pipeline; the wrapper exposes the read-only field surface for inspection.

Methods

  • TiledMap ()

    Empty default constructor; populated by adopt.

  • adopt (object Ajo)

    Wraps an existing TiledMap AussomJavaObject.

  • getWidth ()

  • getHeight ()

  • getTilewidth ()

  • getTileheight ()

  • getOrientation ()

  • getBackgroundcolor ()

  • getRenderorder ()

  • getVersion ()

  • getTiledversion ()

  • getType ()

  • isInfinite ()

  • getHexsidelength ()

    Returns the hex side length (only used by hex maps).

  • getNextobjectid ()

    Returns the next-object id counter used during Tiled editing.

  • getStaggeraxis ()

    Returns the stagger axis ("x" / "y") for staggered maps.

  • getStaggerindex ()

    Returns the stagger index ("even" / "odd") for staggered maps.

  • getPropertytypes ()

    Returns the property-type metadata map as an AJO.

  • getLayers ()

    Returns the layers list as an AJO.

  • getTilesets ()

    Returns the tilesets list as an AJO.

  • getProperties ()

    Returns the properties map as an AJO.

  • getLayerByName (string Name)

    Returns the named layer as a Layer AJO, or throws when the name is not present.

  • setWidth (int V)

    Sets the map width (in tiles). Returns this for chaining.

  • setHeight (int V)

    Sets the map height (in tiles). Returns this for chaining.

  • setTilewidth (int V)

    Sets the per-tile width (in pixels).

  • setTileheight (int V)

    Sets the per-tile height (in pixels).

  • setOrientation (string V)

    Sets the orientation string ("orthogonal" / "isometric" / etc).

  • setBackgroundcolor (string V)

    Sets the background color string ("#rrggbb").

  • setRenderorder (string V)

    Sets the render order ("right-down" / etc).

  • setNextobjectid (int V)

    Sets the next-object id counter.

  • setVersion (int V)

    Sets the Tiled map format version.

  • setTiledversion (string V)

    Sets the Tiled editor version string.

  • setType (string V)

    Sets the Tiled object type string.

  • setInfinite (bool V)

    Sets the infinite-map flag.

  • setHexsidelength (int V)

    Sets the hex side length (hex maps only).

  • setStaggeraxis (string V)

    Sets the stagger axis ("x" / "y").

  • setStaggerindex (string V)

    Sets the stagger index ("even" / "odd").

  • setLayers (object ListAjo)

    Replaces the layers list. Accepts a Java List AJO.

  • setTilesets (object ListAjo)

    Replaces the tilesets list. Accepts a Java List AJO.

  • setProperties (object MapAjo)

    Replaces the properties map. Accepts a Java Map AJO.

  • setPropertytypes (object MapAjo)

    Replaces the property-type metadata map. Accepts a Java Map AJO.