JsMacros

https://jsmacrosce.com
Admin
JsMacros is a Minecraft mod that allows users to create and execute JavaScript macros for...
Tokens:303,902
Snippets:994
Trust Score:1.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Server TPS (JsMacrosCE)

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/library/impl/FWorld

Provides the current server's TPS (Ticks Per Second). This method is a direct way to get the instant TPS value.

```javascript
const currentTPS = World.getServerTPS();
console.log('Current Server TPS:', currentTPS);
```

--------------------------------

### setOnInit

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/mixin/access/MixinScreen

Sets the action to be performed when the screen is initialized.

```APIDOC
## .setOnInit

### Description
Sets the action to be performed when the screen is initialized.

### Method
N/A

### Endpoint
.setOnInit(onInit)

### Parameters
- **onInit** (MethodWrapper<IScreen, Object, Object, ?>) -  

### Response
#### Success Response
- **IScreen** -  

```

--------------------------------

### ServiceListTopbar Constructors and Methods

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/gui/containers/ServiceListTopbar

Details on how to initialize and use the ServiceListTopbar, including its constructor parameters and available methods.

```APIDOC
## ServiceListTopbar

### Description
Represents the top bar for the service list screen in JsMacrosCE.

### Constructors
#### new ServiceListTopbar(parent, x, y, width, height, textRenderer)

##### Parameters
- **parent** (ServiceScreen) - The parent container.
- **x** (int) - The x-coordinate of the top-left corner.
- **y** (int) - The y-coordinate of the top-left corner.
- **width** (int) - The width of the container.
- **height** (int) - The height of the container.
- **textRenderer** (Font) - The font renderer for text.

### Methods
#### init()
Initializes the ServiceListTopbar.

##### Returns:
void

#### render(drawContext, mouseX, mouseY, delta)
Renders the ServiceListTopbar.

##### Parameters:
- **drawContext** (GuiGraphics) - The drawing context.
- **mouseX** (int) - The current mouse x-coordinate.
- **mouseY** (int) - The current mouse y-coordinate.
- **delta** (float) - The time delta since the last frame.

##### Returns:
void
```

--------------------------------

### Get Raw Keycode Class - JsMacrosCE

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/library/impl/FKeyBind

Gets the raw Minecraft keycode class for a given key name. This method is intended for internal use and users are advised not to use it directly.

```java
InputConstants$Key getKeyCode(String keyName)
```

--------------------------------

### JsMacrosCE WorldScannerBuilder: String Block Filter Example

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/worldscanner/WorldScannerBuilder

This example demonstrates how to use the WorldScannerBuilder to create a string block filter. It shows how to append filters using 'or' to match blocks containing 'stone' or 'diorit' in their names.

```javascript
WorldScannerBuilder.withStringBlockFilter().contains("stone")
     .orStringBlockFilter().contains("diorit")
```

--------------------------------

### Prism_kotlin Constructor and Create Method

Source: https://jsmacrosce.com/2.0.0-beta.5/io/noties/prism4j/languages/Prism_kotlin

Provides details on how to create an instance of the Prism_kotlin language grammar and how to use the static create method.

```APIDOC
## Prism_kotlin Language

### Description
This section details the Prism_kotlin language grammar for Prism4j, including its constructor and static creation method.

### Method
#### Constructor
```java
new Prism_kotlin()
```

#### Static Method
##### `create(prism4j)`
Creates a new instance of the Prism4j grammar for Kotlin.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Prism4j$Grammar** (object) - The Prism4j grammar object for Kotlin.

#### Response Example
```json
{
  "grammar": "Prism4j$Grammar"
}
```
```

--------------------------------

### KeyMacrosScreen Constructor

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/gui/screens/KeyMacrosScreen

Initializes a new instance of the KeyMacrosScreen class.

```APIDOC
## new KeyMacrosScreen(parent)

### Description
Initializes a new instance of the KeyMacrosScreen class.

### Method
CONSTRUCTOR

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "parent": "Screen"
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Get and Set Voice Volume in JsMacrosCE

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/OptionsHelper.MusicOptionsHelper

Allows getting the current voice volume and setting a new voice volume. getVoiceVolume() returns a float, and setVoiceVolume() takes a double for the new volume, returning the MusicOptionsHelper for chaining.

```java
OptionsHelper$MusicOptionsHelper musicOptions = new OptionsHelper$MusicOptionsHelper(optionsHelper);

// Get voice volume
float voiceVolume = musicOptions.getVoiceVolume();

// Set voice volume
musicOptions.setVoiceVolume(0.85);

