### Disassemblerview OnExtraLineRender Example (Lua)

Source: https://antumce.github.io/CE_LDoc/classes/Disassemblerview

Example of how to use the OnExtraLineRender function for the Disassemblerview. This function allows custom image rendering above or below instructions. It's called twice, once for above and once for below, and expects different image objects for each call. The image will be centered if no coordinates are provided.

```lua
Disassemblerview.OnExtraLineRender = function function(sender, Address, AboveInstruction, Selected): RasterImage OPTIONAL, x OPTIONAL, y OPTIONAL
  -- Your custom rendering logic here
  -- Return a RasterImage object, and optionally x and y coordinates
end
```

--------------------------------

### Creating a Timer Instance in Lua

Source: https://antumce.github.io/CE_LDoc/classes/Timer

This snippet shows how to create a new instance of the Timer class in Lua. It includes an example of creating a timer and optionally setting its initial enabled state. The owner parameter can be nil, but manual destruction is then required.

```lua
-- Create a timer owned by nil, which will be enabled by default once OnTimer is assigned
local myTimer = Timer.createTimer(nil)

-- Create a timer owned by another object (replace 'ownerObject' with an actual object)
-- local myTimer = Timer.createTimer(ownerObject)

-- Create a timer that is initially disabled
-- local myTimer = Timer.createTimer(nil, false)

-- Assign an event handler to start the timer
myTimer.OnTimer = function(timer)
  print('Timer triggered!')
end
```

--------------------------------

### Disassemblerview OnSelectionChange Example (Lua)

Source: https://antumce.github.io/CE_LDoc/classes/Disassemblerview

Example of how to use the OnSelectionChange function for the Disassemblerview. This function is triggered whenever the selection of addresses within the disassembler view changes. It provides the sender object, the primary selected address, and the secondary selected address as arguments.

```lua
Disassemblerview.OnSelectionChange = function(sender, address, address2)
  -- Your selection change logic here
  print('Selection changed: Address=' .. address .. ', Address2=' .. address2)
end
```

--------------------------------

### Thread Creation and Management in Cheat Engine

Source: https://antumce.github.io/CE_LDoc/classes/Thread

This snippet demonstrates how to create and manage threads within Cheat Engine. It covers creating threads that start immediately or are suspended until resumed, along with methods for synchronization, termination, and waiting for thread completion. Use 'synchronize' for GUI access from within a thread.

```lua
local myThread = createThread(function(Thread, ...)
  -- Thread logic here
  print('Thread started')
  waitfor(myThread) -- Example of waiting for another thread
end)

local suspendedThread = createThreadSuspended(function(Thread, ...)
  print('Suspended thread created')
end)

-- Later, resume the suspended thread
suspendedThread.resume()

-- Synchronize GUI operations from within a thread
myThread.synchronize(function(thread, ...)
  -- GUI update logic here, executed in the main thread
end)

-- Terminate a thread
myThread.terminate()

-- Check if a thread has terminated
if myThread.Terminated then
  print('Thread has been terminated')
end

-- Free the thread object when it terminates (default behavior)
-- myThread.freeOnTerminate(true)

```

--------------------------------

### xmplayer Class Documentation

Source: https://antumce.github.io/CE_LDoc/classes/xmplayer

This section details the properties and methods available for the xmplayer class.

```APIDOC
## Class `xmplayer`

The xmplayer class has already been defined as xmplayer, no need to create it manually.

### Properties

**Initialized** 
     Indicator that the xmplayer is actually actively loaded in memory. 
### Type:
boolean

**IsPlaying** 
     Indicator that the xmplayer is currently playing a xm file. 
### Type:
boolean

### Methods

**pause ()** 
     

**playXM (_filename_ , _noloop_ )** 
    
### Parameters:
  * filename string
  * noloop (_optional_)

**playXM (_tablefile_ , _noloop_ )** 
    
### Parameters:
  * tablefile
  * noloop (_optional_)

**playXM (_Stream_ , _noloop_ )** 
    
### Parameters:
  * Stream
  * noloop (_optional_)

**resume ()** 
     

**setVolume (_vol_ )** 
    
### Parameters:
  * vol integer

**stop ()** 
     
```

--------------------------------

### MemoryRecord Get Display Value Function

Source: https://antumce.github.io/CE_LDoc/classes/MemoryRecord

A function that gets called when rendering the value of a memory record. Returning true along with a new string overrides the displayed value.

```javascript
MemoryRecord.OnGetDisplayValue = function(memoryrecord, valuestring) {
  // Custom logic to format the display value
  // return true, "new display value";
}
```

--------------------------------

### FileStream Creation and Inheritance

Source: https://antumce.github.io/CE_LDoc/classes/FileStream

This section details the FileStream class, including its inheritance from HandleStream, Stream, and Object, and how to create a new FileStream instance.

```APIDOC
## Class FileStream

### Description
Represents a file stream for reading from and writing to files.

### Inheritance
FileStream inherits from HandleStream, which in turn inherits from Stream and Object.

### Creation

**createFileStream** (`filename`, `mode`)

Creates a new FileStream object.

#### Parameters

*   **filename** (string) - The name of the file to open.
*   **mode** (string) - The mode in which to open the file (e.g., 'r' for read, 'w' for write, 'a' for append).

#### Returns

*   FileStream - A new instance of the FileStream class.
```

--------------------------------

