GameGuardian Scripting Documentation

https://gameguardian.net/help
Admin
GameGuardian Scripting Documentation provides reference for classes and functions used to program...
Tokens:43,243
Snippets:135
Trust Score:9.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Get Target Process Information

Source: https://gameguardian.net/help/classgg

Fetches detailed information about the currently selected process. The returned table can include various fields like installation time, package name, version codes, activities, and memory information. This is useful for script compatibility checks or gathering game-specific data.

```lua
-- check for game version
local v = gg.getTargetInfo()
if v.versionCode ~= 291 then
print('This script only works with game version 291. You have game version ', v.versionCode, ' Please install version 291 and try again.')
os.exit()
end
```

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

### Process Information and Control

Source: https://gameguardian.net/help/classgg

Functions to get information about the target process, kill the process, and check for installed packages.

```APIDOC
## Get Target Info

### Description
Retrieves a table containing information about the selected target process.

### Method
mixed

### Endpoint
getTargetInfo()

### Parameters
None

### Response Example
```json
{
  "pid": 1234,
  "name": "com.example.game",
  "path": "/data/app/..."
}
```

## Get Target Package Name

### Description
Retrieves the package name of the selected target process.

### Method
mixed

### Endpoint
getTargetPackage()

### Parameters
None

### Response Example
```json
{
  "package_name": "com.example.game"
}
```

## Is Package Installed

### Description
Checks if a specified application package is installed on the system.

### Method
bool

### Endpoint
isPackageInstalled(string pkg)

### Parameters

#### Path Parameters
- **pkg** (string) - Required - The package name to check.

### Response Example
```json
{
  "is_installed": true
}
```

## Process Kill

### Description
Forcefully terminates the selected target process.

### Method
bool

### Endpoint
processKill()

### Parameters
None

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

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

### Check Package Installation (Lua)

Source: https://gameguardian.net/help/classgg

Determines if a specified application is installed on the system using its package name. It takes a single string argument representing the package name and returns a boolean value.

```Lua
print('Game installed:', gg.isPackageInstalled('com.blayzegames.iosfps'))
```

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

### getTargetPackage()

Source: https://gameguardian.net/help/classgg

Gets the package name of the selected process. Returns the package name as a string or nil.

```APIDOC
## getTargetPackage()

### Description
Get the package name of the selected process, if possible.

### Returns
- The package name of the selected process as string or `nil`.

### Example
`'com.blayzegames.iosfps'`

### See Also
- `getTargetInfo`
```

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

### Accessing GameGuardian String Version (Lua Example)

Source: https://gameguardian.net/help/classgg

Demonstrates how to access and print the string representation of the GameGuardian version using the `gg.VERSION` constant in Lua.

```lua
print("GG string version: "..gg.VERSION)
```

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

### Accessing GameGuardian Integer Version (Lua Example)

Source: https://gameguardian.net/help/classgg

Illustrates how to access and print the integer representation of the GameGuardian version using the `gg.VERSION_INT` constant in Lua.

```lua
print("GG numeric version: "..gg.VERSION_INT)
```

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

### Get Target Process Package Name

Source: https://gameguardian.net/help/classgg

Retrieves the package name of the currently selected process. This function is useful for identifying or verifying the target application. It returns the package name as a string or `nil` if the information is unavailable.

```lua
local packageName = gg.getTargetPackage()
if packageName then
  print('Target package: ', packageName)
else
  print('Could not retrieve target package name.')
end
```

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

### GameGuardian Script: Search and Replace Number

Source: https://gameguardian.net/help/simple_script

This Lua script demonstrates how to search for a specific DWORD value and then replace a specified number of its occurrences. It utilizes GameGuardian's API functions for searching and editing memory. This is a basic example suitable for simple modifications.

```lua
gg.searchNumber ('123', gg.TYPE_DWORD)
gg.getResults (100)
gg.editAll ('456', gg.TYPE_DWORD)
```

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

### Get Filtered Memory Regions List (Lua)

Source: https://gameguardian.net/help/classgg

Fetches a list of memory regions for the selected process, with an optional filter. The filter supports wildcards for flexible searching. It returns a table where each element contains details like state, start, end, type, name, and internalName.

```Lua
print(gg.getRangesList())
local t = gg.getRangesList()
print(t[1].start)
print(t[1]['end']) -- Using square-bracket notation for 'end' as it's a keyword in Lua
print(gg.getRangesList('libc.so'))
print(gg.getRangesList('lib*.so'))
print(gg.getRangesList('^/data/'))
print(gg.getRangesList('.so$'))
```

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

### Initiate Fuzzy Search with gg.startFuzzy

Source: https://gameguardian.net/help/classgg

The startFuzzy function initiates a fuzzy search with configurable parameters, including search type, memory range, and result limit. It returns true on success or an error string. Default parameters are used if none are provided.

```lua
gg.startFuzzy()
```

```lua
gg.startFuzzy(gg.TYPE_DWORD)
```

```lua
gg.startFuzzy(gg.TYPE_FLOAT)
```

```lua
gg.startFuzzy(gg.TYPE_BYTE, 0x9000, 0xA09000)
```

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

### getSpeed()

Source: https://gameguardian.net/help/classgg

Gets the current speed value from the speedhack feature. Returns the speed as a double.

```APIDOC
## getSpeed()