```

--------------------------------

### Get and Set Player Volume in JsMacrosCE

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/OptionsHelper.MusicOptionsHelper

Provides methods to get the current player volume and set a new player volume. getPlayerVolume() returns a float, and setPlayerVolume() accepts a double for the new volume, returning the MusicOptionsHelper for chaining.

```java
OptionsHelper$MusicOptionsHelper musicOptions = new OptionsHelper$MusicOptionsHelper(optionsHelper);

// Get player volume
float playerVolume = musicOptions.getPlayerVolume();

// Set player volume
musicOptions.setPlayerVolume(0.75);

```

--------------------------------

### EventLaunchGame Constructor

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/event/impl/EventLaunchGame

Initializes a new instance of the EventLaunchGame class.

```APIDOC
## EventLaunchGame Constructor

### Description
Initializes a new instance of the EventLaunchGame class.

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "playerName": "examplePlayer"
}
```

### Response
#### Success Response (200)
An instance of EventLaunchGame.

#### Response Example
```json
{
  "playerName": "examplePlayer"
}
```
```

--------------------------------

### Get and Set Blocks Volume in JsMacrosCE

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/OptionsHelper.MusicOptionsHelper

Provides methods to get the current volume of block-related sounds and set a new volume. getBlocksVolume() returns a float, and setBlocksVolume() takes a double for the new volume, returning the MusicOptionsHelper for chaining.

```java
OptionsHelper$MusicOptionsHelper musicOptions = new OptionsHelper$MusicOptionsHelper(optionsHelper);

// Get blocks volume
float blocksVolume = musicOptions.getBlocksVolume();

// Set blocks volume
musicOptions.setBlocksVolume(0.6);

```

--------------------------------

### setOnFailInit

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/mixin/access/MixinScreen

Sets the action to be performed if the screen initialization fails.

```APIDOC
## .setOnFailInit

### Description
Sets the action to be performed if the screen initialization fails.

### Method
N/A

### Endpoint
.setOnFailInit(catchInit)

### Parameters
- **catchInit** (MethodWrapper<String, Object, Object, ?>) -  

### Response
#### Success Response
- **IScreen** -  

```

--------------------------------

### ConfigManager Constructors and Fields

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/core/config/ConfigManager

Details on how to instantiate ConfigManager and its available fields.

```APIDOC
## ConfigManager Class Documentation

### Description
Provides methods for managing configuration files, including loading, saving, and accessing options.

### Constructors
#### `new ConfigManager(runner, configFolder, macroFolder, logger)`

*   **runner** (`Core<?, ?>`) - The core runner instance.
*   **configFolder** (`File`) - The directory where configuration files are stored.
*   **macroFolder** (`File`) - The directory where macro files are stored.
*   **logger** (`Logger`) - The logger instance for this manager.

### Fields
#### `.optionClasses`
*   **Type**: `Map<String, Class<?>>`
*   **Description**: A map of option class names to their corresponding `Class` objects.
*   **Modifiers**: Final

#### `.options`
*   **Type**: `Map<Class<?>, Object>`
*   **Description**: A map storing instantiated options, keyed by their `Class`.
*   **Modifiers**: Final

#### `.configFolder`
*   **Type**: `File`
*   **Description**: The `File` object representing the configuration folder.
*   **Modifiers**: Final

#### `.macroFolder`
*   **Type**: `File`
*   **Description**: The `File` object representing the macro folder.
*   **Modifiers**: Final

#### `.configFile`
*   **Type**: `File`
*   **Description**: The `File` object representing the main configuration file.
*   **Modifiers**: Final

#### `.LOGGER`
*   **Type**: `Logger`
*   **Description**: The static logger instance for the ConfigManager.
*   **Modifiers**: Final

#### `.TARGET_VERSION`
*   **Type**: `int`
*   **Description**: The target version for the configuration file format.
*   **Modifiers**: Static, Final

#### `.rawOptions`
*   **Type**: `JsonObject`
*   **Description**: Holds the raw configuration data loaded from the file.

```

--------------------------------

### Get and Set Records Volume in JsMacrosCE

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/OptionsHelper.MusicOptionsHelper

Enables getting the current volume for played records and setting a new volume. The getRecordsVolume() returns a float, and setRecordsVolume() takes a double value for the new volume, returning the MusicOptionsHelper for chaining.

```java
OptionsHelper$MusicOptionsHelper musicOptions = new OptionsHelper$MusicOptionsHelper(optionsHelper);

// Get records volume
float recordsVolume = musicOptions.getRecordsVolume();

// Set records volume
musicOptions.setRecordsVolume(0.7);

```

--------------------------------

### ConfirmOverlay Constructors

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/wagyourgui/overlays/ConfirmOverlay

