Signal

Inherits: Class

Methods

CallbackToSet

function Signal:CallbackToSet()
  -> fun()

Returns a callback function which sets the signal when called.

Returns:

Type	Description
fun()

Clear

function Signal:Clear()

Clears the signal.

GetName

function Signal:GetName()
  -> string

Gets the name for debugging purposes.

Returns:

Type	Description
string

IsSet

function Signal:IsSet()

Clears the signal.

Set

function Signal:Set()

Sets the signal

SetHandler

function Signal:SetHandler(handler)

Sets the handler for when the signal is set

Parameters:

Name	Type	Description
handler	fun(input: Signal)	The handler or nil to clear the handler

__tostring

function Signal:__tostring()

Functions

New

function Signal.New(name)
  -> Signal

Create a new signal.

Parameters:

Name	Type	Description
name	string	The name of the signal for debugging purposes

Returns:

Type	Description
Signal