### Description
Get the current speed from the speedhack.

### Returns
- `double`: The current speed from the speedhack.

### See Also
- `setSpeed`
```

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

### gotoAddress()

Source: https://gameguardian.net/help/classgg

Navigates the memory editor to a specified memory address. Returns nil.

```APIDOC
## gotoAddress()

### Description
Go to the `address` in the memory editor.

### Parameters
- `address` (long) - Desired address.

### Returns
- `nil`
```

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

### getTargetInfo()

Source: https://gameguardian.net/help/classgg

Retrieves information about the currently selected process. Returns a table with process details or nil.

```APIDOC
## getTargetInfo()

### Description
Get a table with information about the selected process if possible. The set of fields can be different. Print the resulting table to see the available fields.

Possible fields: `firstInstallTime, lastUpdateTime, packageName, sharedUserId, sharedUserLabel, versionCode, versionName, activities (name, label), installer, enabledSetting, backupAgentName, className, dataDir, descriptionRes, flags, icon, labelRes, logo, manageSpaceActivityName, name, nativeLibraryDir, permission, processName, publicSourceDir, sourceDir, targetSdkVersion, taskAffinity, theme, uid, label, cmdLine, pid, x64, RSS.`
`cmdLine` - The contents of `/proc/pid/cmdline`. `pid` - PID of the process. `x64` - True if the 64-bit process. `RSS` - The amount of RSS memory for the process, in KB.
Read about PackageInfo and ApplicationInfo in `Android` for means each field.

### Returns
- Table with information about the selected process or `nil`.

### Examples
```lua
-- check for game version
local v = gg.getTargetInfo()
if v.versionCode ~= 291 then
  print('This script only works with game version 291. You have game version ', v.versionCode, ' Please install version 291 and try again.')
  os.exit()
end
```

### See Also
- `getTargetPackage`
```

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

### List all API methods in GameGuardian (Lua)

Source: https://gameguardian.net/help/index

This snippet demonstrates how to list all available methods within the 'gg' table in GameGuardian scripts. It utilizes the 'print' function to output the methods to the console, which can then be referenced in the 'gg' API documentation page for detailed explanations.

```lua
print(gg)
```

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

### Utility Functions

Source: https://gameguardian.net/help/classgg

Utility functions for text encoding, clipboard operations, version checking, variable saving, and script pausing.

```APIDOC
## Bytes Encoding

### Description
Gets the byte representation of a given text string in a specified encoding.

### Method
string

### Endpoint
bytes(string text, string encoding='UTF-8')

### Parameters

#### Path Parameters
- **text** (string) - Required - The input text string.
- **encoding** (string) - Optional - The desired character encoding. Defaults to 'UTF-8'.

### Response Example
```json
{
  "byte_string": "\x48\x65\x6c\x6c\x6f"
}
```

## Copy Text to Clipboard

### Description
Copies the specified text to the system clipboard.

### Method
nil

### Endpoint
copyText(string text, bool fixLocale=true)

### Parameters

#### Path Parameters
- **text** (string) - Required - The text to copy.
- **fixLocale** (bool) - Optional - Whether to fix locale issues. Defaults to true.

### Response Example
```json
null
```

## Require Version Check

### Description
Checks the version of GameGuardian. Optionally specify a version to check against.

### Method
nil

### Endpoint
require(string version=nil, int build=0)

### Parameters

#### Path Parameters
- **version** (string) - Optional - The version string to check against. Defaults to nil.
- **build** (int) - Optional - The build number to check against. Defaults to 0.

### Response Example
```json
{
  "is_compatible": true
}
```

## Save Variable

### Description
Saves a given variable to a file on disk.

### Method
mixed

### Endpoint
saveVariable(mixed variable, string filename)

### Parameters

#### Path Parameters
- **variable** (mixed) - Required - The variable to save.
- **filename** (string) - Required - The name of the file to save the variable to.

### Response Example
```json
{
  "file_path": "/sdcard/saved_variable.dat"
}
```

