What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Deprecation Schedule

WaitThen(name)

A WaitThen is an object that provides a means to schedule a delayed callback. This differs from standard javascript 'setTimeout' in that it is compatable with Incisor®'s pausing system, as well its SpeedControls, and 'nc.softwareSpeed'. WaitThen instances can be constructed normally using 'new', or you can just call 'nc.waitThen' which makes use of an internally pooled group of WaitThens. It is recommended that 'nc.waitThen' be used where possible to avoid needlessly instantiating new objects, and also avoid the potential for memory leaks. [REQUIREMENT: optional code module - 'waitThens']

new WaitThen(name)
IncisorAPI.js, line 8838

A WaitThen is an object that provides a means to schedule a delayed callback. This differs from standard javascript 'setTimeout' in that it is compatable with Incisor®'s pausing system, as well its SpeedControls, and 'nc.softwareSpeed'. WaitThen instances can be constructed normally using 'new', or you can just call 'nc.waitThen' which makes use of an internally pooled group of WaitThens. It is recommended that 'nc.waitThen' be used where possible to avoid needlessly instantiating new objects, and also avoid the potential for memory leaks.

Parameters:
Name Type Attributes Default Description
name string    

The name of the WaitThen

MEMBERS

callbackArgs :Array|any
IncisorAPI.js, line 8900

Arguments for the callback function invoked when this WaitThen completes.

callbackName :string
IncisorAPI.js, line 8894

The name of the callback function invoked when this WaitThen completes.

callbackOwner :object
IncisorAPI.js, line 8888

The object owning the callback function invoked when this WaitThen completes.

inheritedTypes :object
IncisorAPI.js, line 8859

Dictionary object listing all of the types this object is compatible with.

isActive :boolean
IncisorAPI.js, line 8882

Boolean reporting if this WaitThen is currently 'counting down'. Pausing is not factored into this property; a WaitThen that is activated and then subjected to a PauseEvent would still report 'true'.

Default Value:
  • false

name :string
IncisorAPI.js, line 8866

The name of the WaitThen.

Default Value:
  • "WaitThen"

pauseImmunity :PauseEvent|Array.<PauseEvent>
IncisorAPI.js, line 8908

The PauseEvent or Array of PauseEvents that this WaitThen will be immune to. Set this parameter to [] for this WaitThen to have no pause immunity.

Default Value:
  • nc.defaultPauseImmunity

progress :number
IncisorAPI.js, line 8873

The progress of the WaitThen on the scale from [0,1].

Default Value:
  • 0

speedControl :SpeedControl|Array.<SpeedControl>
IncisorAPI.js, line 8915

The SpeedControl or Array of SpeedControls that this WaitThen is affected by.

Default Value:
  • nc.defaultSpeedControl

type :string
IncisorAPI.js, line 8853

Type identifier.

METHODS

activate(duration, callbackOwner, callbackName, callbackArgs (opt), pauseImmunity (opt), speedControl (opt))
IncisorAPI.js, line 8927

Activates this WaitThen, starting the 'count-down' to this WaitThen's callback.

Parameters:
Name Type Attributes Default Description
duration number  

Seconds before the callback will occur.
callbackOwner object  

The object owning the callback function that is called when the WaitThen completes.
callbackName string  

The name of the function that is called when the WaitThen completes.
callbackArgs Array | any <optional>
  

Arguments for the function that is called when the WaitThen completes.
pauseImmunity PauseEvent | Array.<PauseEvent> <optional>
  

The PauseEvent or Array of PauseEvents that this WaitThen will be immune to. Set this parameter to [] to create callbacks with no immunity. If this parameter is left undefined, the current value of 'nc.defaultPauseImmunity' will be used. The value for 'nc.defaultPauseImmunity' defaults to [], but can be changed at any time. [DEFAULT: nc.defaultPauseImmunity]
speedControl SpeedControl | Array.<SpeedControl> <optional>
  

The SpeedControl or Array of SpeedControls that this WaitThen is affected by. [DEFAULT: nc.defaultSpeedControl]

stop(performCallback (opt))
IncisorAPI.js, line 8933

Stops this WaitThen.

Parameters:
Name Type Attributes Default Description
performCallback boolean <optional>
  

Boolean determining if the callback function will be called immediately, or if it will be skipped entirely. [DEFAULT: false]