ClientAPI

A global API used to interact with the current Minecraft client
Most of its functions return things that can be found in the F3 menu

ClientAPI.getVersion

Example by ChloeSpacedOut:
log(client.getVersion()) 

Returns the Minecraft version of your client

overload 1:
                        
client.getVersion()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.getEntityStatistics

Example by ChloeSpacedOut:
log(client.getEntityStatistics())
-- Number of rendered entities / total entities, 0, simulation distance 

Returns a string containing information about the loaded entities on the client
This string appears in the F3 menu

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

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.isDebugOverlayEnabled

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.isDebugOverlayEnabled())
end) 

Returns true if the F3 screen is currently open

overload 1:
                        
client.isDebugOverlayEnabled()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

ClientAPI.getScaledWindowSize

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getScaledWindowSize())
end) 

Returns the size of the window in Minecraft's internal GUI units

overload 1:
                        
client.getScaledWindowSize()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2

Method Property	Fluent Description	Representation
Return Value	a Vector2	`Vector2`

ClientAPI.getFPSString

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getFPSString())
end) 

Gets the FPS string of the client, displayed in the F3 menu
Contains info on the fps, the fps limit, vsync, cloud types, and biome blend radius

overload 1:
                        
client.getFPSString()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.getParticleCount

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getParticleCount())
end) 

Returns the number of currently loaded particles

overload 1:
                        
client.getParticleCount()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.hasIris

figura.docs.client.has_iris

overload 1:
                        
client.hasIris()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

ClientAPI.getVersionType

Example by ChloeSpacedOut:
log(client.getVersionType()) 

figura.docs.client.get_version_type

overload 1:
                        
client.getVersionType()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.getChunkStatistics

Example by ChloeSpacedOut:
log(client.getChunkStatistics())
-- Number of chunk sections rendered / the total number of chunk sections in the loaded area 

Returns a string containing information about the player's chunk
This string appears in the F3 menu

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

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.getEntityCount

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getEntityCount())
end) 

Returns the number of currently loaded entities

overload 1:
                        
client.getEntityCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

ClientAPI.getCurrentEffect

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getCurrentEffect())
end) 

Returns the path to the currently applied shader, used when spectating an entity that has different vision than normal
Normally returns nil

overload 1:
                        
client.getCurrentEffect()  
 Method Property Fluent Description Representation
Return Value either a String or nil String | nil

Method Property	Fluent Description	Representation
Return Value	either a String or nil	`String \| nil`

ClientAPI.isPaused

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.isPaused())
end) 

Returns true if the client is paused

overload 1:
                        
client.isPaused()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

ClientAPI.getServerBrand

Example by ChloeSpacedOut:
log(client.getServerBrand()) 

Returns the type of server you're on
In singleplayer, this is "Integrated"

overload 1:
                        
client.getServerBrand()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.getFPS

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getFPS())
end) 

Gets the FPS of the client
Returns 0 if the fps counter isn't ready yet (or if your PC is just that bad)

overload 1:
                        
client.getFPS()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

ClientAPI.getSoundStatistics

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getSoundStatistics())
end)
-- sounds playing / sounds limit + ambient sounds playing / ambient sounds limit 

Returns a string containing information about the currently playing sounds on the client
This string appears in the F3 menu

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

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.getUsedMemory

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getUsedMemory())
end)
-- returns memory in bytes 

Returns the number of bytes of memory Minecraft is currently using

overload 1:
                        
client.getUsedMemory()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

ClientAPI.isWindowFocused

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.isWindowFocused())
end) 

Returns true if the Minecraft window is currently focused

overload 1:
                        
client.isWindowFocused()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

ClientAPI.getCameraRot

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getCameraRot())
end) 

Returns the rotation of the viewer's camera

overload 1:
                        
client.getCameraRot()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ClientAPI.getJavaVersion

Example by ChloeSpacedOut:
log(client.getJavaVersion()) 

Returns your current Java version you're playing Minecraft with

overload 1:
                        
