Login Register

Documentation

Maze

Description

The Maze addon allows you to define questions and answers for a user to complete a maze.

Properties

The list starts with the common properties, learn more about them by visiting the Modules description section. The other available properties are described below.

Property name Description
Width The number of cells in one row.
Height The number of cells in one column.
Number of mazes The number of mazes to win the game. By default 1.
Game mode The Addon gives two modes: letters, where to win a user must gather all letters in a maze and diamond where the user must open all gates for entering the end game element.
Questions The list of questions and answers for all mazes.
Property name Description
Question The text shown to a user when he or she enters a letter or a gate.
Answer The answer which a user must enter in order to collect a letter or open the door. The answer value is case sensitive.
Letter The letter which a user will receive when entering a correct answer. The property is used only in the Letter mode. At the end of a maze level, the addon will show all letters in the order defined in the property.
Maze numer The number of a maze where a question is added. The number is counted from 1.
Is disabled Allows disabling the module so that the user is not able to interact with it.
Hide controls bar Hide the controls bar visible in the right side of the addon.

Supported commands

Command name Params Description
show --- Shows the addon.
hide --- Hides the addon.
disable --- Disable player navigation.
enable --- Enable player navigation.
moveUp Move the player's position up.
moveDown --- Move the player's position down.
moveLeft --- Move the player's position left.
moveRight --- Move the player's position right.

Events

The Maze addon sends ValueChanged type events to Event Bus when a player has opened the door.

Field name Description
Item opened
Value A number of the door as a string.
Score N/A

The Maze addon sends ValueChanged type events to Event Bus when a player has collected a letter.

Field name Description
Item gathered
Value A letter which was collected.
Score N/A

The Maze addon sends ValueChanged type events to Event Bus when a player has finished one maze.

Field name Description
Item Maze number
Value 1
Score 1

The Maze addon sends ValueChanged type events to Event Bus when a player has finished all mazes.

Field name Description
Item all
Value 1
Score 1

CSS addon classes

Class name Description
Maze-wrapper-menu/td> DIV which is surrounding the menu at the left side of the addon. If the hide navigation bar is enabled, the width of this wrapper is zero.
Maze-wrapper-game-container DIV which is surrounding the game elements at the right side of the addon. If the hide navigation bar is enabled, the width of this wrapper is 100%.
Maze-wrapper-menu-controls Div which is surrounding the navigation buttons.
Maze-wrapper-menu-controls-up The Up button.
Maze-wrapper-menu-controls-down The Down button.
Maze-wrapper-menu-controls-left The Left button.
Maze-wrapper-menu-controls-right The Right button.
Maze_room_image_top_left_right_bottom DIV which contains as background the closed top, left, right and bottom walls image. This element may be rotated by the addon.
Maze_room_image_top_left_right DIV which contains as background the closed top, left, right walls image. This element may be rotated by the addon.
Maze_room_image_top_left DIV which contains as background the closed top, left walls image. This element may be rotated by the addon.
Maze_room_image_top_bottom DIV which contains as background the closed top and bottom walls image. This element may be rotated by the addon.
Maze_room_image_top DIV which contains as background the closed top wall image. This element may be rotated by the addon.
Maze_player_element DIV which contains as background the player image.
Maze_treasure_element DIV which contains as background the end level image in the diamond game type.
Maze_door DIV which contains the closed door as a background image.
Maze_door_opened DIV which contains the opened door as a background image.
Maze_room_left_top_dot Sometimes a maze needs to complete an empty dot in the connection between walls. This element contains this dot in the left top corner as a background image.
Maze_game_question_background A background element while showing a question.
Maze_game_question_container A DIV element which is surrounding questions' elements.
Maze_game_question_container_question_input An input for the player's answer.
Maze_game_question_container_question_apply_text A DIV element which contains the text for entering an answer. Text is set as ::after class.
Maze_letters_end_level_next_maze_button A button which is shown on the end level in the Letters game mode when going to the next level.
Maze_game_end A background element when a player completes all mazes.
Maze_letters_end_level_answer_wrapper DIV which is surrounding the elements in the end level in the Letters game mode.
Maze_game_end_text DIV which contains the end game text. The text is set as ::after class.
Maze_letters_end_level DIV which a user must enter to the end level in the Letters game mode.
Maze_letters_end_level_background DIV which is a background element in the end level in the Letters game mode.
Maze_letters_letter_element DIV element which contains a letter answer in the end level in the Letters game mode.
Maze_letters_end_level_answer_letters_container DIV which is surrounding the answer letters.
Maze_letters_room_letter DIV which contains a letter.
Maze_game_question_container_question_apply DIV which contains the OK button text while entering an answer by a player. The text is set as ::after class.

Demo presentation

Demo presentation contains examples of how this addon can be used.