MIST removeFunction

mist.removeFunction

Added with: Mist 1.0

Description

Removes the scheduled function with integer id id and returns true if a function was removed.

Syntax

boolean mist.removeFunction(number id )

Valid Input Values:

number id: any number

Return value:

boolean

Return example:

true

Usage Examples:

The following would remove a scheduled function from executing. do local myFunc = mist.scheduleFunction(mist.groupToRandomZone, {'myGroup', 'myZone'}, timer.getTime() + 10, 900, timer.getTime() + 3600) if whatever == true then mist.removeFunction(myFunc) end end

Notes:

Related Functions

scheduleFunction, removeFunction, addEventHandler, removeEventHandler

Scripting Engine

MIST Root Page