Module flower.tiled.TileObjectGroup

This class manages the TileObject.

Extends:

Info:

  • Release: V3.0.0
  • Author: Makoto

Functions

TileObjectGroup:init (tileMap) The constructor.
TileObjectGroup:loadData (data) Load the objectgroup data.
TileObjectGroup:saveData () Save the objectgroup data.
TileObjectGroup:createObjects (objectDatas) Create a TileObjects from the data.
TileObjectGroup:createObject (objectData) Create a TileObject from the data.
TileObjectGroup:addObject (object) Add a TileObject.
TileObjectGroup:getObjects () Returns a TileObjects.
TileObjectGroup:findObject (fieldName, fieldValue) Find a TileObject.
TileObjectGroup:findObjectByName (name) Find a TileObject by name.
TileObjectGroup:findObjectByType (type) Find a TileObject by type.
TileObjectGroup:findObjects (fieldName, fieldValue) Find a TileObjects.
TileObjectGroup:findObjectsByName (name) Find a TileObjects by name.
TileObjectGroup:findObjectsByType (type) Find a TileObjects.
TileObjectGroup:removeObject (object) Remove a TileObject.
TileObjectGroup:getProperty (key) Returns the property.
TileObjectGroup:getPropertyAsNumber (key) Returns the property.


Functions

TileObjectGroup:init (tileMap)
The constructor.

Parameters:

  • tileMap TileMap
TileObjectGroup:loadData (data)
Load the objectgroup data.

Parameters:

  • data objectgroup data
TileObjectGroup:saveData ()
Save the objectgroup data.

Returns:

    objectgroup data
TileObjectGroup:createObjects (objectDatas)
Create a TileObjects from the data.

Parameters:

  • objectDatas object datas

Returns:

    TileObject list
TileObjectGroup:createObject (objectData)
Create a TileObject from the data.

Parameters:

  • objectData object data

Returns:

    TileObject
TileObjectGroup:addObject (object)
Add a TileObject.

Parameters:

  • object TileObject
TileObjectGroup:getObjects ()
Returns a TileObjects.

Returns:

    objects
TileObjectGroup:findObject (fieldName, fieldValue)
Find a TileObject.

Parameters:

  • fieldName Name of the field.
  • fieldValue Value of the field.

Returns:

    object
TileObjectGroup:findObjectByName (name)
Find a TileObject by name.

Parameters:

  • name name

Returns:

    object
TileObjectGroup:findObjectByType (type)
Find a TileObject by type.

Parameters:

  • type type

Returns:

    object
TileObjectGroup:findObjects (fieldName, fieldValue)
Find a TileObjects.

Parameters:

  • fieldName Name of the field.
  • fieldValue Value of the field.

Returns:

    objects
TileObjectGroup:findObjectsByName (name)
Find a TileObjects by name.

Parameters:

  • name name

Returns:

    objects
TileObjectGroup:findObjectsByType (type)
Find a TileObjects.

Parameters:

  • type type

Returns:

    objects
TileObjectGroup:removeObject (object)
Remove a TileObject.

Parameters:

  • object TileObject
TileObjectGroup:getProperty (key)
Returns the property.

Parameters:

  • key key.

Returns:

    value.
TileObjectGroup:getPropertyAsNumber (key)
Returns the property.

Parameters:

  • key key.

Returns:

    value.
generated by LDoc 1.3