## Skip Restore State

### Description
Prevents GameGuardian from restoring its state after the script completes execution.

### Method
nil

### Endpoint
skipRestoreState()

### Parameters
None

### Response Example
```json
null
```

## Sleep

### Description
Pauses the execution of the currently running script for a specified number of milliseconds.

### Method
nil

### Endpoint
sleep(int milliseconds)

### Parameters

#### Path Parameters
- **milliseconds** (int) - Required - The duration in milliseconds to pause execution.

### Response Example
```json
null
```
```

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

### Get External Storage Path (Lua)

Source: https://gameguardian.net/help/classgg

EXT_STORAGE is a string variable representing the path to the primary shared/external storage directory. It can be used for accessing and writing files.

```lua
print("External storage: "..gg.EXT_STORAGE)
local file = io.open(gg.EXT_STORAGE.."/test_log.txt", "w")
file:write("This is log file")
file:close()
```

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

### Get GameGuardian Package Name (Lua)

Source: https://gameguardian.net/help/classgg

Retrieves the package name of the GameGuardian application. This is often used in contexts where the application needs to refer to itself or interact with system services that require the package identifier.

```lua
print("GG package: "..gg.PACKAGE)
```

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

### Get Process Pause State (Lua)

Source: https://gameguardian.net/help/classgg

Retrieves the current pause state of the selected process. This function takes no arguments and returns a boolean value: `true` if the process is paused, `false` otherwise.

```Lua
-- Example usage:
if gg.isProcessPaused() then
    print('Process is paused')
else
    print('Process is running')
end
```

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

### allocatePage()

Source: https://gameguardian.net/help/classgg

Allocates a new memory page (4 KB) within the target process. It allows specifying memory protection modes and an optional address hint.

```APIDOC
## allocatePage()

### Description
Allocates a memory page (4 KB) in the target process.

### Method
`gg.allocatePage(mode, address)`

### Parameters
#### Request Body
- **mode** (int) - Optional - Defaults to `gg.PROT_READ | gg.PROT_EXEC`. Bit mask of memory protection flags (e.g., `gg.PROT_READ`, `gg.PROT_WRITE`, `gg.PROT_EXEC`).
- **address** (long) - Optional - Defaults to `0`. A hint for where to place the page. On Android, the page will be allocated at a nearby address page boundary.

### Response
#### Success Response (Address)
- **Address** (mixed) - The starting address of the allocated memory page.

#### Error Response (String)
- **String** - An error message if the allocation failed.

### Request Example
```lua
-- Allocate with default permissions
print('allocatePage 1: ', string.format('0x%08x', gg.allocatePage()))

-- Allocate with read and execute permissions
print('allocatePage 2: ', string.format('0x%08x', gg.allocatePage(gg.PROT_READ | gg.PROT_EXEC)))

-- Allocate with read and write permissions
print('allocatePage 3: ', string.format('0x%08x', gg.allocatePage(gg.PROT_READ | gg.PROT_WRITE)))

-- Allocate with read permission only
print('allocatePage 4: ', string.format('0x%08x', gg.allocatePage(gg.PROT_READ)))

-- Allocate with read/write permissions and an address hint
print('allocatePage 5: ', string.format('0x%08x', gg.allocatePage(gg.PROT_READ | gg.PROT_WRITE, 0x12345)))
```
```

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

### Get External Files Directory Path (Lua)

Source: https://gameguardian.net/help/classgg

EXT_FILES_DIR is a string variable indicating the absolute path to the directory on the primary shared/external storage where GameGuardian can store persistent files. These files are visible to other apps.

```lua
print("External files dir: "..gg.EXT_FILES_DIR)
```

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

### Get Cache Directory Path (Lua)

Source: https://gameguardian.net/help/classgg

CACHE_DIR is a string variable that holds the absolute path to the GameGuardian specific cache directory on the filesystem. Files in this directory may be deleted by the system when storage is low.

```lua
print("Cache dir: "..gg.CACHE_DIR)
```

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

### Dialog and Toast Functions

Source: https://gameguardian.net/help/classgg

Functions to display various dialogs and toast messages to the user.

```APIDOC
## Show Toast

### Description
Displays a simple toast message on the screen.

### Method
nil

### Endpoint
toast(string text, bool fast=false)

### Parameters

#### Path Parameters
- **text** (string) - Required - The message to display in the toast.
- **fast** (bool) - Optional - Whether to show the toast in a faster, less prominent manner. Defaults to false.

### Response Example
```json
null
```

## Show Alert Dialog

### Description
Displays a dialog with configurable positive, negative, and neutral buttons.

### Method
int

### Endpoint
alert(string text, string positive='ok', string negative=nil, string neutral=nil)

