API Docs for: 0.1.1
Show:

flatworld.UIs.default Class

Defined in: src/components/map/UIs/default/default.js:22

The simplest default UI implementation. Implemented UI functionalities for: showSelections, highlightSelectedObject

Constructor

flatworld.UIs.default

(
  • modal
  • FTW
  • options
)

Defined in src/components/map/UIs/default/default.js:22

Parameters:

  • modal HTMLElement

    The modal used in this UI Theme

  • FTW Flatworld

    Instance of flatworld class

  • options Object

    optional options

    • styles Object

      styles for the UI

Methods

_getElement

(
  • which
)
type private static

Defined in src/components/map/UIs/default/default.js:267

Parameters:

  • which type

    [description]

Returns:

type:

[description]

_highlightSelectedObject

(
  • object
  • movableLayer
  • renderer
)
private static

Defined in src/components/map/UIs/default/default.js:179

Parameters:

  • object Object
  • movableLayer MapLayer
  • renderer PIXI.Renderer

addCSSRulesToScriptTag

(
  • sheet
  • rules
)

Defined in src/components/map/UIs/default/default.js:230

Parameters:

addStyleElement

()

Defined in src/components/map/UIs/default/default.js:239

createHighlight

() private static

Defined in src/components/map/UIs/default/default.js:200

getTemplates Required by the map/core/UI.js API

()

Defined in src/components/map/UIs/default/default.js:70

getTemplates Required by the map/core/UI.js API

()

Defined in src/components/map/UIs/default/default.js:63

highlightSelectedObject

(
  • object
  • getDatas
  • options
)

Defined in src/components/map/UIs/default/default.js:119

Required by the map.UI API

Parameters:

  • object Object

    Object that has been selected. See core.UI for more information

  • getDatas Object

    See explanation in core.UI

  • options Object

    Extra options. Like dropping a shadow etc.

showModal

(
  • modalElem
  • cssClasses
)

Defined in src/components/map/UIs/default/default.js:250

Parameters:

showSelections

(
  • objects
  • getDatas
  • options
)

Defined in src/components/map/UIs/default/default.js:77

Required by the map.UI API

Parameters:

  • objects Object

    Objects that have been selected. See core.UI for more information

  • getDatas Object

    See explanation in core.UI

  • options Object

    Extra options

showUnitMovement

(
  • to
)

Defined in src/components/map/UIs/default/default.js:157

Parameters:

  • to PIXI.Point

    Global coordinates that were clicked