Show everything
Made by applejuice

client
docs.globals.client
field signature:
client
Method Property Fluent Description Representation
Field Type a ClientAPI

ClientAPI.getVersion
Example by ChloeSpacedOut:
log(client.getVersion())
docs.clientapi.getversion
overload 1:
client.getVersion()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getFPS
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getFPS())
end)
docs.clientapi.getfps
overload 1:
client.getFPS()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getFPSString
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getFPSString())
end)
docs.clientapi.getfpsstring
overload 1:
client.getFPSString()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getVersionType
Example by ChloeSpacedOut:
log(client.getVersionType())
docs.clientapi.getversiontype
overload 1:
client.getVersionType()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getServerBrand
Example by ChloeSpacedOut:
log(client.getServerBrand())
docs.clientapi.getserverbrand
overload 1:
client.getServerBrand()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.isPaused
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isPaused())
end)
docs.clientapi.ispaused
overload 1:
client.isPaused()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getSystemTime
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getSystemTime())
end)
docs.clientapi.getsystemtime
overload 1:
client.getSystemTime()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getUsedMemory
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getUsedMemory())
end)
-- returns memory in bytes
docs.clientapi.getusedmemory
overload 1:
client.getUsedMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getMousePos
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getMousePos())
end)
docs.clientapi.getmousepos
overload 1:
client.getMousePos()
Method Property Fluent Description Representation
Return Value a Vector2

ClientAPI.getWindowSize
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getWindowSize())
end)
docs.clientapi.getwindowsize
overload 1:
client.getWindowSize()
Method Property Fluent Description Representation
Return Value a Vector2

ClientAPI.getEntityCount
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getEntityCount())
end)
docs.clientapi.getentitycount
overload 1:
client.getEntityCount()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getSoundStatistics
docs.clientapi.getsoundstatistics
overload 1:
client.getSoundStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getChunkStatistics
docs.clientapi.getchunkstatistics
overload 1:
client.getChunkStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getParticleCount
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getParticleCount())
end)
docs.clientapi.getparticlecount
overload 1:
client.getParticleCount()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getJavaVersion
Example by ChloeSpacedOut:
log(client.getJavaVersion())
docs.clientapi.getjavaversion
overload 1:
client.getJavaVersion()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getCurrentEffect
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getCurrentEffect())
end)
docs.clientapi.getcurrenteffect
overload 1:
client.getCurrentEffect()
Method Property Fluent Description Representation
Return Value either a String or nil

ClientAPI.isWindowFocused
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isWindowFocused())
end)
docs.clientapi.iswindowfocused
overload 1:
client.isWindowFocused()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.isHudEnabled
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isHudEnabled())
end)
docs.clientapi.ishudenabled
overload 1:
client.isHudEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getFOV
Example by ChloeSpacedOut:
log(client.getFOV())
docs.clientapi.getfov
overload 1:
client.getFOV()
Method Property Fluent Description Representation
Return Value a Number

ClientAPI.getMaxMemory
Example by ChloeSpacedOut:
log(client.getMaxMemory())
-- returns memory in bytes
docs.clientapi.getmaxmemory
overload 1:
client.getMaxMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getAllocatedMemory
docs.clientapi.getallocatedmemory
overload 1:
client.getAllocatedMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getTextWidth
Example by ChloeSpacedOut:
log(client.getTextWidth('TEXT!'))
docs.clientapi.gettextwidth
overload 1:
client.getTextWidth(text)
Method Property Fluent Description Representation
text accepts a String
Return Value an Integer

ClientAPI.getTextHeight
Example by ChloeSpacedOut:
log(client.getTextHeight('TEXT!'))
docs.clientapi.gettextheight
overload 1:
client.getTextHeight(text)
Method Property Fluent Description Representation
text accepts a String
Return Value an Integer

ClientAPI.getCameraPos
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getCameraPos())
end)
docs.clientapi.getcamerapos
overload 1:
client.getCameraPos()
Method Property Fluent Description Representation
Return Value a Vector3

ClientAPI.getGuiScale
Example by ChloeSpacedOut:
log(client.getGuiScale())
docs.clientapi.getguiscale
overload 1:
client.getGuiScale()
Method Property Fluent Description Representation
Return Value a Number

ClientAPI.getScreen
docs.clientapi.getscreen
overload 1:
client.getScreen()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getCameraRot
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getCameraRot())
end)
docs.clientapi.getcamerarot
overload 1:
client.getCameraRot()
Method Property Fluent Description Representation
Return Value a Vector3

ClientAPI.getEntityStatistics
docs.clientapi.getentitystatistics
overload 1:
client.getEntityStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.isDebugOverlayEnabled
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isDebugOverlayEnabled())
end)
docs.clientapi.isdebugoverlayenabled
overload 1:
client.isDebugOverlayEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getScaledWindowSize
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getScaledWindowSize())
end)
docs.clientapi.getscaledwindowsize
overload 1:
client.getScaledWindowSize()
Method Property Fluent Description Representation
Return Value a Vector2
a a