The id of an action is used to reference it, usually in order to enact the action or give the players the option of enacting the action via a dialog. In some cases, the action id is used to determine whether the action has been completed successfully for the purposes of making another action available.
The conditional tag is used to prevent an action from being made available until other actions have been successfully completed. Any action id listed inside a conditional tag will be checked for completion before the action will be displayed as an option in a dialog. An example of this usage would be making a door locked and only openable with a key that can be gained through successfully completing another action.
The title of the action contains the text that will be used as the dialog button title for the action when it is displayed as a dialog option.
Current options for the action type are "place-tile", "simple", "roll", "puzzle-combination", and "place-monster", each having a somewhat different set of associated tags.
"place-tile" : The only additional tag required is
<tileid> which should contain the id of the tile being placed.
"simple" : The
<text> tag is required, which contains the text that will be displayed if the player chooses to enact the action from the dialog in which the action is included as an option.
"roll" : A roll action is an action that presents the players with a skill test and the possibility of success or failure. The skill being tested is contained in the
<skill> tag, while the number required to pass the test is included in the
<success-value> tag. The
<result-failure> contain text that is displayed based on whether the roll was successful or not.
"puzzle-combination" : The use of this action type displays a puzzle dialog for a combination puzzle that involves guessing a set of numbers. The application chooses a random number from within the parameters given by
<numberofvalues> with the text within
<result-success> being displayed when the puzzle is successfully solved. The skill to test is specified with the
"puzzle-picture" : The use of this action type displays a puzzle dialog for a picture puzzle that involves reorganizing a number of segments of a picture. The picture used in the puzzle can be included in the scenario zip file and referenced with the
<imageid> which contains the filename (without extension) of the image file to be used.
<monster-title> specifies the name of the Monster to place, while
<imageid> should link to the image to be used for the monster. In this case, monster title is used and it should be noted that the title is not simply a descriptive name, it needs to be a unique identifier due to the possibility of two different monsters using the same id (and thus the same image).
<tile> specifies which tile the monster should be placed on while
<y> give the coordinates on the tile to place the monster in the same way token coordinates are specified within the
"place-token" : Allows placement of tokens via action.
<token> specifies the id of the token to place, other details of where to place the token are controlled by the token tag itself.
Used only for action tags of type "place-monster", this is an action id of an action that is to be executed when a particular monster is defeated.
Any number of action tags (containing an action id) may be added to actions of type "simple" to list those actions as options when the action dialog is displayed. This allows the construction of a basic text dialog that gives the players a range of options on how to proceed.
Any number of action-success tags (containing an action id) may be added to actions of type "roll", "puzzle-combination", or "puzzle-picture". These actions will be executed when the roll or puzzle are successfully completed.
Any number of action-failure tags (containing an action id) may be added to actions of type "roll". These actions will be executed when the roll fails.