Kube Utils in FTB StoneBlock 4

Same as in the FTB Skies 2 1.22.0 guide

Kube Utils is a small addon for KubeJS. It doesn't add blocks, items or mobs for you to play with. It gives the people who write scripts for a pack extra helper functions so their code is shorter, faster and easier to read.^[1]

This pack includes Kube Utils 21.1.3. If you only play the pack, you'll never need to touch it directly.^[2]

Who it's for

Kube Utils is for anyone who writes or edits KubeJS scripts, such as pack makers or players tweaking their own setup. Everything it adds sits inside one global object called Ku, so the pieces are easy to find. Level helpers live under Ku.Level and fluid helpers under Ku.Fluids.^[1]

What it adds

• Level helpers: get the structures at a block position, spawn structures, find entities, clear spaces, and pick a random location inside a bounding box.^[1]
• Fluid helpers: list fluids by namespace and check whether a fluid is empty.^[1]
• List helpers: pick random entries from a weighted table.^[1]
• General utilities such as nullOrEmpty, which works the same way on items, blocks, item stacks, strings, fluids and item entities.^[1]

The developers say they aim to avoid breaking changes and to document everything in plain English. The project page also carries a disclaimer that code-breaking changes are possible while the mod is in beta. If you write scripts against it, check the official documentation first.^[1]

Where it fits in progression

It doesn't fit anywhere in your progression, because it's a scripting library and not gameplay content. You won't unlock it, craft it or need it to advance.^[1]

Unverified The available sources don't connect Kube Utils to any quest or to the ATM Star path, and they don't show any in-pack scripts that use it.

The mod is licensed under the GNU Lesser General Public License v3.0 only.^[1]

Same as in the FTB Skies 2 1.22.0 guide

Kube Utils is a bit different from most mods you'll meet in this pack. It's an addon for KubeJS that adds helper utilities for scripting, so there's no first item to craft and no machine to place down. Your first steps are about knowing what it offers when you write or read scripts.^[1]

What to know first

1. Remember that everything the mod adds lives in the global Ku object. Level helpers are reached through Ku.Level, and fluid helpers through Ku.Fluids.^[1]
2. Try the Level helpers when a script needs to work with the world. They can get structures at a block position, spawn structures, find entities, clear spaces and pick a random location within a bounding box.^[1]
3. Use the Fluids helpers when you need a list of fluids by namespace, or want to check whether a fluid is empty.^[1]
4. Use the list additions when you want a random entry picked from a weighted table.^[1]
5. Reach for nullOrEmpty as a simple check that works the same way on an item, block, itemstack, string, fluid or item entity.^[1]

Right now the mod only has a few helpers for some of the lesser supported areas of KubeJS, and the authors say they plan to expand them greatly over time. Its stated goals are a clear, concise and consistent API, and plain-English documentation for everything it adds.^[1]

Unverified I couldn't confirm any crafting recipes, items or quests tied to Kube Utils in this pack, so there is no recipe to show here. Which scripts in the pack actually use Ku is also unverified.

Same as in the FTB Skies 2 1.22.0 guide

Here's the thing you need to know first: Kube Utils doesn't add machines, multiblocks, power systems or item and fluid pipes. It's a helper addon for KubeJS, which means it's a toolbox for pack scripts rather than something you build in your world. So there's no machine setup or automation to learn from this mod.^[1]

How the mod is organised

Everything the mod adds lives inside a single global object called Ku. Each area gets its own namespace under it. Level helpers are reached through Ku.Level, and fluid helpers through Ku.Fluids. The aim is a clear, concise and consistent API.^[1]

What the helpers cover

• Level helpers: get the structures at a block position, spawn structures, find entities, clear spaces, and pick a random location inside a bounding box.^[1]
• Fluid helpers: get a list of fluids by namespace, and check whether a fluid is empty.^[1]
• List helpers: pick random entries from a weighted table.^[1]
• General utilities such as nullOrEmpty, a single way to check whether an item, block, item stack, string, fluid or item entity is null or empty.^[1]

The project describes the feature set as a few helpers for some of the lesser-supported areas of KubeJS, with plans to expand it over time.^[1]

Unverified Which scripts in this pack actually call Ku, and what they change in gameplay, can't be confirmed from the available sources. This pack has no config files for the mod and no recipes that produce its items.

FTB StoneBlock 4 1.21.0 ships Kube Utils 21.1.3, and the mod has been in the pack since FTB StoneBlock 4 1.0.0 or earlier. Here is what changed across the mod's own releases, newest first.^[3]

Mod changelog

• 21.1.3 (the version in this pack): fixed ListKu.getRandomWeightedEntry so it no longer breaks when given valid data.^[3][4]
• 21.1.2: fixed issues with KubeJS 7.2+.^[4]
• 21.1.1: added findFirstBlockTagWithinRadius, which finds a block within a radius that has a specific block tag.^[4][5]
• 21.1.1: added findAnyEntitiesWithinRadius and findLivingEntitiesWithinRadius, which find entities within a radius based on an entity type. The living version only covers living entities.^[4][5]
• 21.1.1: deprecated findEntitiesWithinRadius in favour of findLivingEntitiesWithinRadius.^[4][5]
• 21.1.0: updated the mod to 1.21.1, thanks to Saereth.^[4][5]