Skip to main content

MxtAura: World Aura

MxtAura is how a script reads world aura, and the only way a script can write it: it adds a persistent cuboid area to the server, which is how "this place carries this aura from now on" is expressed. The area itself is defined by an aura_zone in the data pack; the script only places it.

Methods​

MethodParametersReturn valueDescription
get(level, pos)Level, BlockPosAuraResultReads the fully resolved multi-resource aura at that position. Read-only, and the client can query its locally available state.
addBox(level, zone, minX, minY, minZ, maxX, maxY, maxZ, priority)Server Level, a loaded aura zone ID, two block coordinates, integer prioritystringAdds a persistent cuboid area and returns the generated area ID.
remove(level, area)Server Level, the area ID returned by addBoxbooleanRemoves the matching persistent area.

addBox only accepts a ServerLevel, and zone must be a loaded aura_zone data pack ID; otherwise it throws an exception. The commonly used read-only methods of AuraResult are aura(), concentration(), maximum(), regenPerTick(), cultivationSpeed(), source(), sourceKind() and suppressCultivate().

// kubejs/server_scripts/mxt_aura.js
const aura = MxtAura.get(player.level(), player.blockPosition())
if (aura.suppressCultivate()) {
  console.info('cultivation is suppressed here')
}

const area = MxtAura.addBox(player.level(), 'example:fire_vein',
  -8, 60, -8, 8, 72, 8, 10)
// The area can be taken back at any later point:
MxtAura.remove(player.level(), area)