Difference between revisions of "Lua:Class:Form"

From Cheat Engine
Jump to navigation Jump to search
m (Reverted edits by This content is not available (Talk) to last revision by TheyCallMeTim13)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
'''Form Class''' (Inheritance ScrollingWinControl->CustomControl->WinControl->Control->Component->Object)
+
[[Category:Lua]]
−
  The Form class is a window
+
'''Form Class''' (Inheritance ''[[Lua:Class:ScrollingWinControl|ScrollingWinControl]]''->''[[Lua:Class:CustomControl|CustomControl]]''->''[[Lua:Class:WinControl|WinControl]]''->''[[Lua:Class:Control|Control]]''->''[[Lua:Class:Component|Component]]''->''[[Lua:Class:Object|Object]]'')
  
 +
The Form class is a window
  
 
'''createForm'''(visible OPT)  
 
'''createForm'''(visible OPT)  
−
  Creates a Form class object(window) and returns the pointer for it. Visible is default true but can be changed
+
Creates a Form class object(window) and returns the pointer for it. Visible is default true but can be changed
−
 
 
  
 
'''createFormFromFile'''(filename)  
 
'''createFormFromFile'''(filename)  
−
  Creates a Form class object and initializes it based on the data in the given file.
+
Creates a Form class object and initializes it based on the data in the given file.
−
  It returns the generated form
+
It returns the generated form
−
 
 
−
 
 
−
'''form_saveToFile'''(form, filename)
 
−
  Saves a userdefined form. (DOES NOT WORK ON NORMAL FORMS LIKE MAINFORM)
 
−
 
 
−
 
 
−
'''form_centerScreen'''(form)
 
−
  Places the form at the center of the screen
 
−
 
 
  
−
'''form_hide'''(form) 
 
−
  Hide the form
 
  
 +
== Properties ==
  
−
'''form_show'''(form) 
 
−
  Show the form
 
  
 +
== Methods ==
 +
'''saveToFile'''(filename)
 +
Saves a userdefined form. (DOES NOT WORK ON NORMAL FORMS LIKE MAINFORM)
  
−
'''form_showModal'''(form)  
+
'''centerScreen'''()
−
  Show the form and wait for it to close and get the close result
+
Places the form at the center of the screen
  
 +
'''hide'''()
 +
Hide the form
  
−
'''form_isForegroundWindow'''(form)  
+
'''show'''()
−
  returns true if the specified form has focus
+
Show the form
  
 +
'''showModal'''()
 +
Show the form and wait for it to close and get the close result
  
−
'''form_onClose'''(form, function)  
+
'''isForegroundWindow'''()  
−
  function (sender)  Return a CloseAction to determine how to close the window
+
returns true if the specified form has focus
  
 +
'''onClose'''(function)
 +
function (sender) Return a CloseAction to determine how to close the window
  
−
'''form_getMenu'''(form)
+
'''getMenu'''(form)
−
  Returns the mainmenu object of this form
+
Returns the mainmenu object of this form
  
 +
'''setMenu'''(mainmenu)
 +
Sets a menu for the form
  
−
'''form_setMenu'''(form, mainmenu)
 
−
  Sets a menu for the form
 
  
−
Example:
+
== Examples ==
 
<pre>
 
<pre>
 
function goodbyeMessage(sender)
 
function goodbyeMessage(sender)
Line 55: Line 52:
  
 
local forms = createForm(true) -- true = visible(optional), false = not visible when created.
 
local forms = createForm(true) -- true = visible(optional), false = not visible when created.
−
form_hide(forms)              -- hides the form
+
forms.hide()              -- hides the form
 
sleep(3000)
 
sleep(3000)
−
form_show(forms)                -- again makes the form visible
+
forms.show()                -- again makes the form visible
 
sleep(3000)
 
sleep(3000)
−
form_centerScreen(forms)      -- Places the form at the center of the screen
+
forms.centerScreen()      -- Places the form at the center of the screen
−
if form_isForegroundWindow(forms)  then
+
if forms.isForegroundWindow(forms)  then
 
   print "form in focus"
 
   print "form in focus"
 
end
 
end
−
form_onClose(forms, goodbyeMessage)  -- delegates goodbyeMessage function. goodbyeMessage should have the prototype "goodbyeMessage(oneArgument)"
+
forms.onClose(goodbyeMessage)  -- delegates goodbyeMessage function. goodbyeMessage should have the prototype "goodbyeMessage(oneArgument)"
 
</pre>
 
</pre>
 +
 +
 +
{{LuaSeeAlso}}

Latest revision as of 19:07, 18 March 2019

Form Class (Inheritance ScrollingWinControl->CustomControl->WinControl->Control->Component->Object)

The Form class is a window

createForm(visible OPT) Creates a Form class object(window) and returns the pointer for it. Visible is default true but can be changed

createFormFromFile(filename) Creates a Form class object and initializes it based on the data in the given file. It returns the generated form


Properties[edit]

Methods[edit]

saveToFile(filename) Saves a userdefined form. (DOES NOT WORK ON NORMAL FORMS LIKE MAINFORM)

centerScreen() Places the form at the center of the screen

hide() Hide the form

show() Show the form

showModal() Show the form and wait for it to close and get the close result

isForegroundWindow() returns true if the specified form has focus

onClose(function) function (sender) Return a CloseAction to determine how to close the window

getMenu(form) Returns the mainmenu object of this form

setMenu(mainmenu) Sets a menu for the form


Examples[edit]

function goodbyeMessage(sender)
  print "called by form_onClose"
  closeCE()                    -- Just closes ce
end

local forms = createForm(true) -- true = visible(optional), false = not visible when created.
forms.hide()               -- hides the form
sleep(3000)
forms.show()                -- again makes the form visible
sleep(3000)
forms.centerScreen()       -- Places the form at the center of the screen
if forms.isForegroundWindow(forms)  then
  print "form in focus"
end
forms.onClose(goodbyeMessage)   -- delegates goodbyeMessage function. goodbyeMessage should have the prototype "goodbyeMessage(oneArgument)"


See also[edit]



Retrieved from "https://wiki.cheatengine.org/index.php?title=Lua:Class:Form&oldid=6620"