### Class: SelectDirectoryDialog

Source: https://antumce.github.io/CE_LDoc/classes/SelectDirectoryDialog

Documentation for the SelectDirectoryDialog class, detailing its inheritance and creation method.

```APIDOC
## Class `SelectDirectoryDialog`

### Description
Represents a dialog box for selecting a directory.

### Inheritance
OpenDialog | SelectDirectoryDialog ← OpenDialog ← FileDialog ← CommonDialog ← Component ← Object

### Creation
`createSelectDirectoryDialog(_owner_)`

### Parameters
#### Path Parameters
- **_owner_** (Object) - The owner component of the dialog.

### Request Example
```json
{
  "example": "createSelectDirectoryDialog(ownerComponent)"
}
```

### Response
#### Success Response (200)
- **SelectDirectoryDialog** (Object) - A new instance of the SelectDirectoryDialog.

#### Response Example
```json
{
  "example": "dialogObject = createSelectDirectoryDialog(mainForm)"
}
```
```

--------------------------------

### Canvas Pixel Manipulation API

Source: https://antumce.github.io/CE_LDoc/classes/Canvas

Allows getting and setting individual pixels on the canvas.

```APIDOC
## GET /canvas/pixel

### Description
Gets the color of a specific pixel on the canvas.

### Method
GET

### Endpoint
/canvas/pixel

### Parameters
#### Query Parameters
- **x** (integer) - Required - The X coordinate of the pixel.
- **y** (integer) - Required - The Y coordinate of the pixel.

### Request Example
GET /canvas/pixel?x=10&y=20

### Response
#### Success Response (200)
- **color** (Color) - The color of the pixel.

#### Response Example
```json
{
  "color": "#FF0000"
}
```
```

```APIDOC
## POST /canvas/pixel

### Description
Sets the color of a specific pixel on the canvas.

### Method
POST

### Endpoint
/canvas/pixel

### Parameters
#### Request Body
- **x** (integer) - Required - The X coordinate of the pixel.
- **y** (integer) - Required - The Y coordinate of the pixel.
- **color** (Color) - Required - The color to set the pixel to.

### Request Example
```json
{
  "x": 15,
  "y": 25,
  "color": "#00FF00"
}
```

### Response
#### Success Response (200)
No content, indicates success.

#### Response Example
None
```

--------------------------------

### Class Menu

Source: https://antumce.github.io/CE_LDoc/classes/Menu

Documentation for the Menu class, detailing its inheritance, properties, and methods.

```APIDOC
## Class Menu

### Description
Represents a menu in the Cheat Engine interface.

### Inheritance
Component | Menu ← Component ← Object

### Properties
*   **Items** (MenuItem) - Required - The base MenuItem class of this menu (readonly).

### Methods
*   **getItems()** - Returns the main MenuItem of this Menu.
```

--------------------------------

### Memoryview Class Documentation

Source: https://antumce.github.io/CE_LDoc/classes/Memoryview

Provides details about the Memoryview class, its inheritance hierarchy, properties, and creation function.

```APIDOC
## Class `Memoryview`

### Inheritance
Form | Memoryview 🡄 Form 🡄 ScrollingWinControl 🡄 CustomControl 🡄 WinControl 🡄 Control 🡄 Component 🡄 Object

### Properties
#### DisassemblerView
- **Type**: Disassemblerview
- **Description**: The disassemblerview class of this memoryview object.

#### HexadecimalView
- **Type**: Hexadecimalview
- **Description**: The hexadecimalview class of this memoryview object.

### Creation
#### createMemoryView ()
- **Description**: Creates a new memoryview window. This window will not receive debug events. Use getMemoryViewForm() function to get the main memoryview window.
```

--------------------------------

### Canvas Pen API

Source: https://antumce.github.io/CE_LDoc/classes/Canvas

Provides functions to get and set the pen object of the canvas.

```APIDOC
## GET /canvas/pen

### Description
Returns the pen object of this canvas.

### Method
GET

### Endpoint
/canvas/pen

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **pen** (Pen) - The current pen object.

#### Response Example
```json
{
  "pen": { ... } 
}
```
```

--------------------------------

### Canvas Brush API

Source: https://antumce.github.io/CE_LDoc/classes/Canvas

Provides functions to get and manipulate the brush object of the canvas.

```APIDOC
## GET /canvas/brush

### Description
Returns the brush object of this canvas.

### Method
GET

### Endpoint
/canvas/brush

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **brush** (Brush) - The current brush object.

#### Response Example
```json
{
  "brush": { ... } 
}
```
```

--------------------------------

### Class Icon

Source: https://antumce.github.io/CE_LDoc/classes/Icon

Documentation for the Icon class, including its inheritance and creation method.

```APIDOC
## Class `Icon`

### Description
Documentation for the Icon class, detailing its inheritance hierarchy and how to create an instance.

### Method
createIcon

### Endpoint
N/A (Class method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Icon object**: A newly created Icon object.

#### Response Example
N/A

### Inheritance
CustomBitmap | Icon 🡄 CustomBitmap 🡄 RasterImage 🡄 Graphic 🡄 Object

### Creation
`createIcon(_width_, _height_)`

Returns an Icon object.

#### Parameters:
- **_width_** (integer) - Required - The width of the icon.
- **_height_** (integer) - Required - The height of the icon.

#### Returns:
- **Icon** - The created Icon object.
```

--------------------------------

