> For the complete documentation index, see [llms.txt](https://daikirai.gitbook.io/scripting/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://daikirai.gitbook.io/scripting/documentation/modules.md).

# modules

### disable

disables the specified module.

```java
modules.disable(String moduleName);
```

***

### enable

enables the specified module.

```java
modules.enable(String moduleName);
```

***

### getAimAssistTarget

returns the current AimAssist target as an [`Entity`](/scripting/documentation/entity.md) or `null` if none.

```java
Entity target = modules.getAimAssistTarget();
```

***

### getBacktrackTarget

returns the current Backtrack target as an [`Entity`](/scripting/documentation/entity.md) or `null` if none.

```java
Entity target = modules.getBacktrackTarget();
```

***

### getBedAuraPosition

returns the BedAura target position as a [`Vec3`](/scripting/documentation/vec3.md), or `null` when inactive.

```java
Vec3 target = modules.getBedAuraPosition();
```

***

### getBedAuraProgress

returns the current break progress of the targeted bed as `[modified, vanilla]`.

```java
float[] progress = modules.getBedAuraProgress();
```

***

### getButton

returns the value of a registered button setting.

```java
boolean value = modules.getButton(String moduleName, String name);
```

***

### getCategories

returns all module categories mapped to their module names.

```java
Map<String, List<String>> categories = modules.getCategories();
```

***

### getKillAuraTarget

returns the current KillAura target as an [`Entity`](/scripting/documentation/entity.md) or `null` if none.

```java
Entity target = modules.getKillAuraTarget();
```

***

### getLagRangeTarget

returns the current Lag Range target as an [`Entity`](/scripting/documentation/entity.md) or `null` if none.

```java
Entity target = modules.getLagRangeTarget();
```

***

### getSettings

returns every setting registered by the specified module.

```java
Map<String, Object> settings = modules.getSettings(String moduleName);
```

***

### getWhitelistedBedPos

returns the whitelisted bed position as a [`Vec3`](/scripting/documentation/vec3.md), or `null` if none. persists across worlds.

```java
Vec3 pos = modules.getWhitelistedBedPos();
```

***

### getSlider

returns the current value of a slider setting. string-array sliders return the selected index.

```java
double value = modules.getSlider(String moduleName, String name);
```

***

### getSliderString

returns the current string value of a slider setting. string-array sliders return the selected mode name.

```java
String str = modules.getSliderString(String moduleName, String name);
```

***

### getSliderMin

returns the minimum value of a slider setting.

```java
double min = modules.getSliderMin(String moduleName, String name);
```

***

### getSliderMax

returns the maximum value of a slider setting.

```java
double max = modules.getSliderMax(String moduleName, String name);
```

***

### getSliderInterval

returns the interval of a slider setting.

```java
double interval = modules.getSliderInterval(String moduleName, String name);
```

***

### isEnabled

returns `true` if the specified module is enabled.

```java
boolean enabled = modules.isEnabled(String moduleName);
```

***

### isHidden

returns `true` if the specified module is hidden.

```java
boolean hidden = modules.isHidden(String moduleName);
```

***

### isScaffolding

returns `true` when the Scaffold module is currently active.

```java
boolean scaffolding = modules.isScaffolding();
```

***

### isTowering

returns `true` when the Tower module is currently active.

```java
boolean towering = modules.isTowering();
```

***

### registerButton

registers a toggleable button with its default value, only works [`onLoad`](/scripting/documentation/events.md#onload).

```java
modules.registerButton(String name, boolean defaultValue);
```

***

### registerDescription

registers a description displayed in the script options, only works [`onLoad`](/scripting/documentation/events.md#onload).

```java
modules.registerDescription(String description);
```

***

### registerSlider

registers a slider. provide numeric bounds or an array of options, only works [`onLoad`](/scripting/documentation/events.md#onload).

```java
modules.registerSlider(String name, String suffix, double defaultValue, double min, double max, double interval);
modules.registerSlider(String name, String suffix, int defaultIndex, String[] values);
```

***

### setButton

updates the value of an existing button setting.

```java
modules.setButton(String moduleName, String name, boolean value);
```

***

### setSlider

updates the value of a slider setting.

```java
modules.setSlider(String moduleName, String name, double value);
```
