Difference between revisions of "Lua:getOpenedProcessID"

From Cheat Engine
Jump to navigation Jump to search
(Related Functions)
m (Syntax Highlighting.)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Lua]]
 
[[Category:Lua]]
'''function''' getOpenedProcessID()
+
{{CodeBox|'''function''' getOpenedProcessID() ''':''' Integer}}
  
Returns the process id of the process Cheat Engine has currently open. Returns the value 0 if no process is open
+
Returns the process ID of the currently opened process in Cheat Engine.
 +
If no process is open, returns 0.
  
 +
'''Note:''' 
 +
''getOpenedProcessID()'' does not return 0 after a process was closed. 
 +
It will still return the previous ID, even if the process has been terminated. 
 +
To check if the process is still available, use ''readInteger(process)''.
  
 
{{LuaFunctionParametersNone}}
 
{{LuaFunctionParametersNone}}
 +
 +
===Returns===
 +
Integer — The process ID of the currently opened process, or 0 if none.
 +
 +
===Examples===
 +
<syntaxhighlight lang="lua" line>
 +
local pid = getOpenedProcessID()
 +
if pid ~= 0 then
 +
  print("Current process ID:", pid)
 +
  local check = readInteger(process)
 +
  if check == pid then
 +
    print("Process is still the same and available.")
 +
  else
 +
    print("Process has changed or is no longer available.")
 +
  end
 +
else
 +
  print("No process is currently open.")
 +
end
 +
</syntaxhighlight>
  
 
{{LuaSeeAlso}}
 
{{LuaSeeAlso}}
  
=== Related Functions ===
+
{{Process}}
* [[Lua:getProcesslist|getProcesslist]]
 
* [[Lua:getProcessIDFromProcessName|getProcessIDFromProcessName]]
 
* [[Lua:createProcess|createProcess]]
 
* [[Lua:openProcess|openProcess]]
 

Latest revision as of 19:09, 25 June 2026

<> Lua API Reference

function getOpenedProcessID() : Integer

Returns the process ID of the currently opened process in Cheat Engine. If no process is open, returns 0.

Note: getOpenedProcessID() does not return 0 after a process was closed. It will still return the previous ID, even if the process has been terminated. To check if the process is still available, use readInteger(process).

Function Parameters[edit]

<none>

Returns[edit]

Integer — The process ID of the currently opened process, or 0 if none.

Examples[edit]

 1 local pid = getOpenedProcessID()
 2 if pid ~= 0 then
 3   print("Current process ID:", pid)
 4   local check = readInteger(process)
 5   if check == pid then
 6     print("Process is still the same and available.")
 7   else
 8     print("Process has changed or is no longer available.")
 9   end
10 else
11   print("No process is currently open.")
12 end

Main Pages

Core Lua documentation entry points

Lua
Script Engine

Process Open / Creation

Process Lists / Modules

Process Control / Target State