### Canvas Pen Position API

Source: https://antumce.github.io/CE_LDoc/classes/Canvas

Provides functions to get and set the current pen position on the canvas.

```APIDOC
## GET /canvas/penposition

### Description
Gets the current pen position on the canvas.

### Method
GET

### Endpoint
/canvas/penposition

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **x** (integer) - The current X coordinate of the pen.
- **y** (integer) - The current Y coordinate of the pen.

#### Response Example
```json
{
  "x": 10,
  "y": 20
}
```
```

```APIDOC
## POST /canvas/penposition

### Description
Sets the current pen position on the canvas.

### Method
POST

### Endpoint
/canvas/penposition

### Parameters
#### Request Body
- **x** (integer) - Required - The new X coordinate.
- **y** (integer) - Required - The new Y coordinate.

### Request Example
```json
{
  "x": 30,
  "y": 40
}
```

### Response
#### Success Response (200)
No content, indicates success.

#### Response Example
None
```

--------------------------------

### Class DisassemblerviewLine

Source: https://antumce.github.io/CE_LDoc/classes/DisassemblerviewLine

Documentation for the DisassemblerviewLine class, detailing its inheritance and properties.

```APIDOC
## Class `DisassemblerviewLine`

### Description
Represents a single line within the Disassemblerview, providing information about its address and owner.

### Inheritance
* Object
    * DisassemblerviewLine

### Properties
#### Address
- **Type**: Any (represents a memory address)
- **Description**: The current address of this line.

#### Owner
- **Type**: `Disassemblerview`
- **Description**: The Disassemblerview that owns this line.
```

--------------------------------

### CommonDialog Title Property

Source: https://antumce.github.io/CE_LDoc/classes/CommonDialog

The Title property of the CommonDialog class sets or gets the caption displayed at the top of the dialog window.

```lua
CommonDialog.Title = "My Dialog Title" -- Set the title
local currentTitle = CommonDialog.Title -- Get the current title
```

--------------------------------

### Class Brush API

Source: https://antumce.github.io/CE_LDoc/classes/Brush

Documentation for the Brush class, including its inheritance, properties, and methods.

```APIDOC
## Class `Brush`

### Description
Provides functionality related to graphical brushes.

### Inheritance
* `CustomBrush`
* `CanvasHelper`
* `Object`

### Properties
#### `Color`
- **Type:** integer
- **Description:** Represents the color of the brush.

### Methods
#### `getColor ()`
- **Description:** Retrieves the current color of the brush.
- **Returns:**
  - **Type:** integer
  - **Description:** The color of the brush.

#### `setColor ()`
- **Description:** Sets the color of the brush.
- **Parameters:** (No explicit parameters listed in the source, but implied to set the brush color)
- **Request Body:** (Not applicable for this method based on provided docs)

### Request Example
(Not applicable for `setColor` based on provided documentation)

### Response
#### Success Response (200)
- **`getColor()`:**
  - **Type:** integer
  - **Description:** The color of the brush.

#### Response Example
```json
{
  "getColor()": 16711680
}
```
```

--------------------------------

### Class: MainMenu

Source: https://antumce.github.io/CE_LDoc/classes/MainMenu

Documentation for the MainMenu class, which represents the menu bar at the top of a window.

```APIDOC
## Class: MainMenu

### Description
The mainmenu is the menu at the top of a window.

### Inheritance
Menu | MainMenu 🡄 Menu 🡄 Component 🡄 Object

### Related Functions
- **createMainMenu** (_form_)
  Create a new MainMenu.

  #### Parameters:
  - **form** (Form) - Required - The form to which the MainMenu will be attached.
```

--------------------------------

### Get Memory Record Address

Source: https://antumce.github.io/CE_LDoc/classes/MemoryRecord

Retrieves the interpretable address string of the memory record. This provides a human-readable representation of the memory location.

```lua
getAddress ()
```

--------------------------------

### Get Current Memory Record Address

Source: https://antumce.github.io/CE_LDoc/classes/MemoryRecord

Returns the current address of the memory record as an integer value. This is the actual numerical memory address being pointed to.

```lua
getCurrentAddress ()
```

--------------------------------

### Class ListColumns

Source: https://antumce.github.io/CE_LDoc/classes/ListColumns

Documentation for the ListColumns class, including its inheritance, properties, and methods.

```APIDOC
## Class ListColumns

### Inheritance
Collection | ListColumns 🡄 Collection 🡄 Object

### Properties
- **Columns** [] (array) - Array to access a column.
- **FIXME** [] (array) - Same as Columns.

### Methods
- **add ()**
  Description: Returns a new ListColumn object.

- **getColumn (_index_)**
  Description: Returns a ListColumn object.
  ### Parameters:
  - **index** (integer) - The index of the column to retrieve.

- **setColumn (_index_, _listcolumns_)**
  Description: Sets a ListColumn object (not recommended, use add instead).
  ### Parameters:
  - **index** (integer) - The index of the column to set.
  - **listcolumns** (any) - The ListColumn object to set.
```

--------------------------------

### Application Class API

Source: https://antumce.github.io/CE_LDoc/classes/Application

Documentation for the Application class, detailing its inheritance, properties, and methods.

