Script:stop_thread

Stops a specific Thread. See Thread:stop for more details on what it means to stop a thread.

Attempting to stop a thread which belongs to a different script will cause an error. Calling Thread:stop instead avoids this pitfall.

Usage

script:stop_thread(thread)

Arguments

Name Type Description
thread Thread Thread to stop.

Examples

local script = Script:new();
local thread = script:run_thread(function(self)
  self:defer(function()
    print("bye");
  end);
  self:hang();
end);
script:stop_thread(thread); -- Prints "bye"
script:stop_thread(thread); -- Does nothing

This site uses Just the Docs, a documentation theme for Jekyll.