utils.ogmo.wren

Ogmo

Utility Classes for Parsing Ogmo Json files.

Based on https://github.com/Ogmo-Editor-3/ogmo-3-lib

Example:

import "domepunk/utils/ogmo" for Project, Level

class Game {
    static init() {
      var ogmo = Project.load("project.ogmo")
      System.print(ogmo.version)

      var level = Level.load("level.json")
      level.onTileLayerLoaded {|data, layer|
        System.print("onTileLayerLoaded triggered")
        System.print(data)
      }

      level.init()

    }
    static update() {}
    static draw(dt) {}
}

Since: 1.0.0
Dome: 1.4.0
Ogmo: 3.2.2

Class Project

import "domepunk/utils/ogmo" for Project

// alias
import "domepunk/utils/ogmo" for OgmoProject, OProj

API

name

The Name of the Ogmo Project.

version

The version of Ogmo used

levelPaths

Array of paths that hold the Project's levels.

backgroundColor

The Project's background color.

gridColor

The color of the Grid displayed in the Project's Editor

anglesRadians

Flag to set whether the Project describes rotations in Radians or Degrees. If set to true its in Radians. Otherwise it is in Degrees.

defaultExportMode

Sets the default exported file type of a Level.

directoryDepth

Maximum Depth that the Editor will search for files for its File Tree.

levelDefaultSize

Default size of newly created levels in the Editor.

levelMinSize

Minimum size a level can be.

levelMaxSize

Maximum size a level can be.

levelValues

Array of Value Templates for the Project's Levels.

entityTags

Array containing all of the Project's available Entity Tags.

layers

Array containing all of the Project's available Layer Templates.

entities

Array containing all of the Project's available Entity Templates.

tilesets

Array containing all of the Project's available Tilesets.

layerGridDefaultSize

static load(path)

Creates an Ogmo Project from .ogmo data.

Signature: static load(path:String) -> Project
Parameter path: String to the file holding Ogmo data.
Returns: Project parsed from Ogmo file.

entity(exportID)

Attempts to get an ProjectEntity from an exportID.

Parameter exportID: The export id
Returns: ProjectEntity or null

layer(exportID)

Attempts to get an ProjectLayer from an exportID.

Parameter exportID: The export id
Returns: ProjectLayer or null

tileset(name)

Attempts to get an ProjectTileset from an exportID.

Parameter name: The tileset name
Returns: ProjectTileset or null

Class Level

import "domepunk/utils/ogmo" for Level

// alias
import "domepunk/utils/ogmo" for OgmoLevel, OLevel

API

width

Width of the Level.

height

Height of the Level.

size

Size (width, height)

offsetX

Offset of the Level on the X axis. Useful for loading multiple chunked Levels.

offsetY

Offset of the Level on the Y axis. Useful for loading multiple chunked Levels.

offset

Point (offsetX, offsetY)

layers

Array containing all of the Level's Layer Definitions.

values

Array containing all of the Level's custom values.

onDecalLayerLoaded = (value)

Callback triggered when a Decal layer is found after calling load() on a Level. The first argument is an Array holding the Layer's Decal Definitions. The second argument is the Layer Definition itself.

onEntityLayerLoaded = (value)

k triggered when an Entity layer is found after calling load() on a Level. The first argument is an Array holding the Layer's Entity Definitions. The second argument is the Layer Definition itself.

onGridLayerLoaded = (value)

Callback triggered when a Grid layer exported with a 1D Data Array is found after calling load() on a Level. The first argument is a 1D Array holding the Layer's Grid Data. The second argument is the Layer Definition itself.

onGrid2DLayerLoaded = (value)

Callback triggered when a Grid layer exported with a 2D Data Array is found after calling load() on a Level. The first argument is a 2D Array holding the Layer's Grid Data. The second argument is the Layer Definition itself.

onTileLayerLoaded = (value)

Callback triggered when a Tile layer exported with a 1D Data Array containing Tile IDs is found after calling load() on a Level. The first argument is a 1D Array holding the Layer's Tile ID Data. The second argument is the Layer Definition itself.

onTile2DLayerLoaded = (value)

Callback triggered when a Tile layer exported with a 2D Data Array containing Tile IDs is found after calling load() on a Level. The first argument is a 2D Array holding the Layer's Tile ID Data. The second argument is the Layer Definition itself.

onTileCoordsLayerLoaded = (value)

Callback triggered when a Tile layer exported with a 2D Data Array containing Tile Coords is found after calling load() on a Level. The first argument is a 2D Array holding the Layer's Tile Cordinate Data. The second argument is the Layer Definition itself.

onTileCoords2DLayerLoaded = (value)

Callback triggered when a Tile layer exported with a 3D Data Array containing Tile Coords is found after calling load() on a Level. The first argument is a 3D Array holding the Layer's Tile Coords Data. The second argument is the Layer Definition itself.