Future

Inherits: Class

Methods

Cancel

function Future:Cancel()

Marks the future as cancelled and cleans it up.

Done

function Future:Done(value)

Marks the future as done with the specified result value.

Parameters:

Name	Type	Description
value	T	The result value

GetName

function Future:GetName()
  -> string

Gets the name for debugging purposes.

Returns:

Type	Description
string

GetValue

function Future:GetValue()
  -> <T>

Gets the result value from a future in the done state.

Returns:

Type	Description
<T>

IsDone

function Future:IsDone()
  -> boolean

Returns whether or not the future is done.

Returns:

Type	Description
boolean

SetScript

function Future:SetScript(script, handler)

Registers a script handler.

Parameters:

Name	Type	Description
script	"OnDone" | "OnCleanup"	The script to register for
handler	function	The script handler

Start

function Future:Start()

Marks the future as started.

_Reset

function Future:_Reset()

__init

function Future:__init(name)

Parameters:

Name	Type	Description
name	``

__tostring

function Future:__tostring()

Functions

New

function Future.New(name)
  -> Future

Create a new future.

Parameters:

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

Returns:

Type	Description
Future