client.getJavaVersion()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.getAllocatedMemory

Example by ChloeSpacedOut:
log(client.getAllocatedMemory())
-- returns memory in bytes 

Returns the maximum amount of memory that Minecraft could possibly use

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

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

ClientAPI.getGuiScale

Example by ChloeSpacedOut:
log(client.getGuiScale()) 

Returns the current value of your Gui Scale setting
If you use auto, then it gets the actual current scale

overload 1:
                        
client.getGuiScale()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

ClientAPI.getTextHeight

Example by ChloeSpacedOut:
log(client.getTextHeight('TEXT!')) 

Returns the height of the given text in pixels

overload 1:
                        
client.getTextHeight(text)  
 Method Property Fluent Description Representation
text accepts a String String 
   
Return Value an Integer Integer

Method Property	Fluent Description	Representation
text accepts	a String	`String`
Return Value	an Integer	`Integer`

ClientAPI.getMaxMemory

Example by ChloeSpacedOut:
log(client.getMaxMemory())
-- returns memory in bytes 

Returns the maximum amount of memory that Minecraft will try to use

overload 1:
                        
client.getMaxMemory()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

ClientAPI.getWindowSize

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getWindowSize())
end) 

Returns the size of the Minecraft window in pixels, as {width, height}

overload 1:
                        
client.getWindowSize()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2

Method Property	Fluent Description	Representation
Return Value	a Vector2	`Vector2`

ClientAPI.getCameraPos

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getCameraPos())
end) 

Returns the position of the viewer's camera

overload 1:
                        
client.getCameraPos()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ClientAPI.getFOV

Example by ChloeSpacedOut:
log(client.getFOV()) 

Returns the current FOV option of the client, not including additional effects such as speed or sprinting

overload 1:
                        
client.getFOV()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

ClientAPI.getMousePos

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getMousePos())
end) 

Returns the position of the mouse in pixels, relative to the top-left corner

overload 1:
                        
client.getMousePos()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2

Method Property	Fluent Description	Representation
Return Value	a Vector2	`Vector2`

ClientAPI.isHudEnabled

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.isHudEnabled())
end) 

Returns true if the hud is enabled (F1 disables the HUD)

overload 1:
                        
client.isHudEnabled()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

ClientAPI.getActiveLang

Example by ChloeSpacedOut:
log(client.getActiveLang()) 

Returns a string representation of the current game language

overload 1:
                        
client.getActiveLang()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.getSystemTime

Example by ChloeSpacedOut:
events.TICK:register(function()
  log(client.getSystemTime())
end) 

Returns the current system time in milliseconds

overload 1:
                        
client.getSystemTime()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

ClientAPI.getTextWidth

Example by ChloeSpacedOut:
log(client.getTextWidth('TEXT!')) 

Returns the width of the given text in pixels
In case of multiple lines, return the largest width of all lines

overload 1:
                        
client.getTextWidth(text)  
 Method Property Fluent Description Representation
text accepts a String String 
   
Return Value an Integer Integer

Method Property	Fluent Description	Representation
text accepts	a String	`String`
Return Value	an Integer	`Integer`

ClientAPI.getFiguraVersion

Gets the client Figura version

overload 1:
                        
client.getFiguraVersion()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ClientAPI.compareVersions

Compares two versions if they are less than (-1), equals (0) or greater than (1)

overload 1:
                        
client.compareVersions(version1, version2)  
 Method Property Fluent Description Representation
version1 accepts a String String 
   
version2 accepts a String String 
   
Return Value an Integer Integer

Method Property	Fluent Description	Representation
version1 accepts	a String	`String`
version2 accepts	a String	`String`
Return Value	an Integer	`Integer`

ClientAPI.hasIrisShader

figura.docs.client.has_iris_shader

overload 1:
                        
client.hasIrisShader()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Global Objects

Miscellaneous Types

Miscelanous

action_wheel

animations

nameplate

world

vanilla_model

models

player

events

keybind

vectors

matrices

sounds

pings

Miscellaneous Enums