Difference between revisions of "Lua:inMainThread"

From Cheat Engine
Jump to navigation Jump to search
m (Minor edit. Added Version Notice Template.)
m (Added related function template.)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:Lua]]
 
[[Category:Lua]]
 
{{VersionNotice|6.4+}}
 
{{VersionNotice|6.4+}}
'''function''' inMainThread() ''':''' Boolean
+
{{CodeBox|'''function''' inMainThread() ''':''' boolean}}
  
 
Returns true if the current code is running inside the main thread.
 
Returns true if the current code is running inside the main thread.
 +
 +
This function is available in Cheat Engine 6.4 and later.
  
 
===Function Parameters===
 
===Function Parameters===
None.
+
This function has no parameters.
  
 
===Returns===
 
===Returns===
Boolean true if running in the main thread, false otherwise.
+
boolean True if the current code is running inside the main thread, otherwise false.
  
 
===Examples===
 
===Examples===
<pre>
+
<syntaxhighlight lang="lua" line>
function ShowError(message)
+
if inMainThread() then
    if not inMainThread() then
+
  print("Running in the main thread")
        synchronize(function()
+
else
            self:ShowError(message)
+
  print("Not running in the main thread")
        end)
 
        return
 
    end
 
    messageDialog(message, mtError, mbOK)
 
 
end
 
end
</pre>
+
</syntaxhighlight>
 +
 
 +
{{LuaSeeAlso}}
  
== See also ==
+
{{Threads}}
* [[Lua:createThread|createThread]]
 
* [[Lua:synchronize|synchronize]]
 

Latest revision as of 20:53, 26 June 2026

⚠️ Version Notice

This function requires Cheat Engine 6.4+.

<> Lua API Reference

function inMainThread() : boolean

Returns true if the current code is running inside the main thread.

This function is available in Cheat Engine 6.4 and later.

Function Parameters[edit]

This function has no parameters.

Returns[edit]

boolean — True if the current code is running inside the main thread, otherwise false.

Examples[edit]

1 if inMainThread() then
2   print("Running in the main thread")
3 else
4   print("Not running in the main thread")
5 end

Main Pages

Core Lua documentation entry points

Lua
Script Engine

Thread Related Lua Functions

CPU information, process threads, main-thread execution, and queued callbacks