Module flower.Scene

A scene class, handling display on one or more layers and receiving events from the EventMgr.

Object is controlled by SceneMgr; use that class to manipulate scenes.

Extends:

Info:

  • Release: V3.0.0
  • Author: Makoto

Functions

Scene:init (sceneName, params) The constructor.
Scene:createController (params) INTERNAL USE ONLY -- create the scene controller.
Scene:initListeners () INTERNAL USE ONLY -- initialize event listeners.
Scene:open (params) Open the scene.
Scene:close (params) Close the scene, removing it from the SceneMgr.
Scene:start (params) Start the scene.
Scene:stop (params) Stop the scene.
Scene:onTouch (e) Handle touch events sent by the EventMgr.
Scene:getRenderTable () Returns the rendering table.

Fields

TOUCH_EVENT Touch Event Cache


Functions

Scene:init (sceneName, params)
The constructor.

Parameters:

  • sceneName Module name
  • params Scene parameters
Scene:createController (params)
INTERNAL USE ONLY -- create the scene controller.

Parameters:

  • params
Scene:initListeners ()
INTERNAL USE ONLY -- initialize event listeners.
Scene:open (params)
Open the scene. Scenes add themselves to the SceneMgr when opened.

Parameters:

  • params Scene event parameters.(event.data)
Scene:close (params)
Close the scene, removing it from the SceneMgr.

Parameters:

  • params Scene event parameters.(event.data)
Scene:start (params)
Start the scene. Start event is issued.

Parameters:

  • params Scene event parameters.(event.data)
Scene:stop (params)
Stop the scene. Stop event is issued.

Parameters:

  • params Scene event parameters.(event.data)
Scene:onTouch (e)
Handle touch events sent by the EventMgr.

Parameters:

  • e Event
Scene:getRenderTable ()
Returns the rendering table. Used by RenderMgr.

Returns:

    rendering table

Fields

TOUCH_EVENT
Touch Event Cache
generated by LDoc 1.3