Messenger.Scene.LayeredScene

Layered Scene

Layered scene is a pre-defined scene implementation provided by Messenger. A layered scene can only handle a list of layers with fixed cdata, userdata, tar, msg and scenemsg types.

type alias LayeredSceneData cdata userdata tar msg scenemsg =

{ renderSettings : List Setting

, commonData : cdata

, layers : List (AbstractLayer cdata userdata tar msg scenemsg)

}

Layered Scene Data.

- `renderSettings` is used in `group` while viewing the layers as a whole
- `commonData` is the common data for the whole scene
- `layers` are the layers of the scene with type `AbstractLayer`

genLayeredScene :

LayeredSceneInit cdata userdata tar msg scenemsg

-> LayeredSceneSettingsFunc cdata userdata tar msg scenemsg

-> SceneStorage userdata scenemsg

This creates a layered scene.

init creates the initial layered scene from env data and init msg.
settingsFunc is a user provided function to modify renderSettings each time the scene updates. If you don't need settingsFunc, simply provide a func _ _ _ = settings

type alias LayeredSceneInit cdata userdata tar msg scenemsg =

Env () userdata

-> Maybe scenemsg

-> LayeredSceneData cdata userdata tar msg scenemsg

init type sugar

type alias LayeredSceneSettingsFunc cdata userdata tar msg scenemsg =

Env () userdata

-> UserEvent

-> LayeredSceneData cdata userdata tar msg scenemsg

-> List Setting

settingsFunc type sugar

Scene Prototype

type alias LayeredSceneProtoInit cdata userdata tar msg scenemsg idata =

Env () userdata

-> Maybe idata

-> LayeredSceneData cdata userdata tar msg scenemsg

init type sugar for scene prototypes

type alias LayeredSceneLevelInit userdata scenemsg idata =

Env () userdata -> Maybe scenemsg -> Maybe idata

init type sugar for levels

initCompose :

LayeredSceneProtoInit cdata userdata tar msg scenemsg idata

-> LayeredSceneLevelInit userdata scenemsg idata

-> Env () userdata

-> Maybe scenemsg

-> LayeredSceneData cdata userdata tar msg scenemsg

Compose LayeredSceneProtoInit with LayeredSceneLevelInit.

linsyking/messenger-core/14.0.1

Messenger.Scene.LayeredScene

Layered Scene

Scene Prototype

Modules

Base

UI

Lib