Provides details on how to create and initialize a ConfirmOverlay instance.

```APIDOC
## ConfirmOverlay Constructors

### Description
Constructors for creating `ConfirmOverlay` instances with different initialization options.

### Method
`new ConfirmOverlay(x, y, width, height, textRenderer, message, parent, accept)`

### Parameters
#### Path Parameters
- **x** (int) - Required - The x-coordinate of the overlay.
- **y** (int) - Required - The y-coordinate of the overlay.
- **width** (int) - Required - The width of the overlay.
- **height** (int) - Required - The height of the overlay.
- **textRenderer** (Font) - Required - The font renderer for text.
- **message** (Component) - Required - The message to display in the overlay.
- **parent** (IOverlayParent) - Required - The parent overlay interface.
- **accept** (Consumer<ConfirmOverlay>) - Required - Callback for accept action.

### Method
`new ConfirmOverlay(x, y, width, height, hcenter, textRenderer, message, parent, accept)`

### Parameters
#### Path Parameters
- **x** (int) - Required - The x-coordinate of the overlay.
- **y** (int) - Required - The y-coordinate of the overlay.
- **width** (int) - Required - The width of the overlay.
- **height** (int) - Required - The height of the overlay.
- **hcenter** (boolean) - Required - Whether to horizontally center content.
- **textRenderer** (Font) - Required - The font renderer for text.
- **message** (Component) - Required - The message to display in the overlay.
- **parent** (IOverlayParent) - Required - The parent overlay interface.
- **accept** (Consumer<ConfirmOverlay>) - Required - Callback for accept action.

### Response
#### Success Response (200)
- **ConfirmOverlay** (object) - A new instance of ConfirmOverlay.
```

--------------------------------

### Get and Set Neutral Mobs Volume in JsMacrosCE

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/OptionsHelper.MusicOptionsHelper

Allows getting the current volume of neutral mob sounds and setting a new volume. getNeutralVolume() returns a float, and setNeutralVolume() takes a double for the new volume, returning the MusicOptionsHelper for chaining.

```java
OptionsHelper$MusicOptionsHelper musicOptions = new OptionsHelper$MusicOptionsHelper(optionsHelper);

// Get neutral mobs volume
float neutralVolume = musicOptions.getNeutralVolume();

// Set neutral mobs volume
musicOptions.setNeutralVolume(0.3);

```

--------------------------------

### Initialize ExtensionLoader (Java)

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/core/extensions/ExtensionLoader

This snippet shows how to instantiate the ExtensionLoader class. It requires an instance of the Core class as a parameter.

```java
ExtensionLoader loader = new ExtensionLoader(core);
```

--------------------------------

### Get and Set Weather Volume in JsMacrosCE

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/OptionsHelper.MusicOptionsHelper

Allows for retrieving the current volume of weather-related sounds and setting a new volume. get به WeatherVolume() returns a float, and setWeatherVolume() accepts a double for the new volume, returning the MusicOptionsHelper for chaining.

```java
OptionsHelper$MusicOptionsHelper musicOptions = new OptionsHelper$MusicOptionsHelper(optionsHelper);

// Get weather volume
float weatherVolume = musicOptions.getWeatherVolume();

// Set weather volume
musicOptions.setWeatherVolume(0.4);

```

--------------------------------

### Get and Set Music Volume in JsMacrosCE

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/OptionsHelper.MusicOptionsHelper

Provides functionality to get the current music volume and set a new music volume. The getMusicVolume() method returns a float, while setMusicVolume() accepts a double and returns the MusicOptionsHelper instance for method chaining.

```java
OptionsHelper$MusicOptionsHelper musicOptions = new OptionsHelper$MusicOptionsHelper(optionsHelper);

// Get music volume
float musicVolume = musicOptions.getMusicVolume();

// Set music volume
musicOptions.setMusicVolume(0.5);

```

--------------------------------

### ClassWrapperTree Constructors

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/core/helper/ClassWrapperTree

Provides information on how to instantiate the ClassWrapperTree.

```APIDOC
## ClassWrapperTree Constructors

### new ClassWrapperTree(baseType, baseTypeWrapper)

#### Description
Initializes a new instance of the ClassWrapperTree.

#### Method
CONSTRUCTOR

#### Parameters
##### Path Parameters
- **baseType** (Class<K>) - Required - The base type for the tree.
- **baseTypeWrapper** (Function<K, V>) - Required - The function to wrap the base type.

##### Request Body
None

### Request Example
```javascript
// Example usage (conceptual)
const baseType = SomeClass;
const wrapperFunction = (instance) => new SomeWrapper(instance);
const classWrapperTree = new ClassWrapperTree(baseType, wrapperFunction);
```

#### Response
##### Success Response (200)
None (constructor)

##### Response Example
None
```

