Class World

Constructors

`Private`constructor

new World(): World
Returns World

Properties

`Readonly`afterEvents

afterEvents: WorldAfterEvents

Remarks

This property can be read in early-execution mode.

Example: triggerEventOnce.js

import { world } from "@minecraft/server";

const callback = world.afterEvents.itemUse.subscribe((event) => {
if (event.itemStack.typeId == "minecraft:water_bucket") {
   event.source.sendMessage("You used water bucket once.");

   // Unsubscribe callback after first use
   world.afterEvents.itemUse.unsubscribe(callback);
}
});

`Readonly`beforeEvents

beforeEvents: WorldBeforeEvents

Remarks

This property can be read in early-execution mode.

Example: fixRequiredPrivilegesError.js

// Check out how BeforeEvents privilege system work:
// https://wiki.bedrock.dev/scripting/script-server.html#beforeevents-privilege-system
import { world, system, TimeOfDay } from "@minecraft/server";

// Use system.run()
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);
});
});

/**
@param {number} ticks
/
function sleep(ticks) {
return new Promise((resolve) => {
   system.runTimeout(() => resolve(), ticks);
});
}

// Or execute function at a later tick using async functions
world.beforeEvents.chatSend.subscribe(async (event) => {
// synchronous code
event.cancel = true;

// asynchronous code
await sleep(10); // Pretend you have a sleep function that returns a promise that resolves in 10 ticks
world.setTimeOfDay(TimeOfDay.Night);
});

Example: triggerBeforeEventOnce.js

import { system, world } from "@minecraft/server";

const callback = world.beforeEvents.itemUse.subscribe((event) => {
if (event.itemStack.typeId == "minecraft:water_bucket") {
   event.source.sendMessage("You cannot use water bucket at this time, please try again.");
   event.cancel = true;

   // Unsubscribe callback after first use
   system.run(() => world.beforeEvents.itemUse.unsubscribe(callback));
}
});

`Readonly`gameRules

gameRules: GameRules

Example: disableGamerules.ts

import { world } from "@minecraft/server";

world.gameRules.doDayLightCycle = false;
world.gameRules.doEntityDrops = false;
world.gameRules.doFireTick = false;
world.gameRules.doWeatherCycle = false;
world.gameRules.doMobSpawning = false;

`Readonly`isHardcore

isHardcore: boolean

Example: checkMode.js

import { world } from "@minecraft/server";

// Subscribe to the `playerSpawn` event, which is triggered when the world is initialized
world.afterEvents.playerSpawn.subscribe(() => {
   // Check if the world is in hardcore mode
   // Notify players about the current mode
   if (world.isHardcore) {
       world.sendMessage("Welcome to Hardcore mode! Be careful, as death is permanent.");
   } else {
       world.sendMessage("This world is not in Hardcore mode. Play safely!");
   }
});

`Readonly`scoreboard

scoreboard: Scoreboard

Example: getScoreboard.js

import { world } from "@minecraft/server";
const money = world.scoreboard.getObjective("money");

`Readonly`seed

seed: string

`Readonly`structureManager

structureManager: StructureManager

Example: getAllDiskStructures.ts

import { world } from "@minecraft/server";

world.structureManager.getWorldStructureIds().forEach((id) => {
   const structure = world.structureManager.get(id);
   structure.isValid;
});

Methods

clearDynamicProperties

clearDynamicProperties(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.
Example: clearProperties.ts
```
import { world } from "@minecraft/server";

world.clearDynamicProperties();
```

getAbsoluteTime

getAbsoluteTime(): number
Returns number
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.
Example: gametime.ts
```
import { world } from "@minecraft/server";

const gametime = world.getAbsoluteTime();
world.sendMessage("Current gametime: " + gametime);
```

getAllPlayers

getAllPlayers(): Player[]

Returns Player[]

Remarks

Write Privilege

This function can't be called in read-only mode.

Throws

This function can throw errors.

CommandError

minecraftcommon.InvalidArgumentError

World Ready

This function can't be called in early-execution mode.

Example: displayEveryoneHealth.ts

import { EntityHealthComponent, system, world } from "@minecraft/server";

system.runInterval(() => {
for (const player of world.getAllPlayers()) {
   const health = player.getComponent(EntityHealthComponent.componentId);
   player.onScreenDisplay.setActionBar(
       `Name: ${player.name} | Health: ${health.currentValue.toFixed()} / ${health.effectiveMax}`
   );
}
}, 5000);

getDay

getDay(): number
Returns number
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.
Example: broadcastDay.ts
```
import { world } from "@minecraft/server";

world.sendMessage("Day " + world.getDay());
```

getDefaultSpawnLocation

getDefaultSpawnLocation(): Vector3
Returns Vector3
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.
Example: printSpawnLocation.ts
```
import { world } from "@minecraft/server";

const spawnLocation = world.getDefaultSpawnLocation();
world.sendMessage(`Spawn location: ${spawnLocation.x}, ${spawnLocation.y}, ${spawnLocation.z}`);
```

getDifficulty

getDifficulty(): Difficulty
Returns Difficulty
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

getDimension

getDimension(dimensionId: string): Dimension
Parameters
- dimensionId: string
Returns Dimension
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.
Example: getNether.js
```
import { world } from "@minecraft/server";

world.getDimension("nether");
```
Example: getOverworld.js
```
import { world } from "@minecraft/server";

world.getDimension("overworld");
```
Example: getTheEnd.js
```
import { world } from "@minecraft/server";

world.getDimension("the_end");
```

getDynamicProperty

getDynamicProperty(identifier: string): string | number | boolean | Vector3

Parameters

identifier: string

Returns string | number | boolean | Vector3

Remarks

Write Privilege

This function can't be called in read-only mode.

World Ready

This function can't be called in early-execution mode.

Example: retrieve.js

import { world } from "@minecraft/server";

// Subscribe to the `playerSpawn` event, which is triggered when a player joins the world
world.afterEvents.playerSpawn.subscribe((eventData) => {
// Extract the player entity from the event data
const player = eventData.player;

// Attempt to retrieve a custom dynamic property
const playersCount = world.getDynamicProperty("playersCount");

if (typeof playersCount !== "number") {
   // If the property doesn't exist, set a default value
   player.setDynamicProperty("playersCount", 1);
} else {
   // If the property exists, increment its value
   player.setDynamicProperty("playersCount", playersCount + 1);
}
});

getDynamicPropertyIds

getDynamicPropertyIds(): string[]

Returns string[]

Remarks

Write Privilege

This function can't be called in read-only mode.

World Ready

This function can't be called in early-execution mode.

Example: listPropertiesAndValues.ts

import { world } from "@minecraft/server";

world.getDynamicPropertyIds().forEach((id) => {
const value = world.getDynamicProperty(id)!;
world.sendMessage(`Dynamic property ${id} has value ${value}`);
});
world.sendMessage("There are " + world.getDynamicPropertyIds().length + " dynamic properties");

getDynamicPropertyTotalByteCount

getDynamicPropertyTotalByteCount(): number
Returns number
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.
Example: getByteCount.ts
```
import { world } from "@minecraft/server";

world.getDynamicPropertyTotalByteCount();
```

getEntity

getEntity(id: string): Entity

Parameters

id: string

Returns Entity

Remarks

Write Privilege

This function can't be called in read-only mode.

Throws

This function can throw errors.

World Ready

This function can't be called in early-execution mode.

Example: getNpc.js

import { world } from "@minecraft/server";

// Entity::id - format: '-451021564564561'
const entityId = world
.getDimension("overworld")
.spawnEntity("minecraft:npc", { x: 0, y: 70, z: 0 }, { initialPersistence: true }).id;
world.getEntity(entityId).typeId; // minecraft:npc

getLootTableManager

getLootTableManager(): LootTableManager
Returns LootTableManager
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

getMoonPhase

getMoonPhase(): MoonPhase

Returns MoonPhase

Remarks

Write Privilege

This function can't be called in read-only mode.

World Ready

This function can't be called in early-execution mode.

Example: sayMoonPhase.ts

import { MoonPhase, world } from "@minecraft/server";

// Get the current moon phase
const moonPhase: MoonPhase = world.getMoonPhase();

// Display a message based on the current moon phase
switch (moonPhase) {
case MoonPhase.FullMoon:
   world.sendMessage("It's full moon!");
   break;
case MoonPhase.WaningGibbous:
   world.sendMessage("It's waning gibbous moon!");
   break;
// Add cases for other moon phases as needed
default:
   world.sendMessage("It's another phase of the moon.");
}

getPlayers

getPlayers(options?: EntityQueryOptions): Player[]

Parameters

Optionaloptions: EntityQueryOptions

Returns Player[]

Remarks

Write Privilege

This function can't be called in read-only mode.

Throws

This function can throw errors.

CommandError

minecraftcommon.InvalidArgumentError

World Ready

This function can't be called in early-execution mode.

Example: getFamily.js

import { world } from "@minecraft/server";
world.getPlayers({ families: ["player"] });

Example: getFilteredPlayers.ts

import { EntityQueryOptions, world } from "@minecraft/server";

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)
);

getTimeOfDay

getTimeOfDay(): number

Returns number

Remarks

Write Privilege

This function can't be called in read-only mode.

World Ready

This function can't be called in early-execution mode.

Example: broadcastTimeOfDay.ts

import { TimeOfDay, system, world } from "@minecraft/server";

function GetWorldTime() {
const daytime = world.getTimeOfDay() + 6000;
const datetime = new Date(daytime * 3.6 * 1000);
const hours = datetime.getHours() < 10 ? "0" + datetime.getHours() : datetime.getHours();
const minutes = datetime.getMinutes() < 10 ? "0" + datetime.getMinutes() : datetime.getMinutes();

return { hours, minutes };
}

system.runInterval(() => {
const { hours, minutes } = GetWorldTime();
for (const player of world.getAllPlayers()) {
   player.onScreenDisplay.setActionBar(`Time - ${hours}:${minutes}`);
}
});

playMusic

playMusic(trackId: string, musicOptions?: MusicOptions): void

Parameters

trackId: string
OptionalmusicOptions: MusicOptions

Returns void

Remarks

Write Privilege

This function can't be called in read-only mode.

Throws

This function can throw errors.

minecraftcommon.PropertyOutOfBoundsError

World Ready

This function can't be called in early-execution mode.

Example: music.js

import { world } from "@minecraft/server";

// Subscribe to the `playerSpawn` event, which is triggered when a player joins the world
world.afterEvents.playerSpawn.subscribe((eventData) => {
const player = eventData.player;

// Play a music track for the player when they join the world
player.playMusic("minecraft:music.game", {
   volume: 1.0, // Volume level of the music (1.0 is normal)
   fade: 0.5, // Fade in/out time in seconds
});

player.sendMessage("Welcome! Enjoy the music while you play.");
});

queueMusic

queueMusic(trackId: string, musicOptions?: MusicOptions): void
Parameters
- trackId: string
- OptionalmusicOptions: MusicOptions
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.PropertyOutOfBoundsError

World Ready
This function can't be called in early-execution mode.
Example: queueMusicForAll.ts
```
import { world } from "@minecraft/server";

world.queueMusic("music.game.swamp_music", { loop: true });
```

sendMessage

sendMessage(message: string | RawMessage | (string | RawMessage)[]): void

Parameters

message: string | RawMessage | (string | RawMessage)[]

Returns void

Remarks

Write Privilege

This function can't be called in read-only mode.

Throws

This function can throw errors.

World Ready

This function can't be called in early-execution mode.

Example: message.js

import { world } from "@minecraft/server";

// Subscribe to the `playerSpawn` event, which is triggered when a player joins the world
world.afterEvents.playerSpawn.subscribe((eventData) => {
// ignore if player respawns
if (!eventData.initialSpawn) return;

const player = eventData.player;

// Construct a welcome message for the player who just joined
const welcomeMessage = `Welcome ${player.name}! Have fun in the world of Minecraft!`;

// Use world.sendMessage to broadcast the message to all players in the world
world.sendMessage(welcomeMessage);

// Notify the player specifically with a different message
player.sendMessage("Feel free to explore and build your adventure!");
});

setAbsoluteTime

setAbsoluteTime(absoluteTime: number): void
Parameters
- absoluteTime: number
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.
Example: setDay.js
```
import { TimeOfDay, world } from "@minecraft/server";
world.setAbsoluteTime(TimeOfDay.Noon);
```

setDefaultSpawnLocation

setDefaultSpawnLocation(spawnLocation: Vector3): void
Parameters
- spawnLocation: Vector3
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

LocationOutOfWorldBoundariesError

World Ready
This function can't be called in early-execution mode.
Example: setWorldSpawn.js
```
import { world } from "@minecraft/server";

world.setDefaultSpawnLocation({
x: 0,
y: -64,
z: 0,
});
```

setDifficulty

setDifficulty(difficulty: Difficulty): void
Parameters
- difficulty: Difficulty
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.

setDynamicProperties

setDynamicProperties(
values: Record<string, string | number | boolean | Vector3>,
): void
Parameters
- values: Record<string, string | number | boolean | Vector3>
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

minecraftcommon.ArgumentOutOfBoundsError

World Ready
This function can't be called in early-execution mode.

setDynamicProperty

setDynamicProperty(
identifier: string,
value?: string | number | boolean | Vector3,
): void

Parameters

identifier: string
Optionalvalue: string | number | boolean | Vector3

Returns void

Remarks

Write Privilege

This function can't be called in read-only mode.

Throws

This function can throw errors.

minecraftcommon.ArgumentOutOfBoundsError

World Ready

This function can't be called in early-execution mode.

Example: assign.js

import { world } from "@minecraft/server";

// Subscribe to the `playerSpawn` event, which is triggered when a player joins the world
world.afterEvents.playerSpawn.subscribe((eventData) => {
// Extract the player entity from the event data
const player = eventData.player;

// Attempt to retrieve a custom dynamic property
let playersCount = world.getDynamicProperty("playersCount");

// If the property doesn't exist
playersCount ??= 0;

// set a default value
// @ts-ignore assuming playersCount is a number
player.setDynamicProperty("playersCount", playersCount + 1);
});

setTimeOfDay

setTimeOfDay(timeOfDay: number): void
Parameters
- timeOfDay: number
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.
Example: setTimeToDay.ts
```
import { TimeOfDay, world } from "@minecraft/server";

world.setTimeOfDay(TimeOfDay.Day);
```
Example: setTimeToMidnight.ts
```
import { TimeOfDay, world } from "@minecraft/server";

world.setTimeOfDay(TimeOfDay.Midnight);
```

stopMusic

stopMusic(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

World Ready
This function can't be called in early-execution mode.
Example: stopMusicForAll.ts
```
import { world } from "@minecraft/server";

world.stopMusic();
```

Class World

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns World

Properties

ReadonlyafterEvents

Remarks

Example: triggerEventOnce.js

ReadonlybeforeEvents

Remarks

Example: fixRequiredPrivilegesError.js

Example: triggerBeforeEventOnce.js

ReadonlygameRules

Example: disableGamerules.ts

ReadonlyisHardcore

Example: checkMode.js

Readonlyscoreboard

Example: getScoreboard.js

Readonlyseed

ReadonlystructureManager

Example: getAllDiskStructures.ts

Methods

clearDynamicProperties

Returns void

Remarks

Write Privilege

World Ready

Example: clearProperties.ts

getAbsoluteTime

Returns number

Remarks

Write Privilege

World Ready

Example: gametime.ts

getAllPlayers

Returns Player[]

Remarks

Write Privilege

Throws

World Ready

Example: displayEveryoneHealth.ts

getDay

Returns number

Remarks

Write Privilege

World Ready

Example: broadcastDay.ts

getDefaultSpawnLocation

Returns Vector3

Remarks

Write Privilege

World Ready

Example: printSpawnLocation.ts

getDifficulty

Returns Difficulty

Remarks

Write Privilege

World Ready

getDimension

Parameters

Returns Dimension

Remarks

Write Privilege

Throws

World Ready

Example: getNether.js

Example: getOverworld.js

Example: getTheEnd.js

getDynamicProperty

Parameters

Returns string | number | boolean | Vector3

Remarks

Write Privilege

World Ready

Example: retrieve.js

getDynamicPropertyIds

`Private`constructor

`Readonly`afterEvents

`Readonly`beforeEvents

`Readonly`gameRules

`Readonly`isHardcore

`Readonly`scoreboard

`Readonly`seed

`Readonly`structureManager