### Parameters

#### Path Parameters
- **text** (string) - Required - The main message text for the dialog.
- **positive** (string) - Optional - The text for the positive action button. Defaults to 'ok'.
- **negative** (string) - Optional - The text for the negative action button. Defaults to nil.
- **neutral** (string) - Optional - The text for the neutral action button. Defaults to nil.

### Response Example
```json
{
  "button_pressed": "positive"
}
```

## Show Prompt Dialog

### Description
Displays a dialog for data entry, allowing multiple input fields.

### Method
mixed

### Endpoint
prompt(table prompts, table defaults={}, table types={})

### Parameters

#### Path Parameters
- **prompts** (table) - Required - A table defining the prompt fields (e.g., labels).
- **defaults** (table) - Optional - A table of default values for the prompt fields. Defaults to empty.
- **types** (table) - Optional - A table specifying the input types for each field. Defaults to empty.

### Response Example
```json
{
  "field1_value": "input data",
  "field2_value": 123
}
```

## Show Choice Dialog

### Description
Displays a dialog presenting a list of items for single selection.

### Method
mixed

### Endpoint
choice(table items, string selected=nil, string message=nil)

### Parameters

#### Path Parameters
- **items** (table) - Required - A list of items to display in the selection dialog.
- **selected** (string) - Optional - The initially selected item. Defaults to nil.
- **message** (string) - Optional - An optional message to display above the list. Defaults to nil.

### Response Example
```json
{
  "selected_item": "Option B"
}
```

## Show Multi-Choice Dialog

### Description
Displays a dialog allowing the user to select multiple items from a list.

### Method
mixed

### Endpoint
multiChoice(table items, table selection={}, string message=nil)

### Parameters

#### Path Parameters
- **items** (table) - Required - A list of items to display in the multi-choice dialog.
- **selection** (table) - Optional - A table of initially selected items. Defaults to empty.
- **message** (string) - Optional - An optional message to display above the list. Defaults to nil.

### Response Example
```json
{
  "selected_items": ["Option A", "Option C"]
}
```
```

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

### Get External Cache Directory Path (Lua)

Source: https://gameguardian.net/help/classgg

EXT_CACHE_DIR is a string variable representing the absolute path to the GameGuardian specific directory on the primary shared/external storage. This directory is used for cache files and is visible to other apps.

```lua
print("External cache dir: "..gg.EXT_CACHE_DIR)
```

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

### Perform HTTP/HTTPS GET/POST Requests with makeRequest()

Source: https://gameguardian.net/help/classgg

The makeRequest() function performs HTTP or HTTPS GET/POST requests. It accepts a URL, optional headers, and optional data for POST requests. The function returns a table with request details on success or a string with an error message on failure. HTTPS requests do not validate certificates. User permission for internet access is required.

```lua
mixed makeRequest  | ( | string  | _url_ ,   
---|---|---|---
|  | table  | _headers_ = `{}`,   
|  | string  | _data_ = `nil`  
| ) | | 

-- Example Usage:
-- Simple GET request
print('GET 1: ', gg.makeRequest('http://httpbin.org/headers').content)

-- GET request with headers
print('GET 2: ', gg.makeRequest('http://httpbin.org/headers', {['User-Agent']='My BOT'}).content)

-- GET request with multiple header values
print('GET 3: ', gg.makeRequest('http://httpbin.org/headers', {['User-Agent']={'My BOT', 'Tester'}}).content)

-- HTTPS GET request with headers
print('GET 4: ', gg.makeRequest('https://httpbin.org/get?param1=value2&param3=value4', {['User-Agent']='My BOT'}).content)

-- Simple POST request
print('POST 1: ', gg.makeRequest('http://httpbin.org/post', nil, 'post1=val2&post3=val4').content)

-- POST request with headers
print('POST 2: ', gg.makeRequest('http://httpbin.org/post', {['User-Agent']='My BOT'}, 'post1=val2&post3=val4').content)

-- POST request with multiple header values
print('POST 3: ', gg.makeRequest('http://httpbin.org/post', {['User-Agent']={'My BOT', 'Tester'}}, 'post1=val2&post3=val4').content)

-- HTTPS POST request with headers
print('POST 4: ', gg.makeRequest('https://httpbin.org/post?param1=value2&param3=value4', {['User-Agent']='My BOT'}, 'post1=val2&post3=val4').content)

-- Print full info about the request
print('FULL: ', gg.makeRequest('https://httpbin.org/headers'))
```

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

### Navigate to Address in Memory Editor

Source: https://gameguardian.net/help/classgg

Directs the user to a specific address within GameGuardian's memory editor. This function takes a long integer representing the desired memory address as input, facilitating quick navigation to specific memory locations.

```lua
gg.gotoAddress(0x12345678) -- Example: Go to address 0x12345678
```

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

### Search Functions

Source: https://gameguardian.net/help/classgg

Functions for performing various types of number and address searches within the target process's memory.

```APIDOC
## Search Number

### Description
Performs a search for a specific number value in the target process's memory, with various options for type, encryption, and range.

### Method
mixed

### Endpoint
searchNumber(string text, int type=gg.TYPE_AUTO, bool encrypted=false, int sign=gg.SIGN_EQUAL, long memoryFrom=0, long memoryTo=-1, long limit=0)

### Parameters

#### Path Parameters
- **text** (string) - Required - The number value to search for.
- **type** (int) - Optional - The data type of the number (e.g., gg.TYPE_INT, gg.TYPE_FLOAT). Defaults to gg.TYPE_AUTO.
- **encrypted** (bool) - Optional - Whether the value is encrypted. Defaults to false.
- **sign** (int) - Optional - The comparison sign (e.g., gg.SIGN_EQUAL, gg.SIGN_GREATER_THAN). Defaults to gg.SIGN_EQUAL.
- **memoryFrom** (long) - Optional - The starting address of the memory region to search. Defaults to 0.
- **memoryTo** (long) - Optional - The ending address of the memory region to search. Defaults to -1 (end of process).
- **limit** (long) - Optional - The maximum number of results to return. Defaults to 0 (no limit).

### Response Example
```json
{
  "found_addresses": ["0x12345678", "0xABCDEF01"]
}
```

## Refine Number Search

### Description
Refines a previous number search with the same parameters, narrowing down the results.

### Method
mixed

### Endpoint
refineNumber(string text, int type=gg.TYPE_AUTO, bool encrypted=false, int sign=gg.SIGN_EQUAL, long memoryFrom=0, long memoryTo=-1, long limit=0)

### Parameters

#### Path Parameters
- **text** (string) - Required - The number value to refine the search with.
- **type** (int) - Optional - The data type of the number. Defaults to gg.TYPE_AUTO.
- **encrypted** (bool) - Optional - Whether the value is encrypted. Defaults to false.
- **sign** (int) - Optional - The comparison sign. Defaults to gg.SIGN_EQUAL.
- **memoryFrom** (long) - Optional - The starting address of the memory region to search. Defaults to 0.
- **memoryTo** (long) - Optional - The ending address of the memory region to search. Defaults to -1.
- **limit** (long) - Optional - The maximum number of results to return. Defaults to 0.

### Response Example
```json
{
  "refined_addresses": ["0x12345678"]
}
```

## Start Fuzzy Search

### Description
Initiates a fuzzy search for memory values within a specified range and type.

### Method
mixed

### Endpoint
startFuzzy(int type=gg.TYPE_AUTO, long memoryFrom=0, long memoryTo=-1, long limit=0)

### Parameters

#### Path Parameters
- **type** (int) - Optional - The data type for the fuzzy search. Defaults to gg.TYPE_AUTO.
- **memoryFrom** (long) - Optional - The starting address of the memory region to search. Defaults to 0.
- **memoryTo** (long) - Optional - The ending address of the memory region to search. Defaults to -1.
- **limit** (long) - Optional - The maximum number of results to return. Defaults to 0.

### Response Example
```json
{
  "fuzzy_search_id": "xyz789"
}
```

## Search Fuzzy

### Description
Refines a fuzzy search based on a difference value and other parameters.

### Method
mixed

### Endpoint
searchFuzzy(string difference='0', int sign=gg.SIGN_FUZZY_EQUAL, int type=gg.TYPE_AUTO, long memoryFrom=0, long memoryTo=-1, long limit=0)

### Parameters

#### Path Parameters
- **difference** (string) - Optional - The difference value to use for refining the fuzzy search. Defaults to '0'.
- **sign** (int) - Optional - The fuzzy comparison sign. Defaults to gg.SIGN_FUZZY_EQUAL.
- **type** (int) - Optional - The data type for the fuzzy search. Defaults to gg.TYPE_AUTO.
- **memoryFrom** (long) - Optional - The starting address of the memory region to search. Defaults to 0.
- **memoryTo** (long) - Optional - The ending address of the memory region to search. Defaults to -1.
- **limit** (long) - Optional - The maximum number of results to return. Defaults to 0.

### Response Example
```json
{
  "fuzzy_results": ["0x11223344", "0x55667788"]
}
```

## Search Address

### Description
Performs a search for memory addresses based on a text pattern, with options for mask, type, and range.

### Method
mixed

