Skip to content

Modules

load

Loads code from an external source. Must be outside of a function in the following format on a separate line.

java
load - "URL"

Example

Here is an example script hosted on Pastebin:

java
void onEnable() {
    client.print("enabled script!");
}

You can load it using the Pastebin raw link:

java
load - "https://pastebin.com/raw/93hWSJeN"

Alternatively, load from a local directory:

java
load - "file:///C:/Users/user/Desktop/script.txt"

INFO

The variable scriptName is a global value containing the current script name.

disable

Disables the specified module.

java
modules.disable(String moduleName);

enable

Enables the specified module.

java
modules.enable(String moduleName);

forceScaffoldMultiplace

Forces Scaffold to place multiple blocks per tick when true.

java
modules.forceScaffoldMultiplace(boolean enable);

getAimAssistTarget

Returns the current AimAssist target as an Entity or null if none.

java
Entity target = modules.getAimAssistTarget();

getBacktrackTarget

Returns the current Backtrack target as an Entity or null if none.

java
Entity target = modules.getBacktrackTarget();

getBedAuraPosition

Returns the BedAura target position as a Vec3, 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 or null if none.

java
Entity target = modules.getKillAuraTarget();

getLagRangeTarget

Returns the current Lag Range target as an Entity 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, 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);

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.

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

registerDescription

Registers a description displayed in the script options, only works onLoad.

java
modules.registerDescription(String description);

registerSlider

Registers a slider. Provide numeric bounds or an array of options, only works 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);