Class ObjectHelper

constructor

• new ObjectHelper(tilesets: Tileset[]): ObjectHelper

  Parameters

  • tilesets: Tileset[]

    The backing tileset data.

  Returns ObjectHelper

enabled

gids

getTypeIncludingTile

• getTypeIncludingTile(obj: TiledObject): string

  Gets the Tiled type field value from the object or the gid behind it.

  Parameters

  • obj: TiledObject

    The Tiled object to investigate.

  Returns string

setPropertiesFromTiledObject

• setPropertiesFromTiledObject(sprite: GameObject, obj: TiledObject): void

  Sets the sprite.data field from the tiled properties on the object and its tile (if any).

  Parameters

  • sprite: GameObject
  • obj: TiledObject

  Returns void

setTextureAndFrame

• setTextureAndFrame(
      sprite: GameObject,
      key?: string | Textures.Texture,
      frame?: string | number | Frame,
      obj?: TiledObject,
  ): void

  Sets the sprite texture data as specified (usually in a config) or, failing that, as specified in the gid of the object being loaded (if any).

  This fallback will only work if the tileset was loaded as a spritesheet matching the geometry of sprites fed into tiled, so that, for example: "tile id #3"" within the tileset is the same as texture frame 3 from the image of the tileset.

  Parameters

  • sprite: GameObject

    The Game Object to modify.
  • Optionalkey: string | Textures.Texture

    The texture key to set (or else the obj.gid's tile is used if available).
  • Optionalframe: string | number | Frame

    The frames key to set (or else the obj.gid's tile is used if available).
  • Optionalobj: TiledObject

    The Tiled object for fallback.

  Returns void