### Endpoint
searchAddress(string text, long mask=-1, int type=gg.TYPE_AUTO, int sign=gg.SIGN_EQUAL, long memoryFrom=0, long memoryTo=-1, long limit=0)

### Parameters

#### Path Parameters
- **text** (string) - Required - The text pattern or address to search for.
- **mask** (long) - Optional - A bitmask to apply during the address comparison. Defaults to -1 (no mask).
- **type** (int) - Optional - The data type for the search. Defaults to gg.TYPE_AUTO.
- **sign** (int) - Optional - The comparison sign. Defaults to gg.SIGN_EQUAL.
- **memoryFrom** (long) - Optional - The starting address of the memory region to search. Defaults to 0.
- **memoryTo** (long) - Optional - The ending address of the memory region to search. Defaults to -1.
- **limit** (long) - Optional - The maximum number of results to return. Defaults to 0.

### Response Example
```json
{
  "found_addresses": ["0x1A2B3C4D"]
}
```

## Refine Address Search

### Description
Refines a previous address search with the same parameters.

### Method
mixed

### Endpoint
refineAddress(string text, long mask=-1, int type=gg.TYPE_AUTO, int sign=gg.SIGN_EQUAL, long memoryFrom=0, long memoryTo=-1, long limit=0)

### Parameters

#### Path Parameters
- **text** (string) - Required - The text pattern or address to refine the search with.
- **mask** (long) - Optional - A bitmask to apply during the address comparison. Defaults to -1.
- **type** (int) - Optional - The data type for the search. Defaults to gg.TYPE_AUTO.
- **sign** (int) - Optional - The comparison sign. Defaults to gg.SIGN_EQUAL.
- **memoryFrom** (long) - Optional - The starting address of the memory region to search. Defaults to 0.
- **memoryTo** (long) - Optional - The ending address of the memory region to search. Defaults to -1.
- **limit** (long) - Optional - The maximum number of results to return. Defaults to 0.

### Response Example
```json
{
  "refined_addresses": ["0x1A2B3C4D"]
}
```

## Search Pointer

### Description
Searches for values that may be pointers to elements within the current search results, specifying a maximum offset.

### Method
mixed

### Endpoint
searchPointer(int maxOffset, long memoryFrom=0, long memoryTo=-1, long limit=0)

### Parameters

#### Path Parameters
- **maxOffset** (int) - Required - The maximum offset to consider when searching for pointers.
- **memoryFrom** (long) - Optional - The starting address of the memory region to search. Defaults to 0.
- **memoryTo** (long) - Optional - The ending address of the memory region to search. Defaults to -1.
- **limit** (long) - Optional - The maximum number of results to return. Defaults to 0.

### Response Example
```json
{
  "pointer_addresses": ["0x98765432"]
}
```
```

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

### Get Speedhack Speed

Source: https://gameguardian.net/help/classgg

Retrieves the current speed value set by the speedhack feature in GameGuardian. This function is essential for monitoring or dynamically adjusting the game's speed. It returns a double representing the current speed.

```lua
local currentSpeed = gg.getSpeed()
print('Current speedhack speed: ', currentSpeed)
```

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

### Memory Manipulation Functions

Source: https://gameguardian.net/help/classgg

Functions for allocating memory pages, copying memory content, and dumping memory to files.

```APIDOC
## Allocate Memory Page

### Description
Allocates a memory page (4 KB) in the target process.

### Method
mixed

### Endpoint
allocatePage(int mode=gg.PROT_READ|gg.PROT_EXEC, long address=0)

### Parameters

#### Path Parameters
- **mode** (int) - Optional - Memory protection mode. Defaults to read and execute.
- **address** (long) - Optional - The desired memory address for allocation. Defaults to 0 (system decides).

### Response Example
```json
{
  "memory_page_address": "0x12345678"
}
```

## Copy Memory

### Description
Copies a specified number of bytes from one memory location to another within the target process.

### Method
mixed

### Endpoint
copyMemory(long from, long to, int bytes)

### Parameters

#### Path Parameters
- **from** (long) - Required - The source memory address.
- **to** (long) - Required - The destination memory address.
- **bytes** (int) - Required - The number of bytes to copy.

### Response Example
```json
{
  "bytes_copied": 1024
}
```

## Dump Memory

### Description
Dumps a range of memory from the target process to files on disk.

### Method
mixed

### Endpoint
dumpMemory(long from, long to, string dir, int flags=nil)

### Parameters

#### Path Parameters
- **from** (long) - Required - The starting memory address to dump.
- **to** (long) - Required - The ending memory address to dump.
- **dir** (string) - Required - The directory where the memory dump files will be saved.
- **flags** (int) - Optional - Flags to control the dumping process. Defaults to nil.