--------------------------------

### MixinItemCooldownEntry - Constructors and Methods

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/mixin/access/MixinItemCooldownEntry

This section details the constructors and methods available for the MixinItemCooldownEntry class, allowing access to item cooldown start and end times.

```APIDOC
## MixinItemCooldownEntry API

### Description
Provides access to item cooldown information within JsMacrosCE.

### Constructors
#### `new MixinItemCooldownEntry()`
Creates a new instance of MixinItemCooldownEntry.

### Methods
#### `.jsmacros_getStartTick()`
Retrieves the start tick of the item cooldown.

##### Returns:
- `int`: The tick at which the cooldown started.

#### `.jsmacros_getEndTick()`
Retrieves the end tick of the item cooldown.

##### Returns:
- `int`: The tick at which the cooldown will end.
```

--------------------------------

### ArrowEntityHelper Methods

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/world/entity/specialized/projectile/ArrowEntityHelper

Provides methods to get information about an arrow entity.

```APIDOC
## ArrowEntityHelper

### Description
Provides methods to retrieve specific properties of an arrow entity.

### Methods

#### .getColor()

##### Description
Gets the color of the arrow's particles.

##### Returns:
- **int**: The particle's color of the arrow, or -1 if the arrow has no particles.

#### .isCritical()

##### Description
Checks if the arrow will deal critical damage.

##### Returns:
- **boolean**: `true` if the arrow will deal critical damage, `false` otherwise.

#### .getPiercingLevel()

##### Description
Gets the piercing level of the arrow. This is relevant if the arrow was fired from a crossbow with the piercing enchantment.

##### Returns:
- **int**: The piercing level of the arrow.
```

--------------------------------

### KeyMacrosScreen Methods

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/gui/screens/KeyMacrosScreen

Provides details on the methods available for the KeyMacrosScreen class, including init, keyReleased, and mouseReleased.

```APIDOC
## KeyMacrosScreen Methods

### Description
Provides details on the methods available for the KeyMacrosScreen class.

### Methods

#### .init()

##### Description
Initializes the KeyMacrosScreen.

##### Method
GET

##### Endpoint
N/A (Instance method)

##### Parameters
None

##### Request Example
None

##### Response
###### Success Response (200)
- **void**: Returns nothing.

##### Response Example
None

#### .keyReleased(keyEvent)

##### Description
Handles the event when a key is released.

##### Method
POST

##### Endpoint
N/A (Instance method)

##### Parameters

###### Path Parameters
None

###### Query Parameters
None

###### Request Body
- **keyEvent** (KeyEvent) - Description of the key event.

##### Request Example
```json
{
  "keyEvent": "KeyEvent"
}
```

##### Response
###### Success Response (200)
- **boolean**: Returns true if the event was handled, false otherwise.

##### Response Example
```json
{
  "handled": true
}
```

#### .mouseReleased(buttonEvent)

##### Description
Handles the event when a mouse button is released.

##### Method
POST

##### Endpoint
N/A (Instance method)

##### Parameters

###### Path Parameters
None

###### Query Parameters
None

###### Request Body
- **buttonEvent** (MouseButtonEvent) - Description of the mouse button event.

##### Request Example
```json
{
  "buttonEvent": "MouseButtonEvent"
}
```

##### Response
###### Success Response (200)
- **boolean**: Returns true if the event was handled, false otherwise.

##### Response Example
```json
{
  "handled": true
}
```
```

--------------------------------

### Get Painting IDs

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/RegistryHelper

Retrieves a list of all painting motive IDs.

```APIDOC
## GET /websites/jsmacrosce/paintingIds

### Description
Retrieves a list of all painting motive IDs.

### Method
GET

### Endpoint
/websites/jsmacrosce/paintingIds

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **ids** (List<String>) - A list of all painting motive ids.

#### Response Example
```json
[
  "minecraft:alban",
  "minecraft:aztec"
]
```
```

--------------------------------

### Draw2D Z-Index Management

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/render/Draw2D

Methods for setting and getting the Z-index of the Draw2D overlay.

```APIDOC
## Draw2D Z-Index Management

### Description
Methods for setting and getting the Z-index of the Draw2D overlay.

#### .setZIndex(zIndex)

##### Description
Sets the Z-index for the Draw2D overlay.

##### Method
`setZIndex`

##### Parameters
- **zIndex** (int) - Required - The Z-index value.

##### Returns
`void`

#### .getZIndex()

##### Description
Gets the current Z-index of the Draw2D overlay.

##### Method
`getZIndex`

##### Returns
`int` - The current Z-index value.
```

