new SpriteSetter()
MEMBERS
-
inheritedTypes :object
-
Dictionary object listing all of the types this object is compatible with.
- Inherited From:
-
type :string
-
Type identifier.
- Inherited From:
-
Members below are inherited from the parent class.
-
autoplay :boolean
-
Boolean determining if the PlaybackController automatically starts playing when included in a newly instantiated Construct.
- Inherited From:
- Default Value:
- true
-
readonly duration :number
-
The read-only length of this PlaybackController in seconds. To change the duration, adjust the 'startTime' or 'endTime' properties.
- Inherited From:
-
lazyStop :boolean
-
Boolean flag determining if the PlaybackController will hault the next time the time reachs the endTime (or startTime if playback is a negative value). If this flag is false, the PlaybackController loops and continues playing indefinitely.
- Inherited From:
- Default Value:
- false
-
readonly netPlaybackRate :number
-
Read-only value denoting the net playbackRate, including the effects of this PlaybackController's SpeedControls.
- Inherited From:
-
pauseImmunity :PauseEvent|Array.<PauseEvent>
-
The PauseEvent or Array of PauseEvents that this PlaybackController will be immune to. Set this parameter to [] for this PlaybackController to have no pause immunity.
- Inherited From:
- Default Value:
- nc.defaultPauseImmunity
-
playbackRate :number
-
Value multiplying the progression of the 'time' value. To play twice as fast use 2, for items that can play backwards, use negative values.
- Inherited From:
- Default Value:
- 1
-
readonly playbackState :string
-
Read-only string denoting the current playback state: 'stopped', 'paused', or 'playing'. State values are available in 'nc.constants.playbackStates'.
- Inherited From:
- Default Value:
- nc.constants.playbackStates.stopped
-
speedControl :SpeedControl|Array.<SpeedControl>
-
The SpeedControl or Array of SpeedControls that this PlaybackController is affected by.
- Inherited From:
- Default Value:
- nc.defaultSpeedControl
METHODS
-
getAssociatedGraphicAssets() returns {Array.<GraphicAsset>}
-
Returns a copy of the array of GraphicAssets that are iterated through during playback.
Returns:
Array.<GraphicAsset> -
setAssociatedGraphicAssets(graphicAsset)
-
Manually populates the array of GraphicAssets that will be iterated through during playback.
Parameters:
Name Type Attributes Default Description graphicAssetArray.<GraphicAsset> | GraphicAsset GraphicAsset or Array of Graphic Assets that will be iterated through during playback.
-
setKeyGraphicAsset(graphicAsset)
-
Sets the key GraphicAsset. This GraphicAsset's name should end in a number. All GraphicAssets whose name matches the key GraphicAsset's name with a different trailing number will be used to set the SpriteSetter's associated GraphicAssets list. For example, if the key GraphicAsset is named "MyAnimation001", all GraphicAssets with the name "MyAnimation" followed by any sequence of the digits 0-9 will be gathered into this SpriteSetter's associated GraphicAssets.
Parameters:
Name Type Attributes Default Description graphicAssetGraphicAsset The GraphicAssets used for automatical detection all all numerically similar GraphicAssets.
-
Methods below are inherited from the parent class.
-
addLazyStopCallback(callbackOwner, callbackName, callbackArgs (opt))
-
Adds a callback that occurs upon the next 'lazyStop', which occurs any time the time reaches the startTime or endTime while the 'lazyStop' flag is true. It should be noted that all lazyStop callbacks are consumed upon encountering a lazyStop, and would need to be-added to be triggered upon subsequent lazyStops.
Parameters:
Name Type Attributes Default Description callbackOwnerobject The object owning the optional callback function that is triggered when a lazy stop occurs.
callbackNamestring The name of the optional callback function that is triggered when a lazy stop occurs.
callbackArgsArray | any <optional>
Parameters for the optional callback function that is triggered when a lazy stop occurs.
- Inherited From:
-
addStateChangeCallback(callbackOwner, callbackName, callbackArgs (opt))
-
Adds a callback that occurs if/when any component of this PlaybackController has changed. This can be used to manage processes that run entirely outside of the Incisor® system by providing a callback to update said processes upon any change. A string denoting the triggering change will be passed in as the callback function's first parameter, and user-defined parameters will follow.
Parameters:
Name Type Attributes Default Description callbackOwnerobject The object owning the optional callback function that is triggered when any component of this PlaybackController has changed.
callbackNamestring The name of the optional callback function that is triggered when any component of this PlaybackController has changed.
callbackArgsArray | any <optional>
Parameters for the optional callback function that is triggered when any component of this PlaybackController has changed.
- Inherited From:
-
addTimeUpdateCallback(callbackOwner, callbackName, callbackArgs (opt))
-
Adds a callback that occurs any time the 'time' property is updated, which happens while this PlaybackController is playing, but also when time is set directly. The time value will be sent to this callback as its first parameter, with any user-defined args following.
Parameters:
Name Type Attributes Default Description callbackOwnerobject The object owning the callback function that is triggered when time is updated.
callbackNamestring The name of the callback function that is triggered when time is updated.
callbackArgsArray | any <optional>
Args for the callback function that is triggered when time is updated.
- Inherited From:
-
dispose()
-
Removes internal Incisor® references to this PlaybackController in order to aid memory management.
- Inherited From:
-
pause()
-
Changes the playbackState to "paused", and pauses the progression of the 'time' value.
- Inherited From:
-
play()
-
Changes the playbackState to "playing", and begins the progression of the 'time' value. While playing, the PlaybackController automatically updates the 'time' value once every fixedUpdate.
- Inherited From:
-
playOnce(lazyStopCallbackOwner (opt), lazyStopCallbackName (opt), lazyStopCallbackArgs (opt))
-
Starts playing with 'time=startTime' (or if playbackRate is negative, 'time=endTime') and sets the 'lazyStop' value to true. An optional callback function can be provided for when playbackController stops - this callback is consumed upon stopping.
Parameters:
Name Type Attributes Default Description lazyStopCallbackOwnerobject <optional>
The object owning the optional callback function that is triggered when a lazy stop occurs.
lazyStopCallbackNamestring <optional>
The name of the optional callback function that is triggered when a lazy stop occurs.
lazyStopCallbackArgsArray | any <optional>
Parameters for the optional callback function that is triggered when a lazy stop occurs.
- Inherited From:
-
removeLazyStopCallback(callbackOwner, callbackName)
-
Removes the given lazyStop callback.
Parameters:
Name Type Attributes Default Description callbackOwnerobject The object owning the callback to be removed.
callbackNamestring The name of the callback to be removed.
- Inherited From:
-
removeStateChangeCallback(callbackOwner, callbackName)
-
Removes the given stateChange callback.
Parameters:
Name Type Attributes Default Description callbackOwnerobject The object owning the callback to be removed.
callbackNamestring The name of the callback to be removed.
- Inherited From:
-
removeTimeUpdateCallback(callbackOwner, callbackName)
-
Removes the given timeUpdate callback.
Parameters:
Name Type Attributes Default Description callbackOwnerobject The object owning the callback to be removed.
callbackNamestring The name of the callback to be removed.
- Inherited From:
-
stop()
-
Changes the playbackState to "stopped" and sets the 'time' value to 'startTime'.
- Inherited From: