Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Athena home page

Getting Started

Introduction
Conventions

Environment

Environment
getgc
getgenv
getrenv
getreg
gettenv
getallthreads
filtergc

Closures

Closures
newcclosure
newlclosure
clonefunction
iscclosure
islclosure
isnewcclosure
isexecutorclosure
checkcaller
comparefunctions
getfunctionhash
getwrappedoriginal
hookfunction
restorefunction
isfunctionhooked
hookmetamethod
restoremetamethod
setstackhidden

Scripts

Scripts
getcallingscript
getrunningscripts
getscripts
getloadedmodules
getmodules
getsenv
getscriptclosure
getscriptbytecode
getfunctionbytecode
getscripthash
getscriptfromthread
getscriptthread
getnamecallmethod
setnamecallmethod
getthreadidentity
setthreadidentity
getthreadcapabilities
loadstring
decompile
require
isexecutorthread

Reflection

Reflection
gethiddenproperty
sethiddenproperty
getproperties
gethiddenproperties
isscriptable
setscriptable
getcallbackvalue
isnetworkowner
setsimulationradius
getbspval
getproximitypromptduration
setproximitypromptduration

Metatable

Metatable
getrawmetatable
setrawmetatable
isreadonly
iswritable
setreadonly
makereadonly
makewritable

Instances

Instances
cloneref
compareinstances
fireclickdetector
fireproximityprompt
firetouchinterest
gethui
getinstances
getnilinstances
getrendersteppedlist

Cache

Cache
cache.invalidate
cache.replace
cache.iscached
getinstancecache

Signals

Signals
getconnections
firesignal
replicatesignal
cansignalreplicate
getsignalwhitelist
getsignalarguments
getsignalargumentsinfo

Signal

Signal
Signal.new
Signal:Connect
Signal:Once
Signal:Wait
Signal:Fire
Signal:Destroy

Actors

Actors
getactors
getactorthreads
getdeletedactors
run_on_actor
run_on_thread
get_current_actor
isparallel
getactorstates
getgamestate
getluastate
create_comm_channel
get_comm_channel
on_actor_state_created

LuaStateProxy

LuaStateProxy
LuaStateProxy.Id
LuaStateProxy.IsActorState
LuaStateProxy.Event
LuaStateProxy:Execute
LuaStateProxy:GetActors

Console

Console
rconsolecreate
rconsoledestroy
rconsoleshow
rconsolehide
rconsolehidden
rconsoletoggle
rconsoleprint
rconsoleinfo
rconsolewarn
rconsoleerr
rconsolename
rconsoleclear
rconsoleinput

Input

Input
keypress
keyrelease
keyclick
mouse1click
mouse1press
mouse1release
mouse2click
mouse2press
mouse2release
mousemoveabs
mousemoverel
mousescroll
isrbxactive

Drawing

Drawing
Drawing.new
Drawing.Fonts
isrenderobj
getrenderproperty
setrenderproperty
cleardrawcache

Filesystem

Filesystem
readfile
writefile
appendfile
isfile
isfolder
makefolder
delfile
delfolder
listfiles
loadfile
dofile
getcustomasset

Encoding

Encoding
base64encode
base64decode
lz4compress
lz4decompress

Crypt

Crypt
crypt.hash
crypt.hmac
crypt.encrypt
crypt.decrypt
crypt.generatebytes
crypt.generatekey
crypt.random

HTTP

HTTP
request
httpget
getobjects

WebSocket

WebSocket
WebSocket.connect
WebSocket:Send
WebSocket:Close
WebSocket.OnMessage
WebSocket.OnClose

RakNet

RakNet
raknet.on_send
raknet.send
raknet.block
raknet.unblock
raknet.isblocked
raknet.is_enabled

Miscellaneous

Miscellaneous
identifyexecutor
getfflag
setfflag
getfflagtype
getfpscap
setfpscap
gethwid
get_process_identifier
setclipboard
messagebox
queueonteleport
clearqueueonteleport

oth

oth
oth.hook
oth.unhook
oth.is_hook_thread
oth.get_original_thread
oth.get_root_callback

Example
Related

Input

mouse2press

mouse2press.

mouse2press() -> ()

Holds the right mouse button down until mouse2release.

Example

mouse2press()

Related

mouse2release: release it.

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform