Private constructorReadonly afterReturns a collection of after-events for system-level operations.
Readonly Beta beforeReturns a collection of before-events for system-level operations.
Readonly currentRepresents the current world tick of the server.
Cancels the execution of a function run that was previously
scheduled via the run function.
clearRun.js
const runId = system.run(() => {
console.log("Running callback function...");
});
// Clear the run, so it will not run again.
system.clearRun(runId);
Function callback to run when the tickDelay time criteria is met.
An opaque identifier that can be used with the clearRun
function to cancel the execution of this run.
Runs a specified function at a future time. This is frequently used to implement delayed behaviors and game loops.
trapTick.ts
const overworld = mc.world.getDimension("overworld");
try {
// Minecraft runs at 20 ticks per second.
if (mc.system.currentTick % 1200 === 0) {
mc.world.sendMessage("Another minute passes...");
}
} catch (e) {
console.warn("Error: " + e);
}
mc.system.run(trapTick);
run.js
const runId = system.run(() => {
console.log("Running callback function...");
});
Functional code that will run when this interval occurs.
Optional tickInterval: numberAn interval of every N ticks that the callback will be called upon.
Optional An opaque handle that can be used with the clearRun method to stop the run of this function on an interval.
Runs a set of code on an interval.
every30Seconds.ts
let intervalRunIdentifier = Math.floor(Math.random() * 10000);
mc.system.runInterval(() => {
mc.world.sendMessage("This is an interval run " + intervalRunIdentifier + " sending a message every 30 seconds.");
}, 600);
Functional code that will run when this timeout occurs.
Optional tickDelay: numberAmount of time, in ticks, before the interval will be called.
Optional An opaque handle that can be used with the clearRun method to stop the run of this function on an interval.
Runs a set of code at a future time specified by tickDelay.
runTimeout.js
import { TicksPerSecond } from "@minecraft/server";
system.runTimeout(() => {
console.log("Running callback function after delay...");
}, TicksPerSecond * 5); // Tick delay of 5 seconds
Generated using TypeDoc
A class that provides system-level events and functions.