GAME_ID=> Returns the current game's CRC32 checksum as an integer. This checksum is generated from the process name at this moment.LUA_NAME=> The name of your Lua script, used by functions such as ConsolePrint. It is the filename of your Lua by default.SCRIPT_PATH=> Returns the path which Lua scripts are loaded from as a string. Ex:"C:\Users\Topaz\Desktop\LuaBackend\scripts"CHEATS_PATH=> Always returns"NOT_AVAILABLE"ENGINE_VERSION=> Returns the LuaBackend's engine version as a float. Ex:5ENGINE_TYPE=> Always returns"BACKEND"
Reads a certain value from Address. Returns the read value. If reading a String, length must also be declared.
The "XXXX" is a placeholder for the value type.
If Absolute is true, the address is taken as written and base address is not added into it.
List of types available: Byte, Short, Int, Long, Float, String, Boolean
Example:
local _tempInt = ReadInt(0xDEADB00) -- Read an integer from address BaseAddress+0xDEADB00
local _tempByte = ReadByte(0xB007555) -- Read a byte from address BaseAddress+0xB007555Writes Value to Address calculated relative to the base address. The "[XXXX]" is a placeholder for the value type.
If Absolute is true, the address is taken as written and base address is not added into it.
List of types available: Byte, Short, Int, Long, Float, String, Boolean
Example:
WriteShort(0xDEADB00, 0xFFFF) -- Write 0xFFFF to BaseAddress+0xDEADB00
WriteBoolean(0xB007555, true) -- Write true to BaseAddress+0xB007555Reads Length amount of bytes from memory, starting at Address. Returns the read bytes as an array.
If Absolute is true, the address is taken as written and base address is not added into it.
Example:
local _tempArray = ReadArray(0xBEEFDED, 0x10) -- Reads 16 bytes starting at BaseAddress+0xBEEFDEDWrites Array to the memory, starting at Address. The array must be made of bytes (8-bit integers).
If Absolute is true, the address is taken as written and base address is not added into it.
Example:
local _tempArray = { 0xFE, 0xA5, 0x70 }
WriteArray(0x6660420, _tempArray) -- Writes _tempArray to memory, starting at BaseAddress+0x6660420Calculates a pointer with the given values.
Basically, reads the value at Address and adds Offset to it. Returns the resulting value.
If Absolute is true, the address is taken as written and base address is not added into it.
Example:
local _tempPointer = GetPointer(0xBEEFDAD, 0x15) -- Reads the value at BaseAddress+0xBEEFDAD and adds 0x15 to it.Gets the frequency of which LuaBackend scripts execute.
Sets the Backend execution cycle to Frequency. The accepted values are 60, 120, and 240.
Shifts Base left by Shift abont of bytes. Only exists for 32-bit applications.
Example:
ULShift32(4294967295, 8) -- Shifts 4294967295 left by 8 bytes without an overflow to 64-bits.Prints Text to the console, in the format given below. Unless Type is declared, nothing will prefix the message.
Type can be the following:
- 0 = MESSAGE
- 1 = SUCCESS
- 2 = WARNING
- 3 = ERROR
Format:
[LUA_NAME] TYPE: Text
Example:
LUA_NAME = "SomeDudeScript"
ConsolePrint("GET UP ON THE HYDRA'S BACK!") -- Prints the following: [SomeDudeScript] GET UP ON THE HYDRA'S BACK!
ConsolePrint("NICE VIEW FROM UP HERE!", 0) -- Prints the following: [SomeDudeScript] MESSAGE: NICE VIEW FROM UP HERE!Initializes and hooks a Discord Application with ApplicationID, for Rich Presence control.
Example:
InitializeRPC("833511404274974740") -- Initiaizes Discord Application "833511404274974740".Updates the details of the rich presence application initialized with InitializeRPC to say Text.
Example:
UpdateDetails("Hello World!") -- Updates the details section of the RPC to say "Hello World!".Updates the state of the rich presence application initialized with InitializeRPC to say Text.
Example:
UpdateState("Hello World!") -- Updates the state section of the RPC to say "Hello World!".Updates the large image of the rich presence to be the image with Key. And it's text is updates to say Text.
Example:
UpdateLImage("image", "This is Image!") -- Updates the large image to "image" and it's text to "This is Image!"Updates the small image of the rich presence to be the image with Key. And it's text is updates to say Text.
Example:
UpdateSImage("imagetwo", "This too, is Image!") -- Updates the small image to "imagetwo" and it's text to "This too, is Image!"Writes the given byte array Value to Address relative to the current EXE's address, NOT the provided base address. This function is non-existent on PCSX2-EX.
Example:
WriteExec(0x00FBAAD, 0x15) -- Writes 0x15 to EXE_NAME.exe+0x00FBAAD.