Documentation
Limited Check
Description
Limited Check is a module that allows users to add a button clicking on which will show whether the answers given in the specified modules are correct or wrong.
Limited Check module is based on Check module. In addition to its base module, Limited Check has additional rules and functions:
- when the Check module is selected, all Limited Check modules are selected as well but they are also disabled in error checking mode
- selecting one Limited Check module will not select the Check module or any other Limited Check module
- when the Show Answers module is selected and a user selects the Limited Check module, the Show Answers mode will be disabled and deselected
- selecting one Limited Check Answer module will deactivate show answer mode on dependent modules covered by Limited Check Answers and Check Answers modules
- selecting one Limited Show module will deactivate error checking mode on dependent modules covered by Limited Check Answer module
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 |
---|---|
Check text | Text displayed on the button. |
Uncheck text | Text displayed on the button when it's selected. |
Works with | List of modules connected to Limited Check module. Each line should consist of separate modules ID. |
Count mistakes from provided modules | With this option checked, mistakes will be counted from modules connected with Limited Check module. |
Supported commands
Command name | Params | Description |
---|---|---|
hide | --- | Hides the module. |
show | --- | Shows the module. |
getModulesScore | --- | Returns JavaScript object with score information (score, errors and maxScore) that is the sum of all score info for individual connected module. |
getWorksWithModulesList | --- | Gets list of modules configuerd in "Works With" property. |
Advanced Connector integration
Each command supported by the Limited Check module can be used in the Advanced Connector's scripts. The below example shows how it interacts with the Single Stare Button and Text modules.
EVENTSTART
Name:ValueChanged
Source:SingleStateButton1
SCRIPTSTART
var limitedCheck= presenter.playerController.getModule('LimitedCheck1');
var textModule= presenter.playerController.getModule('Text1');
var scoreInfo = limitedCheck.getModulesScore();
textModule.setText('Total score: ' + scoreInfo.score);
SCRIPTEND
EVENTEND
Events
Limited Check sends events compatible with Advanced Connector.
It sends the LimitedCheck event when a user selects the button.
Field name | Description |
---|---|
Name | LimitedCheck |
Score | Total score of connected modules. |
Errors | Total number of errors for connected modules. |
MaxScore | A sum of maximum score for connected modules. |
It sends the LimitedCheck event when a user unselects the button.
Field name | Description |
---|---|
Name | LimitedCheck |
Value | "unchecked" |
It sends the LimitedHideAnswers event when a user select the button and show answer mode is enabled.
Field name | Description |
---|---|
Name | LimitedHideAnswers |
Module1 | Module ID of first supported module |
Module2 | Module ID of second supported module |
Module[N] | Module ID of nth supported module |
CSS Classes
Class name | Description |
---|---|
.ic_button_limited_check | indicates the look of the Limited Check button. |
.ic_button_limited_check-up-hovering | indicates the look of the Limited Check button while putting a mouse cursor on it. |
.ic_button_limited_check-down-hovering | indicates the look of the Limited Check button while clicking on it. |
.ic_button_limited_uncheck | indicates the look of the Limited Check button when its pressed. |
.ic_button_limited_uncheck.disabled | indicates the look of the Limited Check button when its pressed and disabled (because the Check Answers button was pressed). |
.ic_button_limited_uncheck-up-hovering | indicates the look of the Limited Check button when its pressed while putting a mouse cursor on it. |
.ic_button_limited_uncheck-down-hovering | indicates the look of the Limited Check button when its pressed while clicking on it. |
Default Styling
.ic_button_limited_check { background-image: url('images/check.png'); background-repeat: no-repeat; background-position: center; cursor: pointer; } .ic_button_limited_uncheck { background-image: url('images/uncheck.png'); background-repeat: no-repeat; background-position: center; cursor: pointer; }
Demo presentation
Demo presentation contains examples of how to use this module.