@minecraft/server

@minecraft/server as Basalt provides it: the part of Mojang’s Script API (2.x) that Basalt binds, with Mojang’s names and shapes, plus a few Basalt additions marked as such.

Reads such as Player.location or Dimension.getBlock ask the server and wait for its answer. In a before event or command the server itself waits on, a read the waiting thread would have to answer can’t be waited for: the world can’t be read in block and mob before events, and a player is read as the plugin last saw them in player before events and commands (a first read there throws). Read in system.run instead when that matters.

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

Categories

Errors67 pages Before events53 pages After events152 pages Other events44 pages Entity components75 pages Block components18 pages Item components17 pages Other components2 pages Commands10 pages Scoreboard9 pages Loot tables50 pages Players61 pages Entities41 pages Blocks29 pages Items15 pages World51 pages System7 pages Math and data types21 pages

Constants

EnchantmentTypes

const EnchantmentTypes: {
    get(enchantmentId: string): EnchantmentType | undefined;
    getAll(): EnchantmentType[];
};

Every enchantment the server knows.

Types

EnchantmentType

TicksPerSecond

const TicksPerSecond = 20;

Ticks in a second.

TicksPerDay

const TicksPerDay = 24000;

Ticks in a Minecraft day.

EffectTypes

const EffectTypes: {
    /** The effect type for a name, or undefined for an empty one. */
    get(name: string): EffectType | undefined;
    /** PARITY-RISK: Basalt keeps no enumerable effect registry; returns nothing. */
    getAll(): EffectType[];
};

The effect registry.

Types

EffectType

EntityTypes

const EntityTypes: {
    get(name: string): EntityType | undefined;
    getAll(): EntityType[];
};

The entity-type registry.

Types

EntityType

ItemTypes

const ItemTypes: {
    get(name: string): ItemType | undefined;
    getAll(): ItemType[];
};

The item-type registry.

Types

ItemType

BlockTypes

const BlockTypes: {
    get(name: string): BlockType | undefined;
    getAll(): BlockType[];
};

The block-type registry.

Types

BlockType

MinecraftDimensionTypes

const MinecraftDimensionTypes: {
    readonly overworld: "minecraft:overworld";
    readonly nether: "minecraft:nether";
    readonly theEnd: "minecraft:the_end";
    readonly Overworld: "minecraft:overworld";
    readonly Nether: "minecraft:nether";
    readonly TheEnd: "minecraft:the_end";
};

The dimension ids, as the legacy @minecraft/server exposed them.

world

const world: World;

Types

World

system

const system: System;

Types

System

server

const server: Server;

Basalt’s own.

Types

Server

HudElementsCount

const HudElementsCount = 13;

HudVisibilityCount

const HudVisibilityCount = 2;

MoonPhaseCount

const MoonPhaseCount = 8;