Leunsel: Initial page creation.

2026-06-27T01:06:42Z

Initial page creation.

New page

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

Executes the given function in another thread using the system's thread mechanism.

The function returns a [[Lua:Class:Thread|Thread]] class object. The thread function receives the Thread object as its first parameter, followed by any additional parameters passed to <code>createThread</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 Thread object.

===Examples===

====Create a basic thread====
<syntaxhighlight lang="lua" line highlight="1">
local thread = createThread(function(thread)
print("Thread started")
end)
</syntaxhighlight>

====Use the Thread parameter====
<syntaxhighlight lang="lua" line highlight="1">
local thread = createThread(function(thread)
print("Thread object: " .. tostring(thread))
end)
</syntaxhighlight>

====Pass arguments to the thread function====
<syntaxhighlight lang="lua" line highlight="4">
local text = "Hello from another thread"
local count = 3

local thread = createThread(function(thread, message, repetitions)
for i = 1, repetitions do
print(message .. " #" .. tostring(i))
end
end, text, count)
</syntaxhighlight>

====Run repeated work in a thread====
<syntaxhighlight lang="lua" line highlight="1">
local thread = createThread(function(thread)
for i = 1, 5 do
print("Worker step " .. tostring(i))
sleep(500)
end
end)
</syntaxhighlight>

====Use synchronize for main-thread work====
<syntaxhighlight lang="lua" line highlight="1,4">
local thread = createThread(function(thread)
local result = "Finished background work"

synchronize(function()
print(result)
end)
end)
</syntaxhighlight>

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

local message = "Running named worker"

local thread = createThread(worker, message)
</syntaxhighlight>

====Pass multiple values====
<syntaxhighlight lang="lua" line highlight="1">
local thread = createThread(function(thread, a, b, c)
print("A: " .. tostring(a))
print("B: " .. tostring(b))
print("C: " .. tostring(c))
end, 10, "text", true)
</syntaxhighlight>

====Store the returned Thread object====
<syntaxhighlight lang="lua" line highlight="1">
local workerThread = createThread(function(thread)
print("Thread is running")
end)

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

====Guard thread creation behind a condition====
<syntaxhighlight lang="lua" line highlight="4">
local shouldStart = true

if shouldStart then
createThread(function(thread)
print("Conditional thread started")
end)
end
</syntaxhighlight>

{{LuaSeeAlso}}

{{Threads}}

Lua:createThread - Revision history

Leunsel: Initial page creation.