Rolled Abstract Scene Model.

Cannot be directedly modified. Used for storage.

Specialized Concrete scene for Messenger

• Note: MConcreteScene concretes the concrete general model with Event type and renderable type that is static regardless of what userdata, data, basedata or commondata is..

Specialized Abstract scene for Messenger Note: MAbstractScene concretes the abstract general model with Event type and renderable type that is static regardless of what userdata, data, basedata or commondata is..

Unroll a rolled abstract scene.

Abstract a concrete scene to an abstract scene.

Initialize it with env and msg.

Scene Output Msg is the message directly handled by the top-level core.

scenemsg is a custom type which represents the message type users wants to send to a scene when switching scenes.

• SOMChangeScene (Maybe scenemsg) name is used to change to a target scene by giving the initial message and name of the scene.
  • Note: initial message is defined in Scene.elm or Scenebase.elm, depending on whether you use sceneproto or not.
• SOMAlert makes an alert
• SOMPrompt name title makes a prompt with name and title. This means the system will eject a some textbox with the given title and name.
  • Note: The returning message from the user will be given as a worldevent.
• SOMPlayAudio channel name option is used to play an audio resource by giving channel name option
  • Note: See the docs in Audio.elm for more information on options.
• SOMStopAudio is used to stop a playing audio by giving the desired AudioTarget(see the docs on AudioTarget)
• SOMTransformAudio is used to transform a playing audio (e.g., adding some effects).
• SOMSetVolume is used to set the volume with a value from 0 to 1
• SOMSaveGlobalData saves the global by encode function given in UserConfig
  • Note: At the beginning of the game messenger will load the stored data into userdata (which is also the only chance to load it)
• SOMLoadGC is used to load a global component by giving the GC.
• SOMUnloadGC is used to unload a global component by giving the target.
• SOMCallGC is used to call a global component by giving the target and message.
• SOMChangeFPS is used to change the FPS by giving the time interval.
• SOMLoadResource is used to load a resource by giving the name and resource definition.
  • Note: The result of the loading will be in globaldata.internaldata. No user event will be triggered.

The type used to store the scene data. You should not handle this by yourself.

All scenes type

Messenger Msg

• Note: This is similar to MMsg, by using which messenger can know what is SOMMsg and make reaction to it accordingly.

Messenger MsgBase This message base make concrete MMsg type from abstract Msg type. By using MMsgBase, messenger can know what is SOMMsg and make reaction to it accordingly. Users should use Msg at most of the time.

Specialized Concrete Model for Messenger

Specialized Abstract Model for Messenger

Change the update function to remap the result and return the changed abstract scene.

Global component common data.

Global component base data.

Global component message type.

Global component target type.

Abstract GlobalComponent Model.

Cannot be directly modified. Used for storage.

Concrete GlobalComponent Model

init type sugar

update type sugar. In a layered scene, the job is done by Messenger, so you don't have to write this. However, in a raw scene, the logic is up to you to decide, so you are supposed to imply this.

updaterec type sugar

view type sugar

GlobalComponent Storage