### Response Example
```json
{
  "files_created": [
    "memory_dump_part1.bin",
    "memory_dump_part2.bin"
  ]
}
```
```

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

### Get Memory Regions Bitmask (Lua)

Source: https://gameguardian.net/help/classgg

Retrieves memory regions as a bitmask of flags. This function is useful for understanding memory access permissions and types within the game's process. It has no parameters and returns an integer representing the bitmask.

```Lua
local regionsMask = gg.getRanges()
print(string.format("Memory regions mask: %x", regionsMask))
```

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

### GameGuardian API: Get Results Function

Source: https://gameguardian.net/help/simple_script

The `getResults` function is used to load the results of a previous search into GameGuardian's results list. It takes a maximum count parameter to limit the number of results loaded.

```lua
gg.getResults (int maxCount)
```

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

### Allocate memory page (Lua)

Source: https://gameguardian.net/help/classgg

Allocates a 4KB memory page in the target process. It accepts optional mode and address parameters to control memory protection and preferred allocation location. Returns the address of the allocated page or an error string.

```lua
print('allocatePage 1: ', string.format('0x%08x', gg.allocatePage()))
print('allocatePage 2: ', string.format('0x%08x', gg.allocatePage(gg.PROT_READ | gg.PROT_EXEC)))
print('allocatePage 3: ', string.format('0x%08x', gg.allocatePage(gg.PROT_READ | gg.PROT_WRITE)))
print('allocatePage 4: ', string.format('0x%08x', gg.allocatePage(gg.PROT_READ)))
print('allocatePage 5: ', string.format('0x%08x', gg.allocatePage(gg.PROT_READ | gg.PROT_WRITE, 0x12345)))
```

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

### Get Selected Memory Addresses (Lua)

Source: https://gameguardian.net/help/classgg

Returns a table containing the memory addresses that are currently selected in the memory editor. This function is useful for performing operations on specific, user-selected memory locations. It returns a table of addresses (long) or an error string.

```Lua
print('Selected: ', gg.getSelectedElements())
```

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

### searchAddress()

Source: https://gameguardian.net/help/classgg

Performs an address search in memory based on specified parameters. It can initiate a new search or refine an existing one. Use `clearResults` before a new search if needed.

```APIDOC
## POST /searchAddress

### Description
Performs an address search with the specified parameters. If the results list is empty, it performs a new search. Otherwise, it refines the existing search. To ensure a new search, call `clearResults` first.

### Method
POST

### Endpoint
/searchAddress

### Parameters
#### Query Parameters
- **_text_** (string) - Required - The search string. Format is similar to GameGuardian UI's search format, but requires English locale.
- **_mask_** (long) - Optional - The mask for the search. Defaults to `-1` (0xFFFFFFFFFFFFFFFF).
- **_type_** (int) - Optional - The data type to search for. Use `gg.TYPE_*` constants. Defaults to `gg.TYPE_AUTO`.
- **_sign_** (int) - Optional - The comparison sign. Use `gg.SIGN_EQUAL` or `gg.SIGN_NOT_EQUAL`. Defaults to `gg.SIGN_EQUAL`.
- **_memoryFrom_** (long) - Optional - The starting memory address for the search. Defaults to `0`.
- **_memoryTo_** (long) - Optional - The ending memory address for the search. Defaults to `-1`.
- **_limit_** (long) - Optional - The maximum number of results to find. `0` searches all results. Defaults to `0`.

### Request Body
(Not applicable for this function, parameters are passed as query parameters)

### Request Example
```lua
gg.searchAddress('A20', 0xFFFFFFFF)
gg.searchAddress('B20', 0xFF0, gg.TYPE_DWORD, gg.SIGN_NOT_EQUAL)
gg.searchAddress('0B?0', 0xFFF, gg.TYPE_FLOAT)
gg.searchAddress('??F??', 0xBA0, gg.TYPE_BYTE, gg.SIGN_NOT_EQUAL, 0x9000, 0xA09000)
-- To start a new search:
gg.clearResults()
gg.searchAddress('A20', 0xFFFFFFFF)
-- To refine an existing search:
gg.searchAddress('A20', 0xFFFFFFFF)
```

### Response
#### Success Response (200)
- **true** (boolean) - Indicates the search operation was successful.

#### Error Response (e.g., 400)
- **string** - A message describing the error that occurred during the search.

### Response Example
```json
true
```

