impression logo

Impression Learning Content Framework

Support Article
Last modified: 26 Jan 2015

Player Completion

This article identifies the completion criteria recognized by the player classes in the impression.players namespace or commonly added by the Impression Content Creation Tool.

CompleteWhen SubtringPlayersCriteria Evaluated ByCompletion Criteria
always; [all players] n/a No specific criteria defined. All players strip this substring from the CompleteWhen persisted property the first time that the player checks storyboard completion.
childrenComplete; [all players] Shell All descendants of the storyboard in the lesson map have their Complete persisted property set to true.  It is the responsibility of the shell to determine which storyboards are descendants of the current storyboard.
narrationComplete; [all players] Player The storyboard's NarrationComplete persisted property has been set to true.  Note that the shell is responsible for setting this value, either directly or indirectly via the narrationComplete player property.
storyboardCommandsComplete; [all players] Player All ChildElement objects in the storyboard's Commands property collection have their Complete persisted property set to true.
commandObjectsComplete; [sequencers] Player All ChildElement objects in the storyboard's children collection have their Complete persisted property set to true.
allStepsShown; SWFVideoPlayer Player All steps have been displayed.
popupsShown; CanvasPlayer Player All CanvasElements with an ActionType property value of CanvasElementActionTypes.POPUP_TEXT or CanvasElementActionTypes.POPUP_GRAPHIC have their Complete persisted property set to true.
commandsComplete; CanvasPlayer Player All CanvasElements with an ActionType property value of CanvasElementActionTypes.PLAY_SOUND, CanvasElementActionTypes.HYPERLINK, or CanvasElementActionTypes.COMMAND have their Complete persisted property set to true.
destinationsComplete; CanvasPlayer, MenuPlayer Shell For a Canvas storyboard, all CanvasElements with an ActionType property value of CanvasElementActionTypes.JUMP or CanvasElementActionTypes.DISPLAY_RANGE have their Complete persisted property set to true. For a Menu storyboard, all ChildElement objects in the storyboard's children collection have a DestinationStatus persisted property value of LocationStatusTypes.COMPLETE.  Note that the shell is responsible for determining the status of the destination.
answerCorrect;* [question players] Player The storyboard's Correct persisted property value is set to true. 
answerEvaluated;* [question players] Player For a Multiple-Choice storyboard, the value of the storyboard's EvaluatedIndex persisted property is > 0. For a Matching storyboard, all (valid, non-distractor) questions have an evaluated response.
objectDefined;** FlashObjectPlayer, [others] Shell, Flash Object Completion critieria is defined by either the shell or the Flash object loaded into the player.  The FlashObjectPlayer does not remove this property.
simulationStateReady; SimulationPlayer Player (rules engine) The value of the rules engine's simulationStateReady property is set to true.
additionalActionsComplete; SimulationPlayer Shell The value of the storyboard's AdditionalActionsComplete persisted property value is true.  Note that the shell is responsible for setting this value, either directly or indirectly via the additionalActionsComplete player property.

* The answerCorrect; and answerEvaluated; substrings may be added by the CCT to a Command storyboard or one of the sequencer storyboards if question integration has been specified in the project properties.  In these cases, it is up to the shell to determine when these substrings can be removed and to remove them.

** The objectDefined; substring is supported by the CCT for the Flash Object and Command storyboard types.  For the Command storyboard type, it is the responsibility of the shell (or the custom player implementing the command) to determine when these substrings can be removed and to remove them.