```APIDOC
## Class `Application`

### Description
Represents the main application instance of Cheat Engine.

### Inheritance
`Application` inherits from `CustomApplication`, which in turn inherits from `Component`, and ultimately `Object`.

### Properties

*   **Icon** (type: Unknown) - The icon of Cheat Engine displayed in the taskbar.
*   **Title** (type: Unknown) - The title of Cheat Engine displayed in the window's title bar.

### Methods

*   **bringToFront ()**
    *   Description: Brings the Cheat Engine application window to the front, making it the active window.
    *   Parameters: None
    *   Returns: None

*   **minimize ()**
    *   Description: Minimizes the Cheat Engine application window.
    *   Parameters: None
    *   Returns: None

*   **processMessages ()**
    *   Description: Processes pending window messages for the application.
    *   Parameters: None
    *   Returns: None

*   **terminate ()**
    *   Description: Terminates the Cheat Engine application.
    *   Parameters: None
    *   Returns: None

### Request Example
```json
{
  "method": "bringToFront",
  "params": []
}
```

### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Get Memory Record Hotkey by Index

Source: https://antumce.github.io/CE_LDoc/classes/MemoryRecord

Retrieves a hotkey from the hotkey array of a memory record using its index. This allows access to specific hotkey configurations.

```lua
getHotkey ( _index_ )
```

--------------------------------

### Class Strings

Source: https://antumce.github.io/CE_LDoc/classes/Strings

Documentation for the Strings class, including its inheritance, properties, and methods.

```APIDOC
## Class Strings

### Description
(Mostly an abstract class)

### Inheritance
Object | Strings 🡄 Object

### Properties
- **Count** (Integer) - The number of strings in this list.
- **LineBreak** (String) - The character(s) to count as a linebreak.
- **String** (array) - Array to access one specific string in the list.
- **Text** (String) - All the strings in one string.

### Methods
- **add()** (string) - Adds a string to the list.
- **beginUpdate()** - Stops updates from triggering other events (prevents flashing).
- **clear()** - Deletes all strings in the list.
- **delete(index)** (int) - Deletes a string from the list.
- **endUpdate()** - Call after beginUpdate.
- **getCount()** - Returns the number of strings in the list. (Returns: int)
- **getString(index)** (int) - Gets the string at the given index. (Returns: String)
- **getText()** - Returns all the strings as one big string.
- **indexOf()** (string) - Returns the index of the specified string. Returns -1 if not found.
- **insert(index, string)** (int, string) - Inserts a string at a specific spot moving the items after it.
- **loadFromFile(filename)** (string) - Load the strings from a textfile.
- **remove(string)** (string) - Removes the given string from the list.
- **saveToFile(filename)** (string) - Save the strings to a textfile.
- **setString(index, string)** (int, string) - Replaces the string at the given index.
- **setText()** - Sets the strings of the given strings object to the given text (can be multiline).
```

--------------------------------

### POST /memscan/firstScan

Source: https://antumce.github.io/CE_LDoc/classes/MemScan

Initiates an initial memory scan with a wide range of customizable options. This method is fundamental for starting any memory analysis task using MemScan.

```APIDOC
## POST /memscan/firstScan

### Description
Performs an initial scan of memory. Allows detailed configuration of scan type, variable type, rounding, address ranges, and various other flags.

### Method
POST

### Endpoint
/memscan/firstScan

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **scanOption** (string) - Required - Defines the type of scan. Valid values: `soUnknownValue`, `soExactValue`, `soValueBetween`, `soBiggerThan`, `soSmallerThan`.
- **varType** (string) - Required - Defines the variable type. Valid values: `vtByte`, `vtWord`, `vtDword`, `vtQword`, `vtSingle`, `vtDouble`, `vtString`, `vtByteArray`, `vtGrouped`, `vtBinary`, `vtAll`.
- **roundingType** (string) - Optional - Defines how floating-point scans are handled. Valid values: `rtRounded`, `rtTruncated`, `rtExtremerounded`.
- **input1** (string) - Optional - The primary input value for the scan, dependent on `scanOption`.
- **input2** (string) - Optional - The secondary input value for the scan, dependent on `scanOption`.
- **startAddress** (string) - Optional - The starting address for the scan (defaults to 0).
- **stopAddress** (string) - Optional - The stopping address for the scan (defaults to 0xffffffffffffffff).
- **protectionFlags** (string) - Optional - Flags related to memory protection (refer to `aobscan` for details).
- **alignmentType** (string) - Optional - Scan alignment type. Valid values: `fsmNotAligned`, `fsmAligned`, `fsmLastDigits`.
- **alignmentParam** (string) - Optional - The parameter for alignment type.
- **isHexadecimalInput** (boolean) - Optional - If true, treats input fields as hexadecimal strings.
- **isNotABinaryString** (boolean) - Optional - If true and `varType` is `vtBinary`, treats input as decimal instead of binary.
- **isUnicodeScan** (boolean) - Optional - If true and `varType` is `vtString`, performs a Unicode (UTF-16) scan; otherwise, UTF-8.
- **isCaseSensitive** (boolean) - Optional - If true and `varType` is `vtString`, performs a case-sensitive scan.

### Request Example
```json
{
  "scanOption": "soExactValue",
  "varType": "vtDword",
  "input1": "12345",
  "startAddress": "0",
  "stopAddress": "0xffffffff"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "Scan initiated successfully."
}
```
```

--------------------------------

### Get Memory Record Offset Count

Source: https://antumce.github.io/CE_LDoc/classes/MemoryRecord

Returns the total number of offsets associated with the memory record. This indicates how many levels of indirection or relative accesses are configured.

```lua
getOffsetCount ()
```

--------------------------------

### Class StructureElement

Source: https://antumce.github.io/CE_LDoc/classes/StructureElement

Documentation for the StructureElement class, including its inheritance, properties, and methods.

```APIDOC
## Class `StructureElement`

