Skip to content

Common API Documentation

Jump to bottom
hugeblank edited this page Dec 21, 2020 · 1 revision

All of the following documentation refers to code found within both groups and threads alike. Instead of saying "thread and/or group", the objects that use these functions will be called instances.

state: Gets the current state of the instance

  • Parameters
    • none
  • Returns
    • boolean: execution state (false if the instance is disabled)

toggle: Toggle the state of an instance

  • Parameters
    • [boolean]: state to toggle the instance to. If left blank, state will invert.
  • Returns
    • none

setPriority: Sets the current priority of the instance (order of execution)

  • Parameters
    • number: execution priority
  • Returns
    • none

getPriority: Gets the current priority of the instance

  • Parameters
    • none
  • Returns
    • number: execution priority

remove: Wipes instance from memory preventing it from being executed again

  • Parameters
    • none
  • Returns
    • boolean: success (returns false if thread was already removed)
Clone this wiki locally