Script (Entity Condition Type)

Passes when a script returns a truthy value for the entity. Returning nothing counts as false.

Type ID: apoli:script

Fields

Field	Type	Default	Description
`script`	Identifier	required	The script to run. Either an ID registered from KubeJS with `ApoliEvents`, or the path of a `.js` file shipped in a data pack at `data/<namespace>/apoli/scripts/<path>.js`, in which case the `.js` is part of the ID.
`params`	NBT	optional	Values handed to the script. Read them with `event.params` from KubeJS, or `params` inside a data pack script. This is how one script serves several powers.

Example

A condition with no JSON equivalent, checking whether the player is standing on a block whose ID contains a word. The script goes in kubejs/server_scripts/stone_sense.js:

kubejs/server_scripts/stone_sense.js

ApoliEvents.entityCondition('mypack:on_stone', event => {
  const below = event.level.getBlock(event.entity.block.pos.below())
  return below.id.includes('stone')
})

{
  "type": "apoli:attribute",
  "modifiers": [
    {
      "attribute": "minecraft:generic.movement_speed",
      "operation": "multiply_base_multiplicative",
      "value": 0.3
    }
  ],
  "condition": {
    "type": "apoli:script",
    "script": "mypack:on_stone"
  }
}

A data pack script used as a condition is an expression, and the value of the last line is the answer. This one is data/mypack/apoli/scripts/is_late.js:

data/mypack/apoli/scripts/is_late.js

ctx.level.dayTime % 24000 > 18000

warning

A condition can be checked many times a tick. Keep the script short, and use a real condition type when one exists.

note

This condition needs KubeJS. Without it the type still loads and the pack still works, but the call logs once and does nothing. Scripts always run on the server.