Indicates whether additional, non-simulation state actions have been completed.

If the storyboard property value is null, false is returned. This method sets or returns the value of the current storyboard's additionalActionsComplete persisted property.

Specifies how the object should handle storyboard completion.

If this property value is true, the value of the CompleteRemaining persisted property is set to the value of the CompleteWhen persisted property each time the storyboard is loaded. In addition, any interim completion flags are removed. This causes the checkForComplete() method to perform normal processing of the storyboard's completion criteria. When all criteria have been met, the method will then dispatch the complete event, regardless of the value of the complete persisted property.

If this property value is false, the value of the CompleteRemaining persisted property is set only on initialization and the complete event will be dispatched only if the Complete persisted property value was previously false.

Regardless of the value of this property, the complete event will only be dispatched once while the storyboard is loaded by the player.

Note that the SimulationPlayer default value for this property is true.

The default value is true.

See also

Indicates whether the current storyboard is loading.

The number of times that a remediation event has occurred for the current storyboard.

If the storyboard property value is null, -1 is returned. Note that this number can be changed by the shell when the player dispatches a RemediationRequestEvent.REMEDIATION_REQUEST event. This method sets or returns the value of the current storyboard's RemediationCount persisted property.

See also

The AssetResolver to use to request external assets.

The resolver is not used directly by the SimulationPlayer, rather, it is passed to the snapshotLoader as needed.

See also

The simulation rules engine.

The simulation sequencer.

The simulation process.

The simulation user interface.

The simulation snapshot loader.

Specifies the storyboard for the player.

If null is passed, the current storyboard is unloaded, the StoryboardEvent.UNLOAD event is dispatched, and no further action occurs.

If a non-null storyboard object is passed, the following actions occur, in order:

1. If the previously loaded storyboard is not null, the StoryboardEvent.UNLOAD event is dispatched. If the event is not cancelled, the current storyboard is unloaded. If the event is cancelled, further processing stops.
2. The StoryboardEvent.LOAD_START event is dispatched. If the event is not cancelled, the new storyboard is associated with the player. If the event is cancelled, further processing stops and the value of this property is set to null.
3. If the value of the new storyboard's Initialized persisted property is false, the storyboard is initialized and the StoryboardEvent.INITIALIZE event is dispatched.
4. The loadStoryboard() protected method is invoked.

See also

Creates a new instance of the SimulationPlayer.

Causes the player to examine the completion criteria for the current storyboard.

