Private constructorReadonly afterContains a set of events that are applicable to the entirety of the world. Event callbacks are called in a deferred manner. Event callbacks are executed in read-write mode.
sub_and_unsub.js
import { world } from "@minecraft/server";
const callback = world.beforeEvents.itemUse.subscribe((event) => {}); // your event
world.beforeEvents.itemUse.unsubscribe(callback); // unsubscribe
Readonly beforeContains a set of events that are applicable to the entirety of the world. Event callbacks are called immediately. Event callbacks are executed in read-only mode.
privilege.js
import { world, system, TimeOfDay } from "@minecraft/server";
world.beforeEvents.chatSend.subscribe((event) => {
event.cancel = true;
// setTime changes world state, must be run after its execution by a tick
system.run(() => {
world.setTimeOfDay(TimeOfDay.Night);
});
});
sub_and_unsub.js
import { world } from "@minecraft/server";
const callback = world.afterEvents.buttonPush.subscribe((event) => {}); // event
world.afterEvents.buttonPush.unsubscribe(callback); // unsubscribe
Readonly scoreboardReturns the general global scoreboard that applies to the world.
getScoreboard.js
import { world } from "@minecraft/server";
const money = world.scoreboard.getObjective("money");
The name of the dimension. For example, "overworld", "nether" or "the_end".
The requested dimension
Returns a dimension object.
Throws if the given dimension name is invalid
getNether.js
import { world } from "@minecraft/server";
world.getDimension("nether");
getOverworld.js
import { world } from "@minecraft/server";
world.getDimension("overworld");
getTheEnd.js
import { world } from "@minecraft/server";
world.getDimension("the_end");
The property identifier.
Returns the value for the property, or undefined if the property has not been set.
Returns a property value.
Throws if the given dynamic property identifier is not defined.
incrementProperty.ts
let number = mc.world.getDynamicProperty("samplelibrary:number");
log("Current value is: " + number);
if (number === undefined) {
number = 0;
}
if (typeof number !== "number") {
log("Number is of an unexpected type.");
return -1;
}
mc.world.setDynamicProperty("samplelibrary:number", number + 1);
incrementPropertyInJsonBlob.ts
let paintStr = mc.world.getDynamicProperty("samplelibrary:longerjson");
let paint: { color: string; intensity: number } | undefined = undefined;
log("Current value is: " + paintStr);
if (paintStr === undefined) {
paint = {
color: "purple",
intensity: 0,
};
} else {
if (typeof paintStr !== "string") {
log("Paint is of an unexpected type.");
return -1;
}
try {
paint = JSON.parse(paintStr);
} catch (e) {
log("Error parsing serialized struct.");
return -1;
}
}
if (!paint) {
log("Error parsing serialized struct.");
return -1;
}
paint.intensity++;
paintStr = JSON.stringify(paint); // be very careful to ensure your serialized JSON str cannot exceed limits
mc.world.setDynamicProperty("samplelibrary:longerjson", paintStr);
Optional options: EntityQueryOptionsAdditional options that can be used to filter the set of players returned.
Optional A player array.
Returns a set of players based on a set of conditions defined via the EntityQueryOptions set of filter criteria.
Throws if the provided EntityQueryOptions are invalid.
getFamily.js
import { world } from "@minecraft/server";
world.getPlayers({ families: ["player"] });
getFilteredPlayers.ts
const entityQueryOptions: EntityQueryOptions = {
minLevel: 10,
maxLevel: 30,
tags: ["team_red"],
excludeNames: ["Admin"],
};
const filteredPlayers = world.getPlayers(entityQueryOptions);
console.log(
"Filtered Players:",
filteredPlayers.map((player) => player.name)
);
Optional musicOptions: MusicOptionsOptional Plays a particular music track for all players.
This function can't be called in read-only mode.
This function can throw errors.
playMusicAndSound.ts
let players = mc.world.getPlayers();
const musicOptions: mc.MusicOptions = {
fade: 0.5,
loop: true,
volume: 1.0,
};
mc.world.playMusic("music.menu", musicOptions);
const worldSoundOptions: mc.WorldSoundOptions = {
pitch: 0.5,
volume: 4.0,
};
mc.world.playSound("ambient.weather.thunder", targetLocation, worldSoundOptions);
const playerSoundOptions: mc.PlayerSoundOptions = {
pitch: 1.0,
volume: 1.0,
};
players[0].playSound("bucket.fill_water", playerSoundOptions);
Optional soundOptions: WorldSoundOptionsOptional Plays a sound for all players.
This function can't be called in read-only mode.
An error will be thrown if volume is less than 0.0. An error will be thrown if fade is less than 0.0. An error will be thrown if pitch is less than 0.01. An error will be thrown if volume is less than 0.0.
playMusicAndSound.ts
let players = mc.world.getPlayers();
const musicOptions: mc.MusicOptions = {
fade: 0.5,
loop: true,
volume: 1.0,
};
mc.world.playMusic("music.menu", musicOptions);
const worldSoundOptions: mc.WorldSoundOptions = {
pitch: 0.5,
volume: 4.0,
};
mc.world.playSound("ambient.weather.thunder", targetLocation, worldSoundOptions);
const playerSoundOptions: mc.PlayerSoundOptions = {
pitch: 1.0,
volume: 1.0,
};
players[0].playSound("bucket.fill_water", playerSoundOptions);
Identifier of the music track to play.
Optional musicOptions: MusicOptionsAdditional options for the music track.
Optional Queues an additional music track for players. If a track is not playing, a music track will play.
This function can't be called in read-only mode.
An error will be thrown if volume is less than 0.0. An error will be thrown if fade is less than 0.0.
The message to be displayed.
Sends a message to all players.
This method can throw if the provided RawMessage is
in an invalid format. For example, if an empty name string
is provided to score.
nestedTranslation.ts
// Displays "Apple or Coal"
let rawMessage = {
translate: "accessibility.list.or.two",
with: { rawtext: [{ translate: "item.apple.name" }, { translate: "item.coal.name" }] },
};
world.sendMessage(rawMessage);
scoreWildcard.ts
// Displays the player's score for objective "obj". Each player will see their own score.
const rawMessage = { score: { name: "*", objective: "obj" } };
world.sendMessage(rawMessage);
simpleString.ts
// Displays "Hello, world!"
world.sendMessage("Hello, world!");
translation.ts
// Displays "First or Second"
const rawMessage = { translate: "accessibility.list.or.two", with: ["First", "Second"] };
world.sendMessage(rawMessage);
Location of the spawn point. Note that this is assumed to be within the overworld dimension.
Sets a default spawn location for all players.
This function can't be called in read-only mode.
Throws if the provided spawn location is out of bounds.
Error
LocationOutOfWorldBoundariesError
setWorldSpawn.js
import { world } from "@minecraft/server";
world.setDefaultSpawnLocation({
x: 0,
y: -64,
z: 0,
});
The property identifier.
Optional value: string | number | boolean | Vector3Data value of the property to set.
Optional Sets a specified property to a value.
Throws if the given dynamic property identifier is not defined.
incrementProperty.ts
let number = mc.world.getDynamicProperty("samplelibrary:number");
log("Current value is: " + number);
if (number === undefined) {
number = 0;
}
if (typeof number !== "number") {
log("Number is of an unexpected type.");
return -1;
}
mc.world.setDynamicProperty("samplelibrary:number", number + 1);
incrementPropertyInJsonBlob.ts
let paintStr = mc.world.getDynamicProperty("samplelibrary:longerjson");
let paint: { color: string; intensity: number } | undefined = undefined;
log("Current value is: " + paintStr);
if (paintStr === undefined) {
paint = {
color: "purple",
intensity: 0,
};
} else {
if (typeof paintStr !== "string") {
log("Paint is of an unexpected type.");
return -1;
}
try {
paint = JSON.parse(paintStr);
} catch (e) {
log("Error parsing serialized struct.");
return -1;
}
}
if (!paint) {
log("Error parsing serialized struct.");
return -1;
}
paint.intensity++;
paintStr = JSON.stringify(paint); // be very careful to ensure your serialized JSON str cannot exceed limits
mc.world.setDynamicProperty("samplelibrary:longerjson", paintStr);
Generated using TypeDoc
A class that wraps the state of a world - a set of dimensions and the environment of Minecraft.