API Documentation for: 0.11.8
Show:

platypus.PlatypusPlugin Class

Module: platypus

This plugin instantiates a Platypus game using the configuration file. Configurations should be placed within the SpringRoll config with the following structure:

 {
                             "platypus": {
                                 "entities": {},
                                 "levels": {},
                                 "scenes": {},
                                 "spriteSheets": {}
                             },
                             "sounds": {} // Platypus uses the SpringRoll audio system and syntax for audio assets.
                         }
                        

The Platypus game instance is app.platypusGame on the SpringRoll Application and platypus.game within the platypus namespace.

Item Index

Properties

options.author

String

Defined in options.author:180

Sets credit for the game. Defaults to the "author" META tag if present on the document.

Default: ''

options.hideHello

Boolean

Hides console hello for the game.

Default: false