--------------------------------

### BlockDisplayEntityHelper Constructor

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/helper/world/entity/specialized/display/BlockDisplayEntityHelper

Initializes a new BlockDisplayEntityHelper instance.

```APIDOC
## new BlockDisplayEntityHelper(base)

### Description
Initializes a new BlockDisplayEntityHelper instance with the provided base display object.

### Method
CONSTRUCTOR

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **base** (Display$BlockDisplay) - Required - The base display object for the block entity.

### Request Example
```json
{
  "base": "<Display$BlockDisplay object>"
}
```

### Response
#### Success Response (200)
This constructor does not return a value.

#### Response Example
None
```

--------------------------------

### Surface Builder Methods

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/render/components3d/Surface.Builder

Methods for configuring surface properties and building the surface.

```APIDOC
## Surface Builder API

### Description
This section details the methods available for configuring and building a surface using the Surface Builder.

### Methods

#### `.size(width, height)`
Sets the width and height of the surface.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None
- **Parameters**:
  - `width` (double) - Required - the width of the surface
  - `height` (double) - Required - the height of the surface

### Returns
`Surface$Builder` - self for chaining.

#### `.minSubdivisions(minSubdivisions)`
Sets the minimum number of subdivisions for the surface.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None
- **Parameters**:
  - `minSubdivisions` (int) - Required - the minimum number of subdivisions

### Returns
`Surface$Builder` - self for chaining.

#### `.getMinSubdivisions()`
Retrieves the minimum number of subdivisions for the surface.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None

### Returns
`int` - the minimum number of subdivisions.

#### `.renderBack(renderBack)`
Determines whether the back of the surface should be rendered.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None
- **Parameters**:
  - `renderBack` (boolean) - Required - whether the back of the surface should be rendered or not

### Returns
`Surface$Builder` - self for chaining.

#### `.shouldRenderBack()`
Checks if the back of the surface is set to be rendered.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None

### Returns
`boolean` - `true` if the back of the surface should be rendered, `false` otherwise.

#### `.cull(cull)`
Enables or disables culling for the surface.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None
- **Parameters**:
  - `cull` (boolean) - Required - whether to enable culling or not

### Returns
`Surface$Builder` - self for chaining.

#### `.isCulled()`
Checks if culling is enabled for the surface.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None

### Returns
`boolean` - `true` if culling is enabled for this box, `false` otherwise.

#### `.zIndex(zIndexScale)`
Sets the scale of the z-index for the surface.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None
- **Parameters**:
  - `zIndexScale` (double) - Required - the scale of the z-index

### Returns
`Surface$Builder` - self for chaining.

#### `.getZIndexScale()`
Retrieves the scale of the z-index for the surface.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None

### Returns
`double` - the scale of the z-index.

#### `.buildAndAdd()`
Creates the surface with the current configuration and adds it to the draw3D.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None

### Returns
`Surface` - the build surface.

#### `.build()`
Builds the surface from the current configuration without adding it to the draw3D.

- **Method**: N/A (Instance method)
- **Endpoint**: N/A
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**: None

### Returns
`Surface` - the build surface.
```

--------------------------------

### Surface Setters and Getters

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/render/components3d/Surface

Methods for setting and getting properties of a Surface object.