### Inheritance
Object | StructureElement 🡄 Object

### Properties

**Bytesize** 
     The number of bytes of this element. Readonly for basic types, writable for types that require a defined length like strings and array of bytes.
### Type:
integer

**ChildStruct** 
     If not nil this element is a pointer to the structure defined here.
### Type:
Structure

**ChildStructStart** 
     The number of bytes inside the provided childstruct. (E.g: It might point to offset 10 of a certain structure)
### Type:
integer

**Name** 
     The name of this element.
### Type:
string

**Offset** 
     The offset of this element.
### Type:
integer

**Owner** 
     The structure this element belongs to. Readonly
### Type:
Structure

**Vartype** 
     The variable type of this element.
### Type:
integer

### Methods

**getBytesize ()** 
     Gets the bytesize of the element. Usually returns the size of the type, except for string and aob.

**getChildStruct ()** 
### Returns:
Structure

**getChildStructStart ()** 
    

**getName ()** 
     Returns the name of this element.
### Returns:
string

**getOffset ()** 
     Returns the offset of this element.
### Returns:
integer

**getOwnerStructure ()** 
     Returns the structure this element belongs to.

**getValue ( _address_ )** 
     Gets the memory from the specified address and interprets it according to the element type.

**getValueFromBase ( _baseaddress_ )** 
     Same as getValue but uses the offset to calculate the final address.

**getVartype ()** 
     Returns the variable type of this element.

**setBytesize ( _size_ )** 
     Sets the bytesize for types that are affected (string, aob).

**setChildStruct ( _structure_ )** 
    

**setChildStructStart ( _offset_ )** 
    

**setName ( _name_ )** 
     Sets the name of this element.

**setOffset ( _offset_ )** 
     Sets the offset of this element.

**setValue ( _address_ , _value_ )** 
     Sets the memory at the specified address to the interpreted value according to the element type.

**setValueFromBase ( _baseaddress_ , _value_ )** 
     Same as setValue but uses the offset to calculate the final address.

**setVartype ( _vartype_ )** 
    
```

--------------------------------

### ListView getItemIndex and setItemIndex Methods in Cheat Engine

Source: https://antumce.github.io/CE_LDoc/classes/Listview

These methods allow getting and setting the index of the currently selected item in the ListView. setItemIndex takes an integer index as a parameter.

```lua
local currentIndex = ListView.getItemIndex()
ListView.setItemIndex(5) -- Sets the selected item to the 6th item (index 5)
```

--------------------------------

### Class: Form

Source: https://antumce.github.io/CE_LDoc/classes/Form

Documentation for the Form class, including its inheritance, properties, methods, and creation.

```APIDOC
## Class `Form`

### Inheritance
ScrollingWinControl | Form 🡄 ScrollingWinControl 🡄 CustomControl 🡄 WinControl 🡄 Control 🡄 Component 🡄 Object

### Properties

**AllowDropFiles** 
Allows files to be dragged into the form.
### Type:
boolean

**FormState** 
The current state of the form.
Possible values: _fsCreating_ , _fsVisible_ , _fsShowing_ , _fsModal_ , _fsCreatedMDIChild_ , _fsBorderStyleChanged_ , _fsFormStyleChanged_ , _fsFirstShow_ , _fsDisableAutoSize_
### Type:
FormState string (ReadOnly)

**Menu** 
The main menu of the form.
### Type:
MainMenu

**ModalResult** 
The current ModalResult value of the form.
Note: When this value gets set the modal form will close
### Type:
integer

**OnClose** 
The function to call when the form gets closed.
### Type:
function(sender)

**OnDropFiles** 
Called when files are dragged on top of the form.
Filenames is an arraytable with the files.
### Type:
function(sender, {filenames})

### Methods 

**bringToFront ()** 
Brings the form to the foreground.

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

**close ()** 
Closes the form. Without an onClose this will be the same as hide.

**dragNow ()** 
Starts dragging the Form.
Call this on mousedown on any object if you wish that the mousemove will drag the whole Form arround. Useful for borderless windows (Dragging will stop when the mouse button is released).

**getBorderStyle ()** 

**getMenu ()** 
Returns the mainmenu object of this form.

**getOnClose ()** 
Returns the function.

**hide ()** 
Hide the form.

**isForegroundWindow ()** 
Returns true if the specified form has focus.

**printToRasterImage ( _rasterimage_ )** 
Draws the contents of the form to a rasterimage class object.

**setBorderStyle ( _borderstyle_ )** 
Sets the borderstyle of the window.

**setMenu ( _menu_ )** 

**setOnClose ( _function_ )** 
Return a CloseAction to determine how to close the window.

**show ()** 
Show the form.

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

### Creation 

**createForm ()** 
Creates a new Form.
```

--------------------------------

### Memo Class API

Source: https://antumce.github.io/CE_LDoc/classes/Memo

Documentation for the Memo class, including its inheritance, properties, methods, and creation.

```APIDOC
## Class `Memo`

### Description
A class representing a multi-line text editor control.

