listFiles
action_wheel
Action
BlockRaycastTypes 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 
Compares two versions if they are less than (-1), equals (0) or greater than (1)
overload 1:
ClientAPI.compareVersions(version1: String, version2: String): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| version1 accepts | typings.-1808118735||
| version2 accepts | typings.-1808118735||
| Return Value | typings.-672261858
Generates a random UUID
overload 1:
ClientAPI.generateUUID(): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1901216868
Returns the current actionbar text, or nil if the action bar isn't visible
overload 1:
ClientAPI.getActionbar(): net.minecraft.class_2561 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.324440375
Returns a string representation of the current game language
overload 1:
ClientAPI.getActiveLang(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns a table with the active resource pack names
overload 1:
ClientAPI.getActiveResourcePacks(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Returns the maximum amount of memory that Minecraft could possibly use
overload 1:
ClientAPI.getAllocatedMemory(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns a TextureAtlasAPI object with information about the given atlas
Returns nil if the atlas was not found
overload 1:
ClientAPI.getAtlas(path: String): TextureAtlas | Method Property | Fluent Description | Representation |
|---|---|---|
| path accepts | typings.-1808118735||
| Return Value | typings.-1366832048
Returns a unit vector pointing in the direction that the camera is facing
overload 1:
ClientAPI.getCameraDir(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns the entity the camera is currently targeting, so returns the entity you are currently spectating, including yourself
overload 1:
ClientAPI.getCameraEntity(): EntityAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1263373079
Returns the position of the viewer's camera
overload 1:
ClientAPI.getCameraPos(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns the rotation of the viewer's camera
overload 1:
ClientAPI.getCameraRot(): Vector3 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444080
Returns a string containing information about the player's chunk
This string appears in the F3 menu
overload 1:
ClientAPI.getChunkStatistics(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the "version type" of your client, usually the client modloader brand
overload 1:
ClientAPI.getClientBrand(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the path to the currently applied shader, used when spectating an entity that has different vision than normal
Normally returns nil
overload 1:
ClientAPI.getCurrentEffect(): String | nil | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1209970754
Returns a table with information about the client's current time
overload 1:
ClientAPI.getDate(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Returns the number of currently loaded entities
overload 1:
ClientAPI.getEntityCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns a string containing information about the loaded entities on the client
This string appears in the F3 menu
overload 1:
ClientAPI.getEntityStatistics(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
No description available
figura.docs.client.getEnum
overload 1:
ClientAPI.getEnum(enumName: String): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| enumName accepts | typings.-1808118735||
| Return Value | typings.80563118
Returns the current FOV option of the client, not including additional effects such as speed or sprinting
overload 1:
ClientAPI.getFOV(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
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:
ClientAPI.getFPS(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
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:
ClientAPI.getFPSString(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the client Figura version
overload 1:
ClientAPI.getFiguraVersion(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the current fraction between the last tick and the next tick
This is the value used as "delta" in the RENDER event
overload 1:
ClientAPI.getFrameTime(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns the current value of your Gui Scale setting
If you use auto, then it gets the actual current scale
overload 1:
ClientAPI.getGuiScale(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Returns your current Java version you're playing Minecraft with
overload 1:
ClientAPI.getJavaVersion(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the maximum amount of memory that Minecraft will try to use
overload 1:
ClientAPI.getMaxMemory(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns the position of the mouse in pixels, relative to the top-left corner
overload 1:
ClientAPI.getMousePos(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Returns the number of currently loaded particles
overload 1:
ClientAPI.getParticleCount(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns a list of all values in the specified registry
See the `registries` enum for a list of valid registries
overload 1:
ClientAPI.getRegistry(registryName: String): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| registryName accepts | typings.-1808118735||
| Return Value | typings.80563118
Returns the size of the window in Minecraft's internal GUI units
overload 1:
ClientAPI.getScaledWindowSize(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Returns data about the current scoreboard(s). Multiple scoreboards can be visible at the same time (sidebar, team sidebar, list, and below name), so each scoreboard is grouped by its display location
overload 1:
ClientAPI.getScoreboard(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Returns the type of server you're on
In singleplayer, this is "Integrated"
overload 1:
ClientAPI.getServerBrand(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns a table with information on the currently connected server (also for singleplayer worlds)
overload 1:
ClientAPI.getServerData(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Returns a string with the current shader pack name, empty if none is being used.
overload 1:
ClientAPI.getShaderPackName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns a string containing information about the currently playing sounds on the client
This string appears in the F3 menu
overload 1:
ClientAPI.getSoundStatistics(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the current subtitle text, or nil if the title or subtitle isn't visible
overload 1:
ClientAPI.getSubtitle(): net.minecraft.class_2561 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.324440375
Returns the current system time in milliseconds
overload 1:
ClientAPI.getSystemTime(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns a table with the text shown in the tablist
overload 1:
ClientAPI.getTabList(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Returns the width and height of the given text, wrapping lines and trimming to a max width
overload 1:
ClientAPI.getTextDimensions(text: String): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.2002444079
overload 2:
ClientAPI.getTextDimensions(text: String, maxWidth: Integer, wrap: Boolean): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| maxWidth accepts | typings.-672261858||
| wrap accepts | typings.1729365000||
| Return Value | typings.2002444079
Returns the height of the given text in pixels
overload 1:
ClientAPI.getTextHeight(text: String): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-672261858
Returns the width of the given text in pixels
In case of multiple lines, return the largest width of all lines
overload 1:
ClientAPI.getTextWidth(text: String): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-672261858
Returns the current title text, or nil if the title isn't visible
overload 1:
ClientAPI.getTitle(): net.minecraft.class_2561 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.324440375
Returns the translated string of the given key
Translation is done using the current client language
Optionally takes a single argument, or a list with all arguments, that will populate the translation
overload 1:
ClientAPI.getTranslatedString(text: String): String | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1808118735
overload 2:
ClientAPI.getTranslatedString(text: String, args: AnyType): String | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| args accepts | typings.821772070||
| Return Value | typings.-1808118735
Returns the number of bytes of memory Minecraft is currently using
overload 1:
ClientAPI.getUsedMemory(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns the Minecraft version of your client
overload 1:
ClientAPI.getVersion(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the extended name of the Minecraft version of your client
overload 1:
ClientAPI.getVersionName(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the player entity from the running client
overload 1:
ClientAPI.getViewer(): ViewerAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.436394632
Returns the size of the Minecraft window in pixels, as {width, height}
overload 1:
ClientAPI.getWindowSize(): Vector2 | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.2002444079
Checks if the specific resource exists within the client resources
overload 1:
ClientAPI.hasResource(path: String): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| path accepts | typings.-1808118735||
| Return Value | typings.1729365000
Checks if the client is currently using a Shader Pack
overload 1:
ClientAPI.hasShaderPack(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the client has a Shader Pack mod installed
overload 1:
ClientAPI.hasShaderPackMod(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Converts an int array UUID (as 4 separated arguments) into its hexadecimal string representation
overload 1:
ClientAPI.intUUIDToString(a: Integer, b: Integer, c: Integer, d: Integer): String | Method Property | Fluent Description | Representation |
|---|---|---|
| a accepts | typings.-672261858||
| b accepts | typings.-672261858||
| c accepts | typings.-672261858||
| d accepts | typings.-672261858||
| Return Value | typings.-1808118735
Returns true if the F3 screen is currently open
overload 1:
ClientAPI.isDebugOverlayEnabled(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if the hud is enabled (F1 disables the HUD)
overload 1:
ClientAPI.isHudEnabled(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
No description available
figura.docs.client.is_integrated_server
overload 1:
ClientAPI.isIntegratedServer(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the client has loaded the given mod ID
overload 1:
ClientAPI.isModLoaded(modID: String): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| modID accepts | typings.-1808118735||
| Return Value | typings.1729365000
Returns true if the client is paused
overload 1:
ClientAPI.isPaused(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns if the client is running a snapshot or full release version
overload 1:
ClientAPI.isSnapshot(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if the Minecraft window is currently focused
overload 1:
ClientAPI.isWindowFocused(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns a list of all registered atlases paths
overload 1:
ClientAPI.listAtlases(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Converts a string UUID into its int array representation, returning a varargs of 4 ints
overload 1:
ClientAPI.uuidToIntArray(uuid: String): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| uuid accepts | typings.-1808118735||
| Return Value | typings.1901216868