```APIDOC
## Surface Properties

### Description
Methods for setting and getting various properties of a Surface object, including position, rotation, size, and entity binding.

### Methods

#### `setPos(pos: Pos3D | BlockPosHelper)`
Sets the position of the surface.

- **pos** (Pos3D | BlockPosHelper) - The new position for the surface.
- **Returns**: `Surface` - Self for chaining.

#### `setPos(x: double, y: double, z: double)`
Sets the position of the surface using individual coordinates.

- **x** (double) - The new x-coordinate.
- **y** (double) - The new y-coordinate.
- **z** (double) - The new z-coordinate.
- **Returns**: `Surface` - Self for chaining.

#### `bindToEntity(boundEntity: EntityHelper<*>)`
Binds the surface to an entity, causing it to move with the entity at the specified offset.

- **boundEntity** (EntityHelper<*>) - The entity to bind the surface to.
- **Returns**: `Surface` - Self for chaining.

#### `getBoundEntity(): EntityHelper<*>`
Gets the entity the surface is currently bound to.

- **Returns**: `EntityHelper<*>` - The bound entity, or `null` if not bound.

#### `setBoundOffset(boundOffset: Pos3D)`
Sets the offset from the entity's position where the surface should be rendered.

- **boundOffset** (Pos3D) - The offset position.
- **Returns**: `Surface` - Self for chaining.

#### `setBoundOffset(x: double, y: double, z: double)`
Sets the offset from the entity's position using individual coordinates.

- **x** (double) - The x-offset.
- **y** (double) - The y-offset.
- **z** (double) - The z-offset.
- **Returns**: `Surface` - Self for chaining.

#### `getBoundOffset(): Pos3D`
Gets the current offset from the bound entity's position.

- **Returns**: `Pos3D` - The offset position.

#### `setRotateToPlayer(rotateToPlayer: boolean)`
Determines whether the surface should rotate to face the player.

- **rotateToPlayer** (boolean) - `true` to face the player, `false` otherwise.
- **Returns**: `Surface` - Self for chaining.

#### `doesRotateToPlayer(): boolean`
Checks if the surface is set to rotate to face the player.

- **Returns**: `boolean` - `true` if rotating to face the player, `false` otherwise.

#### `setRotations(x: double, y: double, z: double)`
Sets the rotation of the surface using Euler angles.

- **x** (double) - Rotation around the x-axis.
- **y** (double) - Rotation around the y-axis.
- **z** (double) - Rotation around the z-axis.
- **Returns**: `void`

#### `setSizes(x: double, y: double)`
Sets the size of the surface.

- **x** (double) - The width of the surface.
- **y** (double) - The height of the surface.
- **Returns**: `void`

#### `getSizes(): Pos2D`
Gets the current size of the surface.

- **Returns**: `Pos2D` - The size of the surface.

#### `setMinSubdivisions(minSubdivisions: int)`
Sets the minimum number of subdivisions for the surface.

- **minSubdivisions** (int) - The minimum subdivisions.
- **Returns**: `void`

#### `getMinSubdivisions(): int`
Gets the minimum number of subdivisions for the surface.

- **Returns**: `int` - The minimum subdivisions.

#### `getHeight(): int`
Gets the height of the surface.

- **Returns**: `int` - The height.

#### `getWidth(): int`
Gets the width of the surface.

- **Returns**: `int` - The width.

#### `setRotateCenter(rotateCenter: boolean)`
Determines whether the surface should rotate around its center.

- **rotateCenter** (boolean) - `true` to rotate around the center, `false` otherwise.
- **Returns**: `Surface` - Self for chaining.

#### `isRotatingCenter(): boolean`
Checks if the surface is set to rotate around its center.

- **Returns**: `boolean` - `true` if rotating around the center, `false` otherwise.

#### `init()`
Initializes the surface.

- **Returns**: `void`

#### `getZIndex(): int`
Gets the z-index of the surface.

- **Returns**: `int` - The z-index.

### Request Example
```json
{
  "pos": {"x": 1, "y": 2, "z": 3},
  "sizes": {"x": 2, "y": 2},
  "rotateToPlayer": true
}
```

### Response
#### Success Response (200)
- **void** - No specific return value for setters, `Pos3D`, `Pos2D`, `boolean`, or `int` for getters as described above.

#### Response Example
```json
{
  "message": "Surface properties updated"
}
```
```

--------------------------------

### Graphics Color Operations

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/CustomImage

Methods for getting and setting the current graphics color.

```APIDOC
## getGraphicsColor /websites/jsmacrosce

### Description
Retrieves the current RGB color used for drawing and fill operations.

### Method
`getGraphicsColor`

### Endpoint
N/A (Method within a graphics context)

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
* **int** - The current graphics RGB color.

#### Response Example
```json
{
  "color": 16711680 
}
```
```

```APIDOC
## setGraphicsColor /websites/jsmacrosce

### Description
Sets the RGB color to be used for subsequent drawing and fill operations.

### Method
`setGraphicsColor`

### Endpoint
N/A (Method within a graphics context)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **color** (int) - Required - The RGB color value to set.

### Request Example
```json
{
  "color": 16711680 
}
```

### Response
#### Success Response (200)
* **CustomImage** - Returns the current graphics context for chaining.
```

--------------------------------

### EventLaunchGame Methods

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/event/impl/EventLaunchGame

Details about the methods available in the EventLaunchGame class.

```APIDOC
## EventLaunchGame Methods

### Description
Details about the methods available in the EventLaunchGame class.

### Method
`toString()`

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **Returns** (String) - A string representation of the EventLaunchGame object.

#### Response Example
```json
{
  "toString": "EventLaunchGame{playerName='examplePlayer'}"
}
```
```

--------------------------------

### Surface Constructor

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/render/components3d/Surface

Initializes a new Surface object with specified properties.

