Leunsel: Initial page creation.

2026-06-27T01:08:58Z

Initial page creation.

New page

[[Category:Lua]]
{{CodeBox|'''function''' createThreadSuspended(''function''(''thread'', ''...''), ''...'' OPTIONAL) ''':''' Thread}}

Creates a thread for the given function, but does not start it immediately.

This function behaves like [[Lua:createNativeThread|createNativeThread]](?), except that the created thread remains suspended until <code>resume()</code> is called on the returned [[Lua:Class:Thread|Thread]] object.

The thread function receives the Thread object as its first parameter, followed by any additional parameters passed to <code>createThreadSuspended</code>.

===Function Declaration===
<syntaxhighlight lang="lua" line highlight="1">
function(thread, ...)
</syntaxhighlight>

===Function Parameters===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|function
|Function
|The function to execute in the new thread. It receives the Thread object as its first argument.
|-
|...
|Any OPTIONAL
|Optional arguments that are passed to the thread function after the Thread object.
|}

===Returns===
[[Lua:Class:Thread|Thread]] — The created suspended Thread object.

===Examples===

====Create a suspended thread====
<syntaxhighlight lang="lua" line highlight="1">
local thread = createThreadSuspended(function(thread)
print("This will not run until resume is called")
end)
</syntaxhighlight>

====Resume a suspended thread====
<syntaxhighlight lang="lua" line highlight="1,5">
local thread = createThreadSuspended(function(thread)
print("Thread started")
end)

thread.resume()
</syntaxhighlight>

====Pass arguments to the suspended thread====
<syntaxhighlight lang="lua" line highlight="4,10">
local message = "Hello from a suspended thread"
local count = 3

local thread = createThreadSuspended(function(thread, text, repetitions)
for i = 1, repetitions do
print(text .. " #" .. tostring(i))
end
end, message, count)

thread.resume()
</syntaxhighlight>

====Prepare a thread and start it later====
<syntaxhighlight lang="lua" line highlight="1,9">
local workerThread = createThreadSuspended(function(thread)
for i = 1, 5 do
print("Worker step " .. tostring(i))
sleep(500)
end
end)

print("Thread created, but not running yet")
workerThread.resume()
</syntaxhighlight>

====Use synchronize after resuming====
<syntaxhighlight lang="lua" line highlight="1,4,9">
local thread = createThreadSuspended(function(thread)
local result = "Background work finished"

synchronize(function()
print(result)
end)
end)

thread.resume()
</syntaxhighlight>

====Create a suspended thread from a named function====
<syntaxhighlight lang="lua" line highlight="7,9">
local function worker(thread, message)
print(message)
end

local message = "Running named worker"

local thread = createThreadSuspended(worker, message)

thread.resume()
</syntaxhighlight>

====Use the returned Thread object====
<syntaxhighlight lang="lua" line highlight="1,5">
local thread = createThreadSuspended(function(thread)
print("Thread object inside worker: " .. tostring(thread))
end)

print("Returned thread object: " .. tostring(thread))
</syntaxhighlight>

====Resume conditionally====
<syntaxhighlight lang="lua" line highlight="1,8">
local thread = createThreadSuspended(function(thread)
print("Conditional start")
end)

local shouldStart = true

if shouldStart then
thread.resume()
end
</syntaxhighlight>

====Create multiple suspended threads====
<syntaxhighlight lang="lua" line highlight="4,12">
local threads = {}

for i = 1, 3 do
threads[i] = createThreadSuspended(function(thread, index)
print("Thread " .. tostring(index) .. " started")
end, i)
end

print("All threads created")

for i = 1, #threads do
threads[i].resume()
end
</syntaxhighlight>

{{LuaSeeAlso}}

{{Threads}}

Lua:createThreadSuspended - Revision history

Leunsel: Initial page creation.