Materia Engine Core
To load content and save scores from a widget’s player component, you’ll need to load the Materia Engine Core (materia.enginecore.js). The Engine Core abstracts communicating with Materia into a simple API.
Materia.Engine.start
Signals that your widget is done loading its assets and passes a callback that will received widget instance data.
Below is a table of the supported keys for start’s argument object.
| Object Property | Required | Description |
|---|---|---|
| start | yes | A function that is called after the instance and qset data has loaded |
| manualResize | no | set to false automatically adjust the height of the widget based on window.getComputedStyle |
Example
Materia.Engine.start({
start: (instance, qset, version) => {},
manualResize: false
})
Materia.Engine.addLog
Queues a log to send to the server. Logs must conform to certain value constraints.
| Arguments | Required | Description |
|---|---|---|
| type | yes | Log type |
| itemId | no | an item id that pertains to the log |
| text | no | @TODO |
| value | no | @TODO |
Materia.Engine.alert
Ask Materia to display a stylized Alert message.
| Arguments | Required | Description |
|---|---|---|
| title | yes | Title of the alert window to be displayed |
| message | yes | Message to display in the alert |
| type | no | @TODO |
Example
Materia.Engine.alert('Alert Title', 'Alert Message')
Materia.Engine.getMediaUrl
Convert a Materia asset id into a url.
| Arguments | Required | Description |
|---|---|---|
| mediaId | yes | Id of the media file to convert |
Materia.Engine.getImageAssetUrl
This function will be depreciated in the future, use Materia.Engine.getMediaUrl
Materia.Engine.end
Mark the widget play as finished. No more logs will be accepted after end is called. By default, calling end will jump to the score screen.
| Arguments | Required | Description |
|---|---|---|
| showScoreScreenAfter | no | Set to false to prevent Materia from jumping to the score screen. Defaults to true. |
Materia.Engine.sendPendingLogs
Request that the engine core immediately sends any pending logs to the server. Automatically called by end.
Accepts no arguments.
Materia.Engine.sendStorage
Do not use directly, See materia.scoremanager.js
Materia.Engine.disableResizeInterval
Disables automatic resizing of the widget iframe. See Materia.Engine.start
Example
Materia.Engine.disableResizeInterval()
Materia.Engine.setHeight
Manually set the pixel height of the widget.
Example
Materia.Engine.setHeight(200)
Materia.Engine.escapeScriptTags
Utility function for removing html tags tags from a string
Example
// returns `<this should be fine>`
Materia.Engine.escapeScriptTags('<this should be fine>')