```APIDOC
## Surface Constructor

### Description
Initializes a new Surface object with specified properties.

### Method
`new Surface(pos, rotations, sizes, minSubdivisions, renderBack, cull)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **pos** (Pos3D) - Description: The position of the surface.
- **rotations** (Pos3D) - Description: The rotations of the surface.
- **sizes** (Pos2D) - Description: The sizes of the surface.
- **minSubdivisions** (int) - Description: The minimum subdivisions for the surface.
- **renderBack** (boolean) - Description: Whether to render the back face of the surface.
- **cull** (boolean) - Description: Whether to cull the surface.

### Request Example
```json
{
  "pos": {"x": 0, "y": 0, "z": 0},
  "rotations": {"x": 0, "y": 0, "z": 0},
  "sizes": {"x": 1, "y": 1},
  "minSubdivisions": 1,
  "renderBack": false,
  "cull": true
}
```

### Response
#### Success Response (200)
- **Surface** (Surface) - The newly created Surface object.

#### Response Example
```json
{
  "message": "Surface created successfully"
}
```
```

--------------------------------

### Get Identifier

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/RegistryHelper

Retrieves the raw Minecraft Identifier for a given string representation.

```APIDOC
## GET /websites/jsmacrosce/getIdentifier

### Description
Retrieves the raw Minecraft Identifier for a given string representation.

### Method
GET

### Endpoint
/websites/jsmacrosce/getIdentifier

### Parameters
#### Query Parameters
- **identifier** (String) - Required - The String representation of the identifier, with the namespace and path.

### Request Example
```
GET /websites/jsmacrosce/getIdentifier?identifier=minecraft:dirt
```

### Response
#### Success Response (200)
- **resourceLocation** (ResourceLocation) - The raw Minecraft Identifier.

#### Response Example
```json
{
  "namespace": "minecraft",
  "path": "dirt"
}
```
```

--------------------------------

### Draw2D Initialization and Callbacks

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/render/Draw2D

Methods for setting initialization and failure callbacks for the Draw2D overlay.

```APIDOC
## Draw2D Initialization and Callbacks

### Description
Methods for setting initialization and failure callbacks for the Draw2D overlay.

#### .setOnInit(onInit)

##### Description
Sets an initialization function that is called when the window is resized or screen/draw2d is registered. Clears all previous elements when called.

##### Method
`setOnInit`

##### Parameters
- **onInit** (MethodWrapper<Draw2D, Object, Object, ?>) - Required - Calls your method as a Consumer<Draw2D>.

##### Returns
`Draw2D`

#### .setOnFailInit(catchInit)

##### Description
Sets a failure initialization function that is called with an error message if initialization fails.

##### Method
`setOnFailInit`

##### Parameters
- **catchInit** (MethodWrapper<String, Object, Object, ?>) - Required - Calls your method as a Consumer<String>.

##### Returns
`Draw2D`
```

--------------------------------

### Get Potion Type IDs

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/RegistryHelper

Retrieves a list of all potion type IDs.

```APIDOC
## GET /websites/jsmacrosce/potionTypeIds

### Description
Retrieves a list of all potion type IDs.

### Method
GET

### Endpoint
/websites/jsmacrosce/potionTypeIds

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **ids** (List<String>) - A list of all potion type ids.

#### Response Example
```json
[
  "minecraft:healing",
  "minecraft:swiftness"
]
```
```

--------------------------------

### MixinMinecraftClient Methods

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/mixin/events/MixinMinecraftClient

Documentation for the methods provided by the MixinMinecraftClient class, including parameters and return types.

```APIDOC
## MixinMinecraftClient Methods

### Description
Details the methods available for interacting with the MixinMinecraftClient.

### Methods
#### .setScreen(screen)

##### Description
Sets the current screen.

##### Method
Abstract

##### Parameters
- **screen** (Screen) - Required - The screen to set.

##### Returns
void

#### .onJoinWorld(world, ci)

##### Description
Callback executed when joining a world.

##### Method
Abstract

##### Parameters
- **world** (ClientLevel) - Required - The world being joined.
- **ci** (CallbackInfo) - Required - Callback information.

##### Returns
void

#### .onOpenScreen(newScreen, info)

##### Description
Callback executed when a new screen is opened.

##### Method
Abstract

##### Parameters
- **newScreen** (Screen) - Required - The new screen being opened.
- **info** (CallbackInfo) - Required - Callback information.

##### Returns
void

#### .afterOpenScreen(screen, info)

##### Description
Callback executed after a screen has been opened.

##### Method
Abstract

##### Parameters
- **screen** (Screen) - Required - The screen that was opened.
- **info** (CallbackInfo) - Required - Callback information.

