Type: Consumer

From Waltz
Jump to navigation Jump to search

To see how to actually use Consumers, see Scripting: Consumer Functions.

The Consumer type is a special type that holds a script function that will be used as a consumer of some result. This is used in situations where asking for a result will not immediately have a result to return, but the show should not stop and wait for the result. The Consumer is used

The Expression type is a special type that stores a piece of JavaScript that will be evaluated to get an actual value.


IN GENERAL, IT IS NOT NECESSARY TO EXPLICITLY USE THE Consumer(…) CONSTRUCTOR. Simply providing the function as the consumer will generally accomplish the same task in fewer words and in a more performant manner.

Consumer(function) Functionfunction- A JavaScript function that will consume the result.


There are no parameters exposed by this type.


There are no functions exposed by this type.

Primitives Boolean · Number · String
Objects Color · Dimension · DmxMultiverse · DmxUniverse · LocalInterface · Material · Point · RemoteAddress/IP · Scene · Time · Touch
Node Specific NdiSource · WoControlCue · WoHitTestResult · WoTimeline
Collections List · List of Lists · Map · Varargs
Special Any · Consumer · Expression · Null · Void