If the current storyboard is null, invoking this method has no effect. If the current storyboard is still loading (the loading property value is true, invoking this method has no effect.

The method begins by removing known satisfied completion criteria from the completeRemaining persisted property. Once known satisified criteria are removed, ff the persisted property is not empty (""), the CheckForCompleteEvent.CHECK_FOR_COMPLETE event is dispatched, and the property takes the event's completeRemaining property value.

If the completeRemaining property value is empty after the event returns, and the Complete persisted property value is to false or the alwaysCheckComplete property value is true, the Complete persisted property value is set to true and the StoryboardEvent.COMPLETE event is dispatched.

If the alwaysCheckComplete property value is false, and the Complete persisted property value is true, no additional processing will occur after the CheckForCompleteEvent.CHECK_FOR_COMPLETE event is dispatched, and the complete event will not occur.

See also

Creates a string describing the state of the storyboard.

This method returns a single character to describe the state of the storyboard. If the storyboard is marked complete, "c" is returned. If the storyboard has been initialized, but is not marked complete, "i" is returned. Otherwise "." is returned.

Note that this string only describes the state that the player is aware of. If the shell stores additional data in the storyboard, it is the shell's responsibility to store the additional data if it is needed.

Parameters

Loads the storyboard.

This method is invoked by the storyboard property set method when a non-null storyboard object is loaded after initialization (if needed) occurs.

When loading a storyboard, the RenderingPlayer performs the following actions:

• If the alwaysCheckComplete property value is true, the additionalActionsComplete storyboard persisted property value is removed.
• The superclass method is invoked.
• The loading property value is set to true.
• If the snapshotLoader property value is not null, and the Snapshot storyboard persisted property value exists and has a non-empty filename, the following actions occur, in order:
  • If the resolver property value is not null, the resolver's beginOwnerTransaction() method is invoked.
  • The snapshot loader's loadSnapshot() method is invoked.
  • The resolver's endOwnerTransaction() method is invoked (if the resolver is not null.
  The impression.events.StoryboardEvent.CONTENT_LOAD_BEGIN and impression.events.StoryboardEvent.CONTENT_LOAD_END events will be dispatched by the player when the snapshot loader begins and finishes loading content. Further processing will not occur until the snapshot loader dispatches a SimulationObjectEvent.INITIALIZATION_COMPLETE event.
• If the sequencer property value is not null, and the InitialSequence storyboard persisted property value exists and is not the empty string (""), the sequencer's sequence() method is invoked. Further processing will not occur until the sequencer dispatches a SimulationObjectEvent.INITIALIZATION_COMPLETE event.
• If the rulesEngine property value is not null, and the Rules storyboard persisted property value exists and is not the empty string (""), the rules engine's initialize() method is invoked. Further processing will not occur until the rules engine dispatches a SimulationObjectEvent.INITIALIZATION_COMPLETE event.
• The loading property value is set to false, and the StoryboardEvent.LOAD_COMPLETE event is dispatched.
• The checkForComplete() method is invoked. If all completion criteria have been met, the complete event is dispatched.

See also

Removes known completion criteria from the CompleteRemaining storyboard persisted property.

This method is invoked by the checkForComplete() method if the value of the storyboard property is not null, and the complete event has not been dispatched since the storyboard was loaded.

In addition to the substrings processed by the BasePlayer, the SimulationPlayer will remove the following substrings from the completeRemaining persisted property:

See also

Processes a request for a change to the simulation data.

This method is automatically invoked by the SimulationPlayer when the ISimulationUI object referenced by the simulationUI property value dispatches a SimulationDataChangeRequestEvent.DATA_CHANGE_REQUEST event.

If the simulation property value is null, invoking this method has no effect and returns false. If the rulesEngine property value is null, and the simulation object's ownerSetsData property value is true, invoking this method has no effect and returns true. If the rulesEngine property value is null, and the simulation object's ownerSetsData property value is false, this method passes the changeData parameter to the simulation object's setData method and returns true.

If the rulesEngine property value is not null, the simulation property value and the changeData parameter value are passed to the rules engine's evaluateChangeRequest() method. If the method returns true, and the simulation object's ownerSetsData property value is false, the simulation object's setData method is invoked with the changeData parameter. Regardless of the value of the ownerSetsData property value, the player will dispatch a SimulationDataChangeEvent.DATA_CHANGE_APPROVED event if the change is approved by the rules engine. The method will return the result of the call to the rules engine's evaluateChangeRequest() method.

Parameters

See also

Removes all properties set by the player.

Note that this method also removes interim completion properties used by the player, but not necessarily set by the player.

Parameters

See also

Modifies the storyboard to match the described state passed.

If the value of state is "c" (indicating a completed storyboard), interim completion criteria will be marked as complete in addition to the overall storyboard state.

State values created using a function other than getStoryboardState may not work.

Parameters

Performs cleanup actions when a storyboard is unloaded.

This method is invoked by the storyboard property set method when the current value of the property is not null and the unload event has not been cancelled.

When unloading a storyboard, the CanvasPlayer performs the following actions:

• The superclass method is invoked.
• The loading property value is set to false.
• The cancel() method is invoked on the snapshotLoader property (if it is not null).
• The cancel() method is invoked on the sequencer property (if it is not null).
• The cancel() method is invoked on the rulesEngine property (if it is not null).
• The resolver's cancelOwnerTransaction() method is invoked.
• Any content currently loading is closed by invoking the resolver's closeAllOf() method.

See also

Dispatched when the snapshot loader begins to load external assets.

This event is dispatched when the resolverInfo object whose owner property value is the player dispatches its beginTransaction event.

Dispatched when all external assets have finished loading.

This event is dispatched when the resolverInfo object whose owner property value is the player dispatches its endTransaction event.

Dispatched when the rules engine approves a data change request.

This event is dispatched when the requestDataChange() method is invoked either explicitly or implicitly as the result of the simulationUI property object dispatching a SimulationDataChangeRequestEvent.DATA_CHANGE_REQUEST event. The event is dispatched if the call to the rules engine's evaluateChangeRequest() method returns true.

Dispatched when the rules engine determines that remediation should occur.

This event is dispatched by the player when the rules engine dispatches a RulesEngineRemediationRequest.REQUEST_REMEDIATION event. Before dispatching the event, the SimulationPlayer will set the value of the remediationCount property of the event object to one more than the value of the current storyboard's remediationCount persisted property. When the event returns, the value of the event's remediationCount property will be stored as the current storyboard's remediationCount persisted property.

Dispatched when an simulation-related object dispatches an error event.

This event is dispatched when the simulation, simulation user interface, snapshot loader, sequencer, or rules engine dispatches a SimulationObjectErrorEvent.ERROR event.

This event is dispatched when the requestDataChange() method is invoked either explicitly or implicitly as the result of the simulationUI property object dispatching a SimulationDataChangeRequestEvent.DATA_CHANGE_REQUEST event. The event is dispatched if the call to the rules engine's evaluateChangeRequest() method returns true.