class SigStream

Continuous stream of values.

index

members

• sigstream:set(value)  – update this stream’s value.
• sigstream.value  – the wrapped Lua value.

static functions

• SigStream(type, value)  – construct a new Constant.

result interface

• sigstream:dirty()  – return whether this Result was changed in the current tick.
• sigstream:unwrap([type[, msg]])  – unwrap to the Lua type.
• sigstream:fork()  – create a mutable copy of this stream.
• sigstream:__call(...)  – alias for unwrap.
• sigstream.type  – the type of this Result’s value.
• sigstream.metatype()  – the metatype string for this Result.

details

members

• sigstream:set(value)  – update this stream’s value.
  Marks this stream as dirty for the remainder of the current tick.

  parameters:

  • value
• sigstream.value  – the wrapped Lua value.
  • value (any)

static functions

• SigStream(type, value)  – construct a new Constant.

  parameters:

  • type (string): the type name
  • value (optional any): the Lua value to be accessed through unwrap

result interface

• sigstream:dirty()  – return whether this Result was changed in the current tick.

  returns:

  1. (bool)
• sigstream:unwrap([type[, msg]])  – unwrap to the Lua type.
  Asserts @type == type if type is given.

  parameters:

  • type (type.Type): the type to check for (optional)
  • msg (string): message to throw if type don’t match (optional)

  returns:

  1. (any): value
• sigstream:fork()  – create a mutable copy of this stream.
  Used to insulate eval-cycles from each other.

  returns:

  1. (SigStream)
• sigstream:__call(...)  – alias for unwrap.

  parameters:

  • ...
• sigstream.type  – the type of this Result’s value.
  • type (type.Type)
• sigstream.metatype()  – the metatype string for this Result.