### Inheritance
Memo 🡄 Edit 🡄 WinControl 🡄 Control 🡄 Component 🡄 Object

### Properties

*   **Lines** (Strings) - Strings object for this memo.
*   **Scrollbars** (Scrollstyle) - Set the type of scrollbars to show. Possible values: ssNone, ssHorizontal, ssVertical, ssBoth, ssAutoHorizontal, ssAutoVertical, ssAutoBoth.
*   **WantReturns** (boolean) - Set if returns will send an event or not.
*   **WantTabs** (boolean) - Set if tabs will add a tab to the memo. False if tab will go to the next control.
*   **WordWrap** (boolean) - Set if words at the end of the control should go to the next line.

### Methods

*   **append** (_string_) - Appends a string to the memo.
*   **getLines** () - Returns a Strings class representing the lines in the memo.
*   **getScrollbars** () - Returns the current scrollbar setting.
*   **getWantReturns** () - Returns the value of the WantReturns property.
*   **getWantTabs** () - Returns the value of the WantTabs property.
*   **getWordWrap** () - Returns the value of the WordWrap property.
*   **setScrollbars** (_scrollbarenumtype_) - Sets the scrollbars. Horizontal only takes effect when wordwrap is disabled. Valid enum types: ssNone, ssHorizontal, ssVertical, ssBoth, ssAutoHorizontal, ssAutoVertical, ssAutoBoth.
*   **setWantReturns** (_wantreturns_ boolean) - Sets the WantReturns property.
*   **setWantTabs** (_wanttabs_ boolean) - Sets the WantTabs property.
*   **setWordWrap** (_wordwrap_ boolean) - Sets the WordWrap property.

### Creation

*   **createMemo** (_owner_ WinControl) - Creates a Memo class object which belongs to the given owner. Owner can be any object inherited from WinControl.
    
    ### Returns
    Memo
```

--------------------------------

### Get Memory Record Offset

Source: https://antumce.github.io/CE_LDoc/classes/MemoryRecord

Retrieves an offset value from the memory record at a specified index. Offsets are used for pointer arithmetic or accessing data relative to a base address.

```lua
getOffset ( _index_ )
```

--------------------------------

### Image Class API

Source: https://antumce.github.io/CE_LDoc/classes/Image

Documentation for the Image class, including its inheritance, properties, methods, and creation.

```APIDOC
## Class `Image`

### Description
Represents an image component that can display pictures and manage their rendering properties.

### Inheritance
GraphicControl | Image 🡄 GraphicControl 🡄 Control 🡄 Component 🡄 Object

### Properties
- **Canvas** (Canvas) - The canvas object to access the picture of the image.
- **Picture** (Picture) - The picture to render.
- **Stretch** (boolean) - Determines if the picture gets stretched when rendered in the image component.
- **Transparent** (boolean) - Determines if some parts of the picture are see through (usually based on the bottom-left corner).

### Methods
- **getCanvas ()**
- **getPicture ()** - Returns the Picture object of this image.
- **getStretch ()**
- **getTransparent ()**
- **loadImageFromFile (_filename_)**
- **setPicture (_picture_)**
- **setStretch (_stretch_)**
- **setTransparent (_transparent_)**

### Creation
- **createImage (_owner_)** - Creates an Image class object which belongs to the given owner. Owner can be any object inherited from WinControl.
  - **Parameters:**
    - owner (WinControl) - The owner of the image object.
  - **Returns:** Image
```

--------------------------------

### Get Memory Record Hotkey by ID

Source: https://antumce.github.io/CE_LDoc/classes/MemoryRecord

Retrieves a hotkey from the hotkey array of a memory record using its unique ID. This is useful for directly accessing a hotkey when its ID is known.

```lua
getHotkeyByID ( _id_ )
```

--------------------------------

### GenericHotkey Class Documentation

Source: https://antumce.github.io/CE_LDoc/classes/GenericHotkey

Documentation for the GenericHotkey class, including its inheritance, properties, methods, and creation function. This class is used for managing hotkeys within Cheat Engine.

```APIDOC
## Class `GenericHotkey`

### Inheritance
Object | GenericHotkey 🡄 Object

### Properties
- **DelayBetweenActivate** (integer) - Optional - Interval in milliseconds that determines the minimum time between hotkey activations. If 0, the global delay is used.
- **onHotkey** (function) - Optional - The function to call when the hotkey is pressed.

### Methods
- **getKeys ()**
- **getOnHotkey ()**
- **setKeys (_key_, _..._)**
  * Parameters:
    - key
    - ... (_optional_)
- **setOnHotkey (_table_)**
  * Parameters:
    - table

### Creation
- **createHotkey (_function_, _keys_, _..._)** - Returns an initialized GenericHotkey class object. Maximum of 5 keys.
  * Parameters:
    - function
    - keys
    - ... (_optional_)
```

--------------------------------

### MemScan: Saving and Loading Scan Results

Source: https://antumce.github.io/CE_LDoc/classes/MemScan

Enables saving the current scan results to a named file using saveCurrentResults(name). This allows the results to be reused later, for example, in subsequent nextScan operations.

```lua
memscan.saveCurrentResults("myScanResults")
```

--------------------------------

### Class Label Creation

Source: https://antumce.github.io/CE_LDoc/classes/Label

Documentation for creating a Label object in Cheat Engine.

```APIDOC
## POST /api/classes/Label/create

