Enums§
Constants§
Functions§
- alloc_
mem - Allocates a memory chunk with size in bytes. Memory is guaranteed to be zero initialized
- free_
mem - Frees up the memory chunk allocated with AllocMem
- get_
cleo_ folder - Returns the absolute path to the CLEO directory
- get_
cleo_ version - Returns CLEO Redux version as a string
- get_cwd
- Returns the absolute path to the current working directory (normally the game directory)
- get_
directory_ path - Returns the absolute path to the CLEO root directory or one of its sub-directories
- get_
float_ param - Reads a floating-point argument
- get_
host_ id - Returns the current host (game) id
- get_
host_ name - Returns a host name The default value matches https://re.cleo.li/docs/en/api.html#host Can be changed with SetHostName
- get_
int_ param - Reads an integer argument (32 or 64 bit depending on target platform)
- get_
number_ of_ active_ cs_ scripts - Get number of active CS scripts
- get_
number_ of_ active_ js_ scripts - Get number of active JS scripts
- get_
sdk_ version - Returns the current SDK version as an integer number.
- get_
string_ param - Reads a string argument
- get_
symbol_ address - Returns a memory address for the given symbol, or 0 if not found
- is_
end_ of_ arguments - Is end of arguments reached
- log
- Prints a new entry to the cleo_redux.log
- on_
after_ scripts - Registers a new callback invoked on each main loop iteration (after scripts are executed)
- on_
before_ scripts - Registers a new callback invoked on each main loop iteration (before scripts are executed)
- on_
runtime_ init - Registers a new callback invoked on each runtime init event (new game, saved game load, or SDK’s RuntimeInit)
- on_
show_ text_ box - Registers a new callback invoked on a ShowTextBox function call. Providing a callback shadows built-in ShowTextBox implementation.
- register_
command - Registers a new callback handler for the command with the given name. Permission token is required for unsafe operations interacting with the user environment (e.g. mem, fs, net)
- register_
loader - Registers a new loader for files matching a glob pattern
- resolve_
path - Resolves a path to the absolute path - absolute path gets resolved as is
- runtime_
init - Initializes or reloads CLEO runtime
- runtime_
next_ tick - Iterates the main loop
- set_
float_ param - Writes the floating-point value
- set_
host_ name - Sets the new host name (accessible in scripts via the HOST constant)
- set_
int_ param - Writes the integer value (32 or 64 bit depending on target platform)
- set_
string_ param - Writes the string value
- to_
rust_ string - trigger_
event - Triggers an event with the given name and data
- update_
compare_ flag - Sets the status of the current condition