##### Returns
void

#### .onDisconnect(nextScreen, transferring, ci)

##### Description
Callback executed upon disconnecting.

##### Method
Abstract

##### Parameters
- **nextScreen** (Screen) - Required - The screen to transition to after disconnecting.
- **transferring** (boolean) - Required - Indicates if a world transfer is in progress.
- **ci** (CallbackInfo) - Required - Callback information.

##### Returns
void

### Request Example
```java
MixinMinecraftClient client = new MixinMinecraftClient();
// Example for setScreen
Screen someScreen = new Screen(); // Replace with actual Screen object
client.setScreen(someScreen);

// Example for onJoinWorld (callbacks are typically handled internally)
// ClientLevel world = ...;
// CallbackInfo ci = ...;
// client.onJoinWorld(world, ci);
```

### Response
#### Success Response (200)
- **Method Execution**: The methods typically return void, indicating successful execution without a specific return value.

#### Response Example
```json
{
  "status": "success",
  "message": "Method executed successfully."
}
```
```

--------------------------------

### Get Entity Attribute IDs

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/RegistryHelper

Retrieves a list of all entity attribute IDs.

```APIDOC
## GET /websites/jsmacrosce/entityAttributeIds

### Description
Retrieves a list of all entity attribute IDs.

### Method
GET

### Endpoint
/websites/jsmacrosce/entityAttributeIds

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **ids** (List<String>) - A list of all entity attribute ids.

#### Response Example
```json
[
  "minecraft:generic.max_health",
  "minecraft:generic.movement_speed"
]
```
```

--------------------------------

### CoreConfigV2 Methods

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/core/config/CoreConfigV2

This section details the methods available in the CoreConfigV2 class, used for interacting with and managing the configuration.

```APIDOC
## CoreConfigV2 Methods

### Description
Provides methods to interact with and manage the JsMacrosCE configuration.

### Methods

#### .getCurrentProfile()
- **Description**: Retrieves the name of the currently active profile.
- **Returns**: `String` - The name of the current profile.

#### .setCurrentProfile(pname)
- **Description**: Sets the current profile to the one specified by `pname`.
- **Parameters**:
  - **pname** (`String`, Required) - The name of the profile to set as current.
- **Returns**: `void`

#### .profileOptions()
- **Description**: Retrieves a list of available profile names.
- **Returns**: `List<String>` - A list of profile names.

#### .getEvents()
- **Description**: Retrieves a list of all available event names.
- **Returns**: `List<String>` - A list of event names.

#### .fromV1(v1)
- **Description**: Converts configuration from a V1 format to the current V2 format. This method is deprecated.
- **Parameters**:
  - **v1** (`JsonObject`, Required) - The V1 configuration object to convert.
- **Returns**: `void`
```

--------------------------------

### Get Stat Type IDs

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/RegistryHelper

Retrieves a list of all stat type IDs.

```APIDOC
## GET /websites/jsmacrosce/statTypeIds

### Description
Retrieves a list of all stat type IDs.

### Method
GET

### Endpoint
/websites/jsmacrosce/statTypeIds

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **ids** (List<String>) - A list of all stat type ids.

#### Response Example
```json
[
  "minecraft:custom.time_since_death",
  "minecraft:deaths"
]
```
```

--------------------------------

### Get Villager Profession IDs

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/RegistryHelper

Retrieves a list of all villager profession IDs.

```APIDOC
## GET /websites/jsmacrosce/villagerProfessionIds

### Description
Retrieves a list of all villager profession IDs.

### Method
GET

### Endpoint
/websites/jsmacrosce/villagerProfessionIds

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **ids** (List<String>) - A list of all villager profession ids.

#### Response Example
```json
[
  "minecraft:librarian",
  "minecraft:farmer"
]
```
```

--------------------------------

### Load Extensions (Java)

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/core/extensions/ExtensionLoader

Initiates the loading process for all available extensions. This method typically runs once during application startup.

```java
loader.loadExtensions();
```

--------------------------------

### Get Villager Type IDs

Source: https://jsmacrosce.com/2.0.0-beta.5/com/jsmacrosce/jsmacros/client/api/classes/RegistryHelper

Retrieves a list of all villager type IDs.

```APIDOC
## GET /websites/jsmacrosce/villagerTypeIds

### Description
Retrieves a list of all villager type IDs.

### Method
GET

### Endpoint
/websites/jsmacrosce/villagerTypeIds

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **ids** (List<String>) - A list of all villager type ids.

#### Response Example
```json
[
  "minecraft:villager",
  "minecraft:wandering_trader"
]
```
```
Tokens:
Raw