### Description
Creates a Label class object which belongs to the given owner. The owner can be any object inherited from WinControl.

### Method
POST

### Endpoint
/api/classes/Label/create

### Parameters
#### Query Parameters
- **owner** (WinControl) - Required - The owner object for the Label.

### Request Example
```json
{
  "owner": "<owner_object_id>"
}
```

### Response
#### Success Response (200)
- **label_id** (string) - The unique identifier for the created Label object.

#### Response Example
```json
{
  "label_id": "lbl_12345"
}
```
```

--------------------------------

### Class CollectionItem API

Source: https://antumce.github.io/CE_LDoc/classes/CollectionItem

Documentation for the CollectionItem class, including its inheritance, properties, and methods.

```APIDOC
## Class CollectionItem

Base class for some higher level classes. Often used for columns.

### Inheritance
Object | CollectionItem 🡄 Object

### Properties

- **DisplayName** (string)

- **ID** (integer)

- **Index** (integer) - The index in the array this item belong to.

### Methods

- **getDisplayName()** 
  ### Returns:
  string

- **getID()** 
  ### Returns:
  integer

- **getIndex()** 
  ### Returns:
  integer

- **setDisplayName()** 

- **setIndex()** 
```

--------------------------------

### TableFile Class API

Source: https://antumce.github.io/CE_LDoc/classes/TableFile

Documentation for the TableFile class, including its properties, methods, and creation functions.

```APIDOC
## Class `TableFile`

### Description
Represents a file within the Cheat Engine table, allowing for data manipulation and management.

### Inheritance
`TableFile` inherits from `Object`.

### Properties

*   **Stream** (`MemoryStream`) - The memory stream associated with the table file.

### Methods

*   **delete ( )**
    *   Description: Deletes this file from your table.
*   **getData ( )**
    *   Description: Gets a `MemoryStream` object representing the file's data.
    *   Returns: `MemoryStream`
*   **saveToFile ( filename )**
    *   Description: Saves the table file to a specified file.
    *   Parameters:
        *   `filename` (string) - The name of the file to save to.

### Creation

*   **createTableFile ( filename, filepath? )**
    *   Description: Adds a new file to your table. If no filepath is specified, it will create a blank file. Otherwise, it will read the contents from disk.
    *   Parameters:
        *   `filename` (string) - The name for the new table file.
        *   `filepath` (string, optional) - The path to an existing file to load content from.
    *   Returns: `TableFile`
*   **findTableFile ( filename )**
    *   Description: Returns the `TableFile` class object for the specified saved file.
    *   Parameters:
        *   `filename` (string) - The name of the table file to find.
```

--------------------------------

### Event Class Documentation

Source: https://antumce.github.io/CE_LDoc/classes/Event

Documentation for the Event class, including its methods and creation parameters.

```APIDOC
## Class `Event`

### Description
Represents an event object used for synchronization, allowing threads to signal each other.

### Inheritance
`Event` inherits from `Object`.

### Methods

#### `resetEvent()`

*   **Description**: Resets the event to its non-signaled state.
*   **Method**: None (called on an event object)

#### `setEvent()`

*   **Description**: Sets the event to its signaled state, potentially waking up waiting threads.
*   **Method**: None (called on an event object)

#### `waitFor(_timeout_)`

*   **Description**: Waits for the event to be set. It can return after a specified timeout or when the event is signaled.
*   **Method**: None (called on an event object)
*   **Parameters**:
    *   `_timeout_` (integer) - The maximum time to wait in milliseconds. A value of -1 indicates an infinite wait.
*   **Returns**:
    *   `integer` - Returns `wrSignaled` (0) if the event is signaled, `wrTimeout` (1) if the wait timed out, `wrAbandoned` (2) if the owning thread was abandoned, or `wrError` (3) if an error occurred.

### Creation

#### `createEvent(_ManualReset_, _InitialState_)`

*   **Description**: Creates a new event object.
*   **Method**: None (static method or constructor-like function)
*   **Parameters**:
    *   `_ManualReset_` (boolean) - If true, the event remains signaled until `resetEvent()` is called. If false, the event is automatically reset after a single waiting thread is released.
    *   `_InitialState_` (boolean) - If true, the event is created in the signaled state. If false, it is created in the non-signaled state.
*   **Returns**:
    *   `Event` - A new event object.
```

--------------------------------

### Addresslist Method: doDescriptionChange

Source: https://antumce.github.io/CE_LDoc/classes/Addresslist

Displays the GUI window to change the description of the selected entry. This method does not take any parameters.

```javascript
Addresslist.doDescriptionChange();
```

--------------------------------

### TrackBar Class API

Source: https://antumce.github.io/CE_LDoc/classes/TrackBar

Documentation for the TrackBar class, including its inheritance, properties, methods, and creation.

```APIDOC
## Class `TrackBar`

### Inheritance
WinControl | TrackBar 🡄 WinControl 🡄 Control 🡄 Component 🡄 Object

### Properties

**Max**
Maximum value for the trackbar.
### Type:
integer

**Min**
Minimal value for the trackbar.
### Type:
integer

**OnChange**
Function to call when the trackbar position changes.
### Type:
function

**Position**
The current position of the trackbar.
### Type:
integer

### Methods

**getMax ( )**
Gets the maximum value of the trackbar.
### Returns:
integer

