Introduction

A practical reference for the Adrenaline workspace and its current function surface.

These pages describe the functions that are available in the current build. Examples are intentionally short so you can test one thing at a time and see what the output tells you.

Use the reference responsibly

Only use the client in experiences and environments where you have permission to test. Follow the rules of the platform you are working with and do not use code you do not understand.

Installation

Download the client from the official site or official community server, then follow the setup prompts.

  1. Download the current build from an official Adrenaline link.
  2. Open the installer and finish the setup.
  3. Launch the client and enter your key.
Security note: Only download files linked from the official site or official community server. Never trust anyone who is not Adrenaline staff.

Closures

Inspect and work with Lua functions and closures.

  • checkcaller
  • clonefunction
  • getscriptclosure
  • hookfunction
  • iscclosure
  • islclosure
  • isexecutorclosure
  • newcclosure
  • getfunctionhash
  • restorefunction

Debug

Read and update the values exposed by a running Lua stack.

  • debug.getconstant
  • debug.getconstants
  • debug.getinfo
  • debug.getproto
  • debug.getprotos
  • debug.getstack
  • debug.getupvalue
  • debug.getupvalues
  • debug.setconstant
  • debug.setstack
  • debug.setupvalue

Filesystem

Read, write, and organize files in the client workspace.

  • readfile
  • writefile
  • appendfile
  • loadfile
  • isfile
  • delfile
  • makefolder
  • isfolder
  • delfolder
  • listfiles

Scripts

Find script objects and load or inspect their source.

  • getscriptbytecode
  • getscripthash
  • getscripts
  • getrunningscripts
  • getscriptfromthread
  • getcallingscript
  • getsenv
  • getloadedmodules
  • loadstring

Instances

Work with live instances and their event connections.

  • getinstances
  • getnilinstances
  • gethui
  • getconnections
  • getcallbackvalue
  • fireclickdetector
  • fireproximityprompt
  • firetouchinterest
  • firesignal
  • replicatesignal

Metatables

Inspect and update metatable behavior.

  • getrawmetatable
  • setrawmetatable
  • getnamecallmethod
  • hookmetamethod
  • isreadonly
  • setreadonly

Drawing

Create and update lightweight render objects.

  • Drawing.new
  • Drawing.Fonts
  • isrenderobj
  • getrenderproperty
  • setrenderproperty
  • cleardrawcache
  • getcustomasset

Environment

Access runtime state and identify the current executor context.

  • getrenv
  • getgenv
  • getgc
  • filtergc
  • getthreadidentity
  • setthreadidentity
  • identifyexecutor

Reflection

Read and update properties that are not exposed through the normal instance surface.

  • gethiddenproperty
  • sethiddenproperty
  • isscriptable
  • setscriptable

Cache

Check references and manage the instance cache.

  • cache.iscached
  • cache.invalidate
  • cache.replace
  • cloneref
  • compareinstances

Network & data

Make requests, open sockets, and encode or compress data.

  • request
  • WebSocket.connect
  • lz4compress
  • lz4decompress
  • base64_encode
  • base64_decode

Actors

Helpers for locating and working with actor containers used by parallel scripts.

  • getactors
  • getactor
  • run_on_actor

Console

Send readable output to the client console while testing.

  • rconsoleprint
  • rconsolewarn
  • rconsoleerr
  • rconsoleclear
  • rconsolename
  • rconsoleinput

Crypt

Hashing, encoding, and key helpers for scripts that need to handle data.

  • crypt.hash
  • crypt.encrypt
  • crypt.decrypt
  • crypt.generatekey
  • crypt.base64encode
  • crypt.base64decode

Encoding

Small helpers for moving between text, JSON, URL, and binary-friendly formats.

  • base64_encode
  • base64_decode
  • json_encode
  • json_decode
  • url_encode
  • url_decode

Input

Send controlled keyboard and mouse input from a test script.

  • keypress
  • keyrelease
  • mouse1press
  • mouse1release
  • mousemoverel
  • mousemoveabs
  • mouse2press
  • mouse2release

LuaStateProxy

Low-level access to the active Lua state. Use this section carefully and test changes in isolation.

  • getstate
  • pushvalue
  • popvalue
  • gettop
  • settop

Miscellaneous

Useful small helpers that do not need their own section.

  • setclipboard
  • getclipboard
  • gethwid
  • setfpscap
  • getfpscap
  • isnetworkowner

oth

A small collection of runtime and platform helpers used by existing scripts.

  • isrbxactive
  • setthreadidentity
  • getthreadidentity
  • queue_on_teleport
  • setsimulationradius

RakNet

Inspect supported networking objects while debugging authorized test environments.

  • getnetworkownershipauto
  • setnetworkownershipauto
  • gethiddenproperty
  • sethiddenproperty

Signals

Connect, inspect, and fire event signals from a script.

  • getconnections
  • firesignal
  • fireclickdetector
  • fireproximityprompt
  • firetouchinterest

WebSocket

Open a two-way connection for tools that need live messages.

  • WebSocket.connect
  • WebSocket.OnMessage
  • WebSocket.OnClose
  • WebSocket.Send
  • WebSocket.Close

Troubleshooting

Start with the simple checks first.

  • Restart the client and the experience.
  • Confirm you are using the current build.
  • Check that your key has not expired.
  • Look through official community announcements.

If the problem remains, send staff a clear description and the relevant output. Do not send your password or private key.

FAQ

A few quick answers.

Where should I download from?

Only use links from the official Adrenaline site or official community server. Never trust anyone who is not Adrenaline staff.

How long do the keys last?

The duration is shown on the plan and again before checkout. Keep the purchase email if you need support.

Where can I ask for help?

Join the official Discord server and include what you tried, what happened, and any useful output.