Home

Engine and Schema v1.0 (alpha)

This page documents the types of prerequisites and consequences the engine supports. See pncgame.xsd for schema details. Note that locations and events cannot be given an Id value less than 1 because location 0 always represents the player's inventory. (This is hard-coded in pncevent.js --> PointAndClickEvent.fromXML.)

Prerequisites

1. item - The item given by "itemid" must be in the location given by the node's value.
2. noitem - The item given by "itemid" must not be in the location given by the node's value.

Consequences

1. audio - Set the file referenced by the node's value as the value of the "src" attribute for the "source" element referenced by PointAndClickGame.audio_source_fx, and play the audio. Note that PointAndClickGame includes the audio_source_soundtrack attribute, but the schema does not yet accommodate soundtrack music. You are free to include an "audio" element in the containing HTML page that plays music, but the engine will not manipulate it unless you give it an extension function.
2. custom - The creates a default consequence function that throws an exception. The game designer must manually replace this function with a custom function. See testgame/test.html for an example. At the moment, use custom functions to affect different consequences for different values of a game's active_item property.
3. item - Move the item specified by the "itemid" attribute to the location given by the node's value.
4. location - Set the value of the game's "player_location" attribute to the node's value.
5. message - Add the node's value to the message buffer.