**getMin ( _trackbar_ )**
Gets the minimum value of the trackbar.
### Parameters:
  * _trackbar_ (TrackBar) - The trackbar object.
### Returns:
integer

**getOnChange ( )**
Gets the OnChange event handler for the trackbar.
### Returns:
function

**getPosition ( _progressbar_ )**
Gets the current position of the trackbar.
### Parameters:
  * _progressbar_ (TrackBar) - The trackbar object.

**setMax ( _max_ )**
Sets the maximum value for the trackbar.
### Parameters:
  * _max_ (integer) - The maximum value.

**setMin ( _trackbar_ , _min_ )**
Sets the minimum value for the trackbar.
### Parameters:
  * _trackbar_ (TrackBar) - The trackbar object.
  * _min_ (integer) - The minimum value.

**setOnChange ( _onchange_ )**
Sets the OnChange event handler for the trackbar.
### Parameters:
  * _onchange_ (function) - The function to call when the position changes.

**setPosition ( _progressbar_ , _pos_ )**
Sets the current position of the trackbar.
### Parameters:
  * _progressbar_ (TrackBar) - The trackbar object.
  * _pos_ (integer) - The new position.

### Creation

**createTrackBar ( _owner_ )**
Creates a TrackBar class object which belongs to the given owner.
### Parameters:
  * _owner_ (WinControl) - The owner of the trackbar.
### Returns:
TrackBar
```

--------------------------------

### Addresslist Method: createMemoryRecord

Source: https://antumce.github.io/CE_LDoc/classes/Addresslist

Creates a generic cheat table entry and adds it to the list. This method does not take any parameters.

```javascript
Addresslist.createMemoryRecord();
```

--------------------------------

### Bitmap Class - Creation

Source: https://antumce.github.io/CE_LDoc/classes/Bitmap

Provides information on how to create a Bitmap object in Cheat Engine.

```APIDOC
## Bitmap Class - Creation

### Description
Creates a Bitmap object with specified dimensions.

### Method
createBitmap

### Parameters
#### Path Parameters
- _width_ (integer) - Required - The width of the bitmap.
- _height_ (integer) - Required - The height of the bitmap.

### Response
#### Success Response (200)
- Bitmap (object) - A newly created Bitmap object.

### Request Example
```json
{
  "method": "createBitmap",
  "parameters": {
    "_width_": 100,
    "_height_": 50
  }
}
```

### Response Example
```json
{
  "Bitmap": {
    "width": 100,
    "height": 50
  }
}
```
```

--------------------------------

### StringStream Class Documentation

Source: https://antumce.github.io/CE_LDoc/classes/StringStream

Documentation for the StringStream class, including inheritance, properties, and creation methods.

```APIDOC
## Class `StringStream`

### Inheritance
Stream | StringStream 🡄 Stream 🡄 Object

### Properties
- **DataString** (string) - The internal string.

### Creation
- **createStringStream** (_str_)
  - **Parameters**:
    - **str** (string) - The initial string for the stream.
  - **Returns**:
    - StringStream - A new instance of StringStream.
```

--------------------------------

### Treeview Class API

Source: https://antumce.github.io/CE_LDoc/classes/Treeview

Documentation for the Treeview class, including its inheritance, properties, methods, and creation.

```APIDOC
## Class `Treeview`

### Inheritance
CustomControl | TreeView 🡄 CustomControl 🡄 WinControl 🡄 Control 🡄 Component 🡄 Object

### Properties
- **Items** (TreeNodes) - The Treenodes object of the treeview (ReadOnly).
- **Selected** (TreeNode) - The currently selected treenode.

### Methods
- **beginUpdate ()**
- **endUpdate ()**
- **fullCollapse ()** - Collapses all the nodes, including the children's nodes.
- **fullExpand ()** - Expands all the nodes and all their children.
- **getItems ()** - Returns: TreeNodes
- **getSelected ()** - Returns: TreeNode
- **saveToFile (_filename_)** - Saves the contents of the treeview to disk.
  - Parameters:
    - filename (string)
- **setSelected ()**

### Creation
- **createTreeView (_owner_)**
  - Parameters:
    - owner
  - Returns: Treeview
```

--------------------------------

### Calendar Class API

Source: https://antumce.github.io/CE_LDoc/classes/Calendar

Documentation for the Calendar class, including its inheritance, properties, methods, and creation.

```APIDOC
## Class `Calendar`

### Description
Represents a calendar control providing date-related functionalities.

### Inheritance
`Calendar` inherits from `WinControl`, which in turn inherits from `Control`, `Component`, and `Object`.

### Properties

*   **Date** (string) - The current date of the Calendar. Format: `yyyy-mm-dd`.
*   **DateTime** (number) - Represents the number of days since December 30, 1899.

### Methods

*   **getDateLocalFormat ()** (string) - Returns the current date of the Calendar in the OS local short date format.

### Creation

*   **createCalendar (_owner_)** (Calendar) - Creates a `Calendar` class object belonging to the given owner. The owner must be an object inherited from `WinControl`. Valid dates are between "September 14, 1752" and "December 31, 9999".
    *   **Parameters**:
        *   `owner` (WinControl) - The owner of the Calendar object.
```

--------------------------------

### Addresslist Method: doTypeChange

Source: https://antumce.github.io/CE_LDoc/classes/Addresslist

Displays the GUI window to change the type of the selected entries. This method does not take any parameters.

```javascript
Addresslist.doTypeChange();
```