### See Also
- `gg.clearResults`
- `gg.refineAddress`
```

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

### Get Search Results Count (Lua)

Source: https://gameguardian.net/help/classgg

Retrieves the total number of results found by a previous search operation. This is typically used after performing a search (e.g., with searchNumber) to know how many items matched the criteria. It returns a long integer representing the count.

```Lua
gg.searchNumber('10', gg.TYPE_DWORD)
print('Found: ', gg.getResultsCount())
```

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

### Dump Memory to Disk

Source: https://gameguardian.net/help/classgg

The dumpMemory function is used to save a specified range of memory to files on disk. It supports customizable start and end addresses, a directory for storage, and optional flags to control the dumping process. The function returns true on success or an error string.

```lua
gg.dumpMemory(0x9000, 0x9010, '/sdcard/dump')
gg.dumpMemory(0, -1, '/sdcard/dump')
gg.dumpMemory(0, -1, '/sdcard/dump', nil)
gg.dumpMemory(0, -1, '/sdcard/dump', 0)
gg.dumpMemory(0, -1, '/sdcard/dump', gg.DUMP_SKIP_SYSTEM_LIBS)
```

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

### Work with Unrandomizer (Lua)

Source: https://gameguardian.net/help/classgg

The unrandomizer function interacts with the Unrandomizer module, loading it if necessary. It accepts parameters for 'qword', 'qincr', 'double', and 'dincr', which can be set to nil to disable. The call is blocking and waits for the module to load.

```lua
print('unrandomizer:', gg.unrandomizer(0)) -- set only qword = 0
print('unrandomizer:', gg.unrandomizer(0, 1)) -- set only qword = 0 with increment = 1
print('unrandomizer:', gg.unrandomizer(nil, nil, 0.3)) -- set only double without increment
print('unrandomizer:', gg.unrandomizer(nil, nil, 0.3, 0.01)) -- set only double with increment
print('unrandomizer:', gg.unrandomizer(2, 3, 0.45, 0.67)) -- set both
print('unrandomizer:', gg.unrandomizer()) -- off
```

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

### Display Selection Dialog with Options (Lua)

Source: https://gameguardian.net/help/classgg

The `choice()` function presents a selection dialog to the user from a provided list of items. It allows setting a default selected item and an optional dialog title. It returns the index of the selected item or `nil` if canceled.

```lua
print('1: ', gg.choice({'A', 'B', 'C', 'D'}))
-- show list of 4 items
print('2: ', gg.choice({'A', 'B', 'C', 'D'}, 2))
-- show list of 4 items with selected 2 item
print('3: ', gg.choice({'A', 'B', 'C', 'D'}, 3, 'Select letter:'))
-- show list of 4 items with selected 3 item and message
print('4: ', gg.choice({'A', 'B', 'C', 'D'}, nil, 'Select letter:'))
-- show list of 4 items without selection and message
```

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

### Get Memory Regions by Value Table

Source: https://gameguardian.net/help/classgg

Obtains memory region codes for a provided table of values, which can be a list of addresses or tables with addresses. It returns a table mapping original keys to region codes or an error string. This function helps in analyzing memory layout and accessibility.

```lua
print('1: ', gg.getValuesRange({0x9000, 0x9010, 0x9020, 0x9030}))
-- table as a list of addresses
gg.searchNumber('10', gg.TYPE_DWORD)
local r = gg.getResults(5)
print('2: ', r, gg.getValuesRange(r))
```

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

### alert()

Source: https://gameguardian.net/help/classgg

Displays a dialog box with customizable buttons to the user. The function returns an integer indicating which button was pressed.

```APIDOC
## alert()

### Description
Displays a dialog with several buttons.

### Method
`gg.alert(text, positive, negative, neutral)`

### Parameters
#### Request Body
- **text** (string) - Required - The text message to display in the dialog.
- **positive** (string) - Optional - Defaults to 'ok'. The text for the positive button (returns 1).
- **negative** (string) - Optional - The text for the negative button (returns 2).
- **neutral** (string) - Optional - The text for the neutral button (returns 3).

### Response
#### Success Response (Integer)
- **0**: If the dialog was canceled (e.g., by the Back button).
- **1**: If the positive button was pressed.
- **2**: If the negative button was pressed.
- **3**: If the neutral button was pressed.

### Request Example
```lua
-- Show alert with single 'ok' button
gg.alert('Script ended')

-- Show alert with single 'Yes' button
gg.alert('Script ended', 'Yes')

-- Show alert with two buttons
gg.alert('A or C?', 'A', 'B')

-- Show alert with two buttons
gg.alert('A or C?', 'A', nil, 'C')

-- Show alert with three buttons
gg.alert('A or B or C?', 'A', 'B', 'C')
```

### See Also
- `toast`
- `choice`
- `multiChoice`
```
Tokens:
Raw