Minecraft Script API

https://jaylydev.github.io/scriptapi-docs/latest/
Admin
Minecraft Script API is a JavaScript-based framework that allows developers to interact with and...
Tokens:481,448
Snippets:4,697
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Entity Component Examples

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.SimulatedPlayer.html

Demonstrates accessing and manipulating various entity components such as health, inventory, and item stacks.

```javascript
import { world } from "@minecraft/server";  
  
for (const player of world.getPlayers()) {  
const health = player.getComponent("health");  
player.sendMessage("Your health is " + health.currentValue + "/" + health.effectiveMax);  
health.setCurrentValue(15); // set player to 15 hp  
health.resetToMaxValue(); // reset player to max hp  
}
```

```javascript
import { ItemStack, world } from "@minecraft/server";  
  
world.afterEvents.buttonPush.subscribe((event) => {  
const entity = event.source;  
entity.getComponent("inventory").container.addItem(new ItemStack("minecraft:dirt", 1));  
});
```

```javascript
import { world } from "@minecraft/server";  
  
const itemEntities = world.getDimension("overworld").getEntities({ type: "minecraft:item" });  
for (const itemEntity of itemEntities) {  
const item = itemEntity.getComponent("item");  
item.itemStack.keepOnDeath = true;  
}
```

--------------------------------

### Install @minecraft/server-ui via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server-ui.html

Command to install the type definitions for the module.

```bash
npm i @minecraft/server-ui@2.1.0
```

--------------------------------

### Install @minecraft/gameplay-utilities

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_gameplay-utilities.html

Command to install the library via NPM.

```bash
npm i @minecraft/gameplay-utilities@1.3.0
```

--------------------------------

### Install @minecraft/server-ui via npm

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server-ui-1.html

Command to install the specific version of the module.

```bash
npm i @minecraft/server-ui@2.2.0-beta.1.26.30-stable
```

--------------------------------

### Install @minecraft/server-net via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server-net.html

Command to install the type definitions for the module.

```bash
npm i @minecraft/server-net@1.0.0-beta.1.26.30-stable
```

--------------------------------

### Install @minecraft/server-admin via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server-admin.html

Command to install the type definitions for the module.

```bash
npm i @minecraft/server-admin@1.0.0-beta.1.26.30-stable
```

--------------------------------

### Install @minecraft/server via npm

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server-1.html

Use this command to install the specific beta version of the @minecraft/server type definitions.

```bash
npm i @minecraft/server@2.9.0-beta.1.26.30-stable
```

--------------------------------

### Install @minecraft/diagnostics via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_diagnostics.html

Command to install the type definitions for the module.

```bash
npm i @minecraft/diagnostics@1.0.0-beta.1.26.30-stable
```

--------------------------------

### Install @minecraft/server-gametest via npm

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server-gametest.html

Use npm to install the specific version of the type definitions.

```bash
npm i @minecraft/server-gametest@1.0.0-beta.1.26.30-stable
```

--------------------------------

### Install @minecraft/server via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server.html

Command to install the type definitions for the @minecraft/server module.

```bash
npm i @minecraft/server@2.8.0
```

--------------------------------

### Install @minecraft/server-graphics via npm

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server-graphics.html

Use npm to install the specific version of the type definitions.

```bash
npm i @minecraft/server-graphics@1.0.0-beta.1.26.30-stable
```

--------------------------------

### Install @minecraft/server-editor via npm

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_server-editor.html

Command to install the type definitions for the editor module.

```bash
npm i @minecraft/server-editor@0.1.0-beta.1.26.30-stable
```

--------------------------------

### Get Block from View Direction Examples

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.SimulatedPlayer.html

Demonstrates how to retrieve the block an entity is looking at and how to modify that block.

```javascript
import { world } from "@minecraft/server";  
  
for (const entity of world.getDimension("overworld").getEntities()) {  
const blockHit = entity.getBlockFromViewDirection();  
  
if (blockHit) {  
   console.log("Block Hit:");  
   console.log("Block:", blockHit.block);  
   console.log("Face:", blockHit.face);  
   console.log("Face Location:", JSON.stringify(blockHit.faceLocation));  
} else {  
   console.log("No block in view direction.");  
}  
}
```

```javascript
import { BlockPermutation, world } from "@minecraft/server";  
  
const entity = world.getDimension("overworld").spawnEntity("minecraft:fox", { x: 0, y: 0, z: 0 });  
const blockHit = entity.getBlockFromViewDirection();  
  
if (blockHit) {  
blockHit.block.setPermutation(BlockPermutation.resolve("minecraft:bedrock"));  
} else {  
console.log("No block in view direction.");  
}
```

--------------------------------

### Install @minecraft/common via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_common.html

Run this command in your terminal to install the specific version of the module.

```bash
npm i @minecraft/common@1.3.0
```

--------------------------------

### Install @minecraft/debug-utilities via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_debug-utilities.html

Command to install the type definitions for the debug-utilities module.

```bash
npm i @minecraft/debug-utilities@1.0.0-beta.1.26.30-stable
```

--------------------------------

### Install @minecraft/math via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_math.html

Use the npm command to add the library to your project dependencies.

```bash
npm i @minecraft/math@2.4.0
```

--------------------------------

### Install @minecraft/vanilla-data via NPM

Source: https://jaylydev.github.io/scriptapi-docs/latest/modules/_minecraft_vanilla-data.html

Use this command to add the library to your project dependencies.

```bash
npm i @minecraft/vanilla-data@1.26.33
```

--------------------------------

### getTotalXp()

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.SimulatedPlayer.html

Gets the total experience of the Player.

```APIDOC
## getTotalXp()

### Description
Gets the total experience of the Player.

### Returns
- **number** - The total experience points.
```

--------------------------------

### Manage Dynamic Properties

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.Player.html

Examples for setting, retrieving, and listing dynamic properties on entities.

```typescript
import { Vector3, system, world } from "@minecraft/server";  
  
world.afterEvents.entitySpawn.subscribe((event) => {  
event.entity.setDynamicProperty("spawn_location", event.entity.location); // set location spawn  
});  
  
world.beforeEvents.entityRemove.subscribe((event) => {  
const location = event.removedEntity.getDynamicProperty("spawn_location") as Vector3; // get location spawn  
const dimension = event.removedEntity.dimension;  
system.run(() => {  
   dimension.spawnEntity<string>(event.removedEntity.typeId, location);  
});  
});
```

```typescript
import { Player, system } from "@minecraft/server";  
  
system.afterEvents.scriptEventReceive.subscribe((event) => {  
// Type /scriptevent bp:entries to see this message  
if (event.id === "bp:entries" && event.sourceEntity instanceof Player) {  
   event.sourceEntity.sendMessage("Here's your dynamic properties entries:");  
  
   // Display all dynamic properties  
   for (const id of event.sourceEntity.getDynamicPropertyIds()) {  
       event.sourceEntity.sendMessage(`- ${id}: ${event.sourceEntity.getDynamicProperty(id)}`);  
   }  
}  
});
```

--------------------------------

### Get Absolute World Time

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.World.html

Retrieves the total time elapsed since the world started and broadcasts it.

```typescript
import { world } from "@minecraft/server";  
  
const gametime = world.getAbsoluteTime();  
world.sendMessage("Current gametime: " + gametime);
```

--------------------------------

### startBuild

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.SimulatedPlayer.html

Initiates a build process for the simulated player.

```APIDOC
## startBuild(slot?: number): void

### Parameters
- **slot** (number) - Optional - Defaults to 0.

### Returns
- **void**
```

--------------------------------

### activateTutorial

Source: https://jaylydev.github.io/scriptapi-docs/latest/interfaces/_minecraft_server-editor.BuiltInUIManager.html

Activates the tutorial overlay.

```APIDOC
### activateTutorial()

Activates tutorial overlay.

**Returns:** void
```

--------------------------------

### setHorizonBlendStart

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-graphics.BiomeAtmospherics.html

Sets the starting horizon blend value for atmospheric scattering.

```APIDOC
## setHorizonBlendStart(blendStart: number | Record<number, number>): void

### Description
Sets the horizon blend start for atmospheric scattering in Vibrant Visuals. This function cannot be called in restricted-execution mode.

### Parameters
- **blendStart** (number | Record<number, number>) - Required - Either a number (range [0,1]) or a set of keyframes where keys represent time of day (0.0-1.0) and values represent the blend intensity.

### Throws
- minecraftcommon.InvalidArgumentError
```

--------------------------------

### Registering a Custom Command

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.CustomCommandRegistry-1.html

Examples demonstrating how to register custom commands using the CustomCommandRegistry during the startup event.

```typescript
// This sample is from Mojang, see an updated sample at  
// https://github.com/microsoft/minecraft-scripting-samples/tree/main/custom-commands  
import {  
system,  
StartupEvent,  
CommandPermissionLevel,  
CustomCommand,  
CustomCommandParamType,  
CustomCommandStatus,  
CustomCommandOrigin,  
CustomCommandResult,  
world,  
Entity,  
Vector3,  
} from "@minecraft/server";  
  
system.beforeEvents.startup.subscribe((init: StartupEvent) => {  
const dirtsterCommand: CustomCommand = {  
   name: "creator:dirtster",  
   description: "Adds some dirt, ster",  
   permissionLevel: CommandPermissionLevel.GameDirectors,  
   mandatoryParameters: [{ type: CustomCommandParamType.Location, name: "dirtLocation" }],  
};  
init.customCommandRegistry.registerCommand(dirtsterCommand, dirtster);  
});  
  
function dirtster(origin: CustomCommandOrigin, loc: Vector3): CustomCommandResult {  
world.sendMessage("Lets get dirty!");  
  
system.run(() => {  
   const dim = world.getDimension("overworld");  
  
   dim.setBlockType(loc, "minecraft:dirt");  
  
   // it's a mini dirt pyramid  
   dim.setBlockType({ x: loc.x + 2, y: loc.y + 1, z: loc.z }, "minecraft:dirt");  
   dim.setBlockType({ x: loc.x - 2, y: loc.y + 1, z: loc.z }, "minecraft:dirt");  
   dim.setBlockType({ x: loc.x + 1, y: loc.y + 1, z: loc.z }, "minecraft:dirt");  
   dim.setBlockType({ x: loc.x - 1, y: loc.y + 1, z: loc.z }, "minecraft:dirt");  
   dim.setBlockType({ x: loc.x, y: loc.y + 1, z: loc.z }, "minecraft:dirt");  
  
   dim.setBlockType({ x: loc.x + 1, y: loc.y + 2, z: loc.z }, "minecraft:dirt");  
   dim.setBlockType({ x: loc.x - 1, y: loc.y + 2, z: loc.z }, "minecraft:dirt");  
   dim.setBlockType({ x: loc.x, y: loc.y + 2, z: loc.z }, "minecraft:dirt");  
  
   dim.setBlockType({ x: loc.x, y: loc.y + 3, z: loc.z }, "minecraft:dirt");  
}); //  
  
return {  
   status: CustomCommandStatus.Success,  
};  
}
```

```typescript
// This sample is from Mojang, see an updated sample at  
// https://github.com/microsoft/minecraft-scripting-samples/tree/main/custom-commands  
import {  
system,  
StartupEvent,  
CommandPermissionLevel,  
CustomCommand,  
CustomCommandParamType,  
CustomCommandStatus,  
CustomCommandOrigin,  
CustomCommandResult,  
world,  
} from "@minecraft/server";  
  
system.beforeEvents.startup.subscribe((init: StartupEvent) => {  
const helloCommand: CustomCommand = {  
   name: "creator:hellocustomcommand",  
   description: "Celebration super party hello",  
   permissionLevel: CommandPermissionLevel.Any,  
   optionalParameters: [{ type: CustomCommandParamType.Integer, name: "celebrationSize" }],  
};  
init.customCommandRegistry.registerCommand(helloCommand, helloCustomCommand);  
});  
  
function helloCustomCommand(origin: CustomCommandOrigin, celebrationSize?: number): CustomCommandResult {  
world.sendMessage("Hello Custom Command!");  
const player = origin.sourceEntity;  
  
if (celebrationSize && player) {  
   system.run(() => {  
       player.dimension.createExplosion(player.location, celebrationSize);  
   });  
}  
  
return {  
   status: CustomCommandStatus.Success,  
};  
}
```

--------------------------------

### createIntroductionPane

Source: https://jaylydev.github.io/scriptapi-docs/latest/interfaces/_minecraft_server-editor.IPaneManager.html

Creates a new introduction pane based on the provided options.

```APIDOC
### createIntroductionPane(options: IIntroductionPaneOptions): IIntroductionPane

#### Description
Creates a pane to be shown on the introduction window.

#### Parameters
- **options** (IIntroductionPaneOptions) - Required - Configuration options for the introduction pane.

#### Returns
- **IIntroductionPane** - The created introduction pane instance.
```

--------------------------------

### Subscribe to Script Events

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.SystemAfterEvents-1.html

Examples demonstrating how to subscribe to script events triggered by entities or the server.

```javascript
import { system, world } from "@minecraft/server";  
  
system.afterEvents.scriptEventReceive.subscribe((event) => {  
const { id, message, sourceEntity, sourceType } = event;  
  
// Handle script events from entities  
if (sourceEntity && sourceType === "Entity") {  
   world.sendMessage(`Script event ${id}: ${message} from ${sourceEntity.typeId}`);  
}  
});  
  
// Send a test script event  
world.getPlayers().forEach((player) => {  
player.runCommand("scriptevent wiki:test Hello World");  
});
```

```javascript
import { system, world } from "@minecraft/server";  
  
system.afterEvents.scriptEventReceive.subscribe((event) => {  
const { id, message, sourceType } = event;  
  
// console.log removed for example clarity // wiki:test  
// console.log removed for example clarity // Hello World  
// console.log removed for example clarity // Server  
});  
  
world.getDimension("overworld").runCommand("scriptevent wiki:test Hello World");
```

--------------------------------

### Handle System Startup and Shutdown Events

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.SystemBeforeEvents-1.html

Demonstrates subscribing to startup and shutdown events to register custom components and commands, or perform cleanup tasks.

```typescript
import { system, StartupEvent, ShutdownEvent } from "@minecraft/server";  
  
// Example of handling system startup events  
function setupSystemEventListeners() {  
   // Handle startup events  
   system.beforeEvents.startup.subscribe((event: StartupEvent) => {  
       console.log("Server is starting up!");  
  
       // Register custom block components during startup  
       event.blockComponentRegistry.registerCustomComponent("custom:my_block", {  
           onPlayerInteract: (eventData, params) => {  
               console.log("Custom block was interacted with!");  
           },  
           onPlace: (eventData, params) => {  
               console.log("Custom block was placed!");  
           },  
       });  
  
       // Register custom item components during startup  
       event.itemComponentRegistry.registerCustomComponent("custom:my_item", {  
           onUse: (eventData, params) => {  
               console.log("Custom item was used!");  
           },  
           onHitEntity: (eventData, params) => {  
               console.log("Custom item hit an entity!");  
           },  
       });  
  
       // Register custom commands during startup  
       event.customCommandRegistry.registerCommand(  
           {  
               name: "custom:hello",  
               description: "A simple greeting command",  
               permissionLevel: 0, // Any permission level  
               cheatsRequired: false,  
               mandatoryParameters: [],  
               optionalParameters: [],  
           },  
           (origin, args) => {  
               return {  
                   status: 0, // Success  
                   message: "Hello from custom command!",  
               };  
           }  
       );  
  
       console.log("Custom components and commands registered successfully!");  
   });  
  
   // Handle shutdown events  
   system.beforeEvents.shutdown.subscribe((event: ShutdownEvent) => {  
       console.log("Server is shutting down!");  
  
       // Perform cleanup operations  
       console.log("Performing cleanup operations...");  
  
       // Save any important data  
       console.log("Saving important data before shutdown...");  
  
       // Log final statistics  
       console.log("Server shutdown cleanup completed.");  
   });  
}  
  
// Example: Check if we're in an editor world  
function checkEditorWorld() {  
   if (system.isEditorWorld) {  
       console.log("Running in Minecraft Editor world");  
       // Handle editor-specific logic  
   } else {  
       console.log("Running in regular Minecraft world");  
       // Handle normal gameplay logic  
   }  
}  
  
// Call these functions to set up the listeners  
setupSystemEventListeners();  
checkEditorWorld();
```

--------------------------------

### get

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-net.HttpClient.html

Performs a simple HTTP GET request to the specified URI.

```APIDOC
## get(uri: string): Promise<HttpResponse>

### Description
Performs a simple HTTP get request.

### Parameters
- **uri** (string) - Required - URL to make an HTTP Request to.

### Returns
- **Promise<HttpResponse>** - An awaitable promise that contains the HTTP response.
```

--------------------------------

### setHorizonBlendMieStart

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-graphics.BiomeAtmospherics.html

Sets the horizon blend mie start for atmospheric scattering in Vibrant Visuals.

```APIDOC
### setHorizonBlendMieStart(blendMieStart: number | Record<number, number>): void

#### Description
Sets the horizon blend mie start for atmospheric scattering in Vibrant Visuals. This function cannot be called in restricted-execution mode.

#### Parameters
- **blendMieStart** (number | Record<number, number>) - Required - Either a number (range [0,1.2]) or a set of keyframes. The key is a number (range [0,1]) representing time of day, and the value is a number (range [0,1.2]).

#### Throws
- minecraftcommon.InvalidArgumentError
```

--------------------------------

### beginPainting

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-editor.BrushShapeManager.html

Starts a painting operation. This function cannot be called in restricted-execution mode or early-execution mode.

```APIDOC
### beginPainting(onComplete: (arg0: PaintCompletionState) => void)

Starts the painting process.

**Parameters:**
- **onComplete** ((arg0: PaintCompletionState) => void) - Callback function triggered upon completion.

**Returns:** void
```

--------------------------------

### navigateToSamples

Source: https://jaylydev.github.io/scriptapi-docs/latest/interfaces/_minecraft_server-editor.BuiltInUIManager.html

Navigates to the github-samples site.

```APIDOC
### navigateToSamples()

Navigates to the github-samples site.

**Returns:** void
```

--------------------------------

### init

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_diagnostics.Sentry.html

Initializes Sentry for use.

```APIDOC
## init(options: SentryOptions): void

### Description
Initializes Sentry for use. This must be successfully called before any other Sentry functions are called.

### Parameters
- **options** (SentryOptions) - Required - Configuration options for Sentry.

### Throws
- minecraftcommon.InvalidArgumentError
- SentryAlreadyInitializedError
```

--------------------------------

### Subscribe to TripWireTripAfterEvent

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.TripWireTripAfterEvent-1.html

Demonstrates how to set up a tripwire and subscribe to the tripWireTrip event to log activity when triggered.

```typescript
import { world, system, BlockPermutation, TripWireTripAfterEvent, DimensionLocation } from '@minecraft/server';  
import { MinecraftBlockTypes } from '@minecraft/vanilla-data';  
  
function tripWireTripEvent(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {  
  // set up a tripwire  
  const redstone = targetLocation.dimension.getBlock({  
    x: targetLocation.x,  
    y: targetLocation.y - 1,  
    z: targetLocation.z,  
  });  
  const tripwire = targetLocation.dimension.getBlock(targetLocation);  
  
  if (redstone === undefined || tripwire === undefined) {  
    log('Could not find block at location.');  
    return -1;  
  }  
  
  redstone.setPermutation(BlockPermutation.resolve(MinecraftBlockTypes.RedstoneBlock));  
  tripwire.setPermutation(BlockPermutation.resolve(MinecraftBlockTypes.TripWire));  
  
  world.afterEvents.tripWireTrip.subscribe((tripWireTripEvent: TripWireTripAfterEvent) => {  
    const eventLoc = tripWireTripEvent.block.location;  
  
    if (eventLoc.x === targetLocation.x && eventLoc.y === targetLocation.y && eventLoc.z === targetLocation.z) {  
      log(  
        'Tripwire trip event at tick ' +  
          system.currentTick +  
          (tripWireTripEvent.sources.length > 0 ? ' by entity ' + tripWireTripEvent.sources[0].id : '')  
      );  
    }  
  });  
}
```

--------------------------------

### Enable Bedrock Editor via Command Line

Source: https://jaylydev.github.io/scriptapi-docs/latest/index.html

Use this command to launch the Bedrock Dedicated Server with the Editor enabled.

```bash
bedrock_server.exe Editor=true
```

--------------------------------

### Basic system.run usage

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.System.html

Demonstrates the basic syntax for scheduling a function to run at the next tick.

```javascript
import { system } from "@minecraft/server";  
  
const runId = system.run(() => {  
// console.log removed for example clarity  
});
```

--------------------------------

### get

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.StructureManager-1.html

Retrieves a structure by its identifier.

```APIDOC
## get(identifier: string): Structure | undefined

### Description
Returns the structure associated with the given identifier, if it exists.

### Parameters
- **identifier** (string) - The unique identifier of the structure.
```

--------------------------------

### get

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.StructureManager.html

Retrieves a structure by its identifier.

```APIDOC
## get(identifier: string): Structure | undefined

### Description
Returns the structure associated with the provided identifier, or undefined if not found.

### Parameters
- **identifier** (string) - The unique identifier of the structure.
```

--------------------------------

### Registering Custom Commands with CustomCommandRegistry

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.CustomCommandRegistry-1.html

Demonstrates how to define custom commands with mandatory and optional parameters, register them with callbacks, and hook into the startup event.

```typescript
import {  
   CustomCommandRegistry,  
   CustomCommand,  
   CustomCommandParamType,  
   CommandPermissionLevel,  
   CustomCommandOrigin,  
   CustomCommandResult,  
   CustomCommandStatus,  
   system,  
   Player,  
} from "@minecraft/server";  
  
// Example of registering custom commands using CustomCommandRegistry  
function registerCustomCommands(registry: CustomCommandRegistry) {  
   // Register an enum for command parameters  
   registry.registerEnum("custom:teleportTargets", ["spawn", "home", "end", "nether"]);  
  
   // Define a simple teleport command  
   const teleportCommand: CustomCommand = {  
       name: "custom:teleport",  
       description: "Teleport to predefined locations",  
       permissionLevel: CommandPermissionLevel.Admin,  
       cheatsRequired: true,  
       mandatoryParameters: [  
           {  
               name: "custom:teleportTargets",  
               type: CustomCommandParamType.Enum,  
           },  
       ],  
       optionalParameters: [  
           {  
               name: "player",  
               type: CustomCommandParamType.PlayerSelector,  
           },  
       ],  
   };  
  
   // Register the command with a callback  
   registry.registerCommand(teleportCommand, (origin: CustomCommandOrigin, args: [string, Player | undefined]) => {  
       const [teleportTargets, targetPlayer] = args;  
  
       console.log(`Teleport command executed by ${origin.sourceType}`);  
       console.log(`Destination: ${teleportTargets}`);  
  
       if (origin.sourceEntity) {  
           console.log(`Command source entity: ${origin.sourceEntity.typeId}`);  
       }  
  
       // Perform teleportation logic here  
       const result: CustomCommandResult = {  
           status: CustomCommandStatus.Success,  
           message: `Teleported to ${teleportTargets}`,  
       };  
  
       return result;  
   });  
  
   // Define a more complex command with multiple parameter types  
   const giveItemCommand: CustomCommand = {  
       name: "custom:giveitem",  
       description: "Give items to players with custom parameters",  
       permissionLevel: CommandPermissionLevel.GameDirectors,  
       cheatsRequired: false,  
       mandatoryParameters: [  
           {  
               name: "item",  
               type: CustomCommandParamType.ItemType,  
           },  
           {  
               name: "amount",  
               type: CustomCommandParamType.Integer,  
           },  
       ],  
       optionalParameters: [  
           {  
               name: "target",  
               type: CustomCommandParamType.PlayerSelector,  
           },  
       ],  
   };  
  
   registry.registerCommand(  
       giveItemCommand,  
       (origin: CustomCommandOrigin, args: [string, number, Player | undefined]) => {  
           const [itemType, amount, targetPlayer] = args;  
  
           // Command execution logic  
           return {  
               status: CustomCommandStatus.Success,  
               message: `Gave ${amount} ${itemType} to player`,  
           };  
       }  
   );  
}  
  
// Example usage during startup  
// This would typically be called in a startup event handler  
system.beforeEvents.startup.subscribe((startupEvent) => {  
   registerCustomCommands(startupEvent.customCommandRegistry);  
});
```

--------------------------------

### getComponent

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.Block-1.html

Gets a component for a block.

```APIDOC
## getComponent<T extends string>(componentId: T): BlockComponentReturnType<T> | undefined

### Description
Gets a component (that represents additional capabilities) for a block - for example, an inventory component of a chest block.

### Parameters
- **componentId** (T) - Required - The identifier of the component.

### Returns
- **BlockComponentReturnType<T> | undefined** - The component if it exists, otherwise undefined.
```

--------------------------------

### Camera Easing Implementation Example

Source: https://jaylydev.github.io/scriptapi-docs/latest/interfaces/_minecraft_server.EaseOptions-1.html

Demonstrates using EaseOptions within a camera sequence to control transition timing and easing curves.

```typescript
       const overheadOptions: CameraSetLocationOptions = {  
           location: overheadLocation,  
           easeOptions: {  
               easeTime: 4.0,  
               easeType: EasingType.InOutSine,  
           },  
       };  
  
       camera.setCamera("minecraft:free", overheadOptions);  
   }, 100); // 5 seconds (100 ticks)  
  
   // Step 3: Return to normal view  
   system.runTimeout(() => {  
       const returnEase: EaseOptions = {  
           easeTime: 2.0,  
           easeType: EasingType.InOutQuad,  
       };  
       camera.setDefaultCamera("minecraft:first_person", returnEase);  
       console.log("Cinematic sequence complete!");  
   }, 200); // 10 seconds (200 ticks)  
}  
  
// Run the demonstrations  
demonstrateCameraEasing();  
  
// Uncomment these to run additional demonstrations  
// demonstrateEasingTypes();  
// createCinematicSequence();
```

--------------------------------

### getSpan()

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-editor.RelativeVolumeListBlockVolume.html

Gets the span of the volume.

```APIDOC
## getSpan(): Vector3

### Description
Returns a Vector3 object where each component represents the number of blocks along that axis.
```

--------------------------------

### startSequence(): GameTestSequence

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.Test.html

Initializes and returns a new GameTestSequence for chaining test actions.

```APIDOC
## startSequence()

### Description
Initializes and returns a new GameTestSequence for chaining test actions.

### Returns
- **GameTestSequence** - A new sequence object to chain test operations.
```

--------------------------------

### AABBUtils.getSpan

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_math.AABBUtils.html

Gets the span of an AABB.

```APIDOC
## AABBUtils.getSpan(aabb: AABB)

### Description
Gets the span of an AABB.

### Parameters
- **aabb** (AABB) - Required - The AABB to retrieve the span of.

### Returns
- **Vector3** - The span of the AABB.

### Throws
- **AABBInvalidExtentError** - Thrown if the input AABB is invalid.
```

--------------------------------

### beginPlaytest

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-editor.PlaytestManager.html

Initiates a new playtest session with the provided game options.

```APIDOC
## beginPlaytest

### Description
Initiates a playtest session using the specified game options. This method returns a promise that resolves to a PlaytestSessionResult.

### Signature
`beginPlaytest(options: GameOptions): Promise<PlaytestSessionResult>`

### Parameters
- **options** (GameOptions) - Required - The configuration options for the playtest session.

### Returns
- **Promise<PlaytestSessionResult>** - A promise that resolves with the result of the playtest session initiation.

### Remarks
- This function cannot be called in restricted-execution mode.
- This function cannot be called in early-execution mode.
- This function may throw errors.
```

--------------------------------

### AABBUtils.getBlockVolume

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_math.AABBUtils.html

Gets the BlockVolume for an AABB.

```APIDOC
## AABBUtils.getBlockVolume(aabb: AABB)

### Description
Creates the smallest BlockVolume that includes all of a source AABB.

### Parameters
- **aabb** (AABB) - Required - The source AABB.

### Returns
- **BlockVolume** - The BlockVolume containing the source AABB.

### Throws
- **AABBInvalidExtentError** - Thrown if the input AABB is invalid.
```

--------------------------------

### Create Aim Assist Preset Settings

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.AimAssistPresetSettings-1.html

Demonstrates how to instantiate AimAssistPresetSettings, configure target exclusions and item settings, and register the preset with the world's aim assist system.

```typescript
import { AimAssistPresetSettings, world } from "@minecraft/server";  
  
// Example of creating aim assist preset settings object  
// This demonstrates the structure needed for aim assist preset configuration  
const presetSettings = new AimAssistPresetSettings("custom:my_preset");  
  
presetSettings.setExcludedTargets(["minecraft:item_frame", "minecraft:painting"]);  
presetSettings.setItemSettings({  
   "minecraft:bow": "custom:ranged_category",  
   "minecraft:crossbow": "custom:ranged_category",  
   "minecraft:sword": "custom:melee_category",  
});  
presetSettings.setLiquidTargetingItems(["minecraft:bucket", "minecraft:water_bucket", "minecraft:lava_bucket"]);  
  
world.getAimAssist().addPreset(presetSettings);
```

--------------------------------

### id

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.SimulatedPlayer.html

Gets the unique identifier of the entity.

```APIDOC
## Property: id

### Description
Returns the unique identifier of the entity, which is consistent across world loads.

### Type
string

### Remarks
Do not parse or interpret the structure of this ID. It is accessible even if Entity.isValid is false. It cannot be read in early-execution mode.
```

--------------------------------

### constructor

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_debug-utilities.DebugCone.html

Creates a new instance of a DebugCone at the specified location.

```APIDOC
## constructor

### Description
Creates a new DebugCone object.

### Signature
`new DebugCone(location: Vector3 | DimensionLocation): DebugCone`

### Parameters
- **location** (Vector3 | DimensionLocation) - The initial location for the cone.
```

--------------------------------

### getState

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.BlockPermutation-1.html

Gets a specific state for the permutation.

```APIDOC
## getState<T extends string | number | symbol>(stateName: T): any

### Description
Gets a state for the permutation.

### Parameters
- **stateName** (T) - Required - Name of the block state who's value is to be returned.

### Returns
- **any** - Returns the state if the permutation has it, else undefined.
```

--------------------------------

### getMin()

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-editor.RelativeVolumeListBlockVolume.html

Gets the smallest corner position.

```APIDOC
## getMin(): Vector3

### Description
Returns the smallest corner position of the volume, guaranteed to be less than or equal to the maximum corner.
```

--------------------------------

### getMax()

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-editor.RelativeVolumeListBlockVolume.html

Gets the largest corner position.

```APIDOC
## getMax(): Vector3

### Description
Returns the largest corner position of the volume, guaranteed to be greater than or equal to the minimum corner.
```

--------------------------------

### Example Usage of Container Operations

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.Container-1.html

Demonstrates basic inventory management tasks such as organizing, collecting, and stacking items for a player.

```javascript
const firstPlayer = world.getAllPlayers()[0];  
if (firstPlayer) {  
   organizeInventory(firstPlayer);  
   autoCollectItems(firstPlayer, ["minecraft:diamond", "minecraft:iron_ingot", "minecraft:gold_ingot"]);  
   smartStackItems(firstPlayer);  
}
```

--------------------------------

### AABBUtils.getMin

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_math.AABBUtils.html

Gets the minimum corner of an AABB.

```APIDOC
## AABBUtils.getMin(aabb: AABB)

### Description
Gets the minimum corner of an AABB.

### Parameters
- **aabb** (AABB) - Required - The AABB to retrieve the minimum corner of.

### Returns
- **Vector3** - The minimum corner of the AABB.

### Throws
- **AABBInvalidExtentError** - Thrown if the input AABB is invalid.
```

--------------------------------

### startSequence

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.Test.html

Creates a new GameTestSequence for chaining steps.

```APIDOC
## startSequence()

### Description
Creates a new GameTestSequence - A set of steps that play out sequentially within a GameTest.

### Returns
- **GameTestSequence** - A new GameTestSequence with chaining methods that facilitate creating a set of steps.
```

--------------------------------

### AABBUtils.getMax

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_math.AABBUtils.html

Gets the maximum corner of an AABB.

```APIDOC
## AABBUtils.getMax(aabb: AABB)

### Description
Gets the maximum corner of an AABB.

### Parameters
- **aabb** (AABB) - Required - The AABB to retrieve the maximum corner of.

### Returns
- **Vector3** - The maximum corner of the AABB.

### Throws
- **AABBInvalidExtentError** - Thrown if the input AABB is invalid.
```

--------------------------------

### addGuideComponent

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-editor.Widget.html

Adds a guide component to the widget.

```APIDOC
## addGuideComponent(componentName: string, options?: WidgetComponentGuideOptions)

### Description
Adds a guide component to the widget.

### Parameters
- **componentName** (string) - Required - The name of the component.
- **options** (WidgetComponentGuideOptions) - Optional - Additional configuration options.

### Returns
- **WidgetComponentGuide** - The created guide component.
```

--------------------------------

### removePlane

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-editor.GuidePlaneManager.html

Removes a guide plane from the manager.

```APIDOC
## removePlane(planeId: string): void

### Description
Removes an existing guide plane from the manager using its ID.

### Parameters
- **planeId** (string) - The ID of the plane to remove.
```

--------------------------------

### Implement Camera Easing with EaseOptions

Source: https://jaylydev.github.io/scriptapi-docs/latest/interfaces/_minecraft_server.EaseOptions-1.html

Demonstrates applying various easing configurations to camera location, rotation, and default presets using the Minecraft Script API.

```typescript
import {  
   world,  
   system,  
   Camera,  
   EaseOptions,  
   EasingType,  
   CameraSetLocationOptions,  
   CameraSetRotOptions,  
   Vector3,  
} from "@minecraft/server";  
  
// Example of using the new Camera setDefaultCamera method with EaseOptions  
function demonstrateCameraEasing() {  
   const players = world.getAllPlayers();  
  
   players.forEach((player) => {  
       const camera = player.camera;  
  
       // Check if camera is valid  
       if (!camera.isValid) {  
           console.log("Camera is not valid");  
           return;  
       }  
  
       console.log(`Setting up camera easing for ${player.name}`);  
  
       // Example 1: Set default camera with easing  
       const easeOptions: EaseOptions = {  
           easeTime: 3.0, // 3 seconds  
           easeType: EasingType.InOutSine,  
       };  
  
       camera.setDefaultCamera("minecraft:first_person", easeOptions);  
       console.log("Set default camera with smooth easing");  
  
       // Example 2: Set camera location with easing  
       const newLocation: Vector3 = {  
           x: player.location.x + 10,  
           y: player.location.y + 5,  
           z: player.location.z + 10,  
       };  
  
       const locationOptions: CameraSetLocationOptions = {  
           location: newLocation,  
           easeOptions: {  
               easeTime: 2.5,  
               easeType: EasingType.InOutCubic,  
           },  
       };  
  
       system.runTimeout(() => {  
           camera.setCamera("minecraft:free", locationOptions);  
           console.log("Moved camera to new location with easing");  
       }, 80); // Wait 4 seconds (80 ticks) after first camera change  
  
       // Example 3: Set camera rotation with easing  
       const rotationOptions: CameraSetRotOptions = {  
           rotation: { x: -30, y: 45 }, // Look down at 30 degrees, turn 45 degrees  
           easeOptions: {  
               easeTime: 1.5,  
               easeType: EasingType.InOutQuad,  
           },  
       };  
  
       system.runTimeout(() => {  
           camera.setCamera("minecraft:free", rotationOptions);  
           console.log("Changed camera rotation with easing");  
       }, 140); // Wait 7 seconds (140 ticks)  
  
       // Example 4: Reset to default after demonstration  
       system.runTimeout(() => {  
           const resetEase: EaseOptions = {  
               easeTime: 2.0,  
               easeType: EasingType.InOutSine,  
           };  
           camera.setDefaultCamera("minecraft:first_person", resetEase);  
           console.log("Reset camera to first person view");  
       }, 10000); // Reset after 10 seconds  
   });  
}  
  
// Example: Demonstrate different easing types  
function demonstrateEasingTypes() {  
   const player = world.getAllPlayers()[0];  
   if (!player) return;  
  
   const camera = player.camera;  
   if (!camera.isValid) return;  
  
   const easingTypes = [  
       EasingType.InQuad,  
       EasingType.OutQuad,  
       EasingType.InOutQuad,  
       EasingType.InCubic,  
       EasingType.OutCubic,  
       EasingType.InOutCubic,  
       EasingType.InSine,  
       EasingType.OutSine,  
       EasingType.InOutSine,  
   ];  
  
   console.log("Demonstrating different easing types...");  
  
   easingTypes.forEach((easingType, index) => {  
       system.runTimeout(() => {  
           const easeOptions: EaseOptions = {  
               easeTime: 1.0,  
               easeType: easingType,  
           };  
  
           // Alternate between two camera presets to show the easing effect  
           const preset = index % 2 === 0 ? "minecraft:third_person_front" : "minecraft:third_person";  
           camera.setDefaultCamera(preset, easeOptions);  
  
           console.log(`Applied ${EasingType[easingType]} easing`);  
       }, index * 1200); // 1.2 seconds apart  
   });  
}  
  
// Example: Create a cinematic camera sequence  
function createCinematicSequence() {  
   const player = world.getAllPlayers()[0];  
   if (!player) return;  
  
   const camera = player.camera;  
   if (!camera.isValid) return;  
  
   console.log("Starting cinematic camera sequence...");  
  
   // Step 1: Zoom out with smooth easing  
   system.runTimeout(() => {  
       const easeOut: EaseOptions = {  
           easeTime: 3.0,  
           easeType: EasingType.OutCubic,  
       };  
       camera.setDefaultCamera("minecraft:third_person", easeOut);  
   }, 20); // 1 second (20 ticks)  
  
   // Step 2: Move camera to overhead view  
   system.runTimeout(() => {  
       const overheadLocation: Vector3 = {  
           x: player.location.x,  
           y: player.location.y + 20,  
           z: player.location.z,  
       };  

```

--------------------------------

### get

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.StructureManager-1.html

Retrieves a structure that is saved to memory or the world.

```APIDOC
## get(identifier: string)

### Description
Gets a Structure that is saved to memory or the world.

### Parameters
- **identifier** (string) - Required - The name of the structure to get.

### Returns
- **Structure | undefined** - Returns a Structure if it exists, otherwise undefined.
```

--------------------------------

### Create and Show a Modal Form

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-ui.ModalFormData.html

Demonstrates how to instantiate a ModalFormData object, add various input fields, and handle the user's response after showing the form to a player.

```javascript
import { Player, world } from "@minecraft/server";  
import { ModalFormData } from "@minecraft/server-ui";  
let form = new ModalFormData();  
let effectList = [  
  { name: "Regeneration", id: "minecraft:regeneration" },  
  { name: "Resistance", id: "minecraft:resistance" },  
  { name: "Fire Resistance", id: "minecraft:fire_resistance" },  
  { name: "Poison", id: "minecraft:poison" },  
];  
form.title("Effect Generator");  
form.textField("Target", "Target of Effect");  
form.dropdown(  
  "Effect Type",  
  effectList.map((effect) => effect.name)  
);  
form.slider("Effect Level", 0, 255, 1);  
form.toggle("Hide Effect Particle", true);  
for (const player of world.getAllPlayers()) {  
  form.show(player).then((response) => {  
    if (response.canceled) {  
      player.sendMessage("Canceled due to " + response.cancelationReason);  
    } else {  
      const [targetName, dropdownValue, effectLevel, hideParticles] =  
        response.formValues;  
      if (  
        typeof dropdownValue !== "string" ||  
        typeof dropdownValue !== "number" ||  
        typeof effectLevel !== "number" ||  
        typeof hideParticles !== "boolean"  
      )  
        return player.sendMessage("Cannot process form result.");  
      const target = world  
        .getAllPlayers()  
        .find((player) => player.name === targetName);  
      if (!(target instanceof Player))  
        return player.sendMessage("Target does not exist.");  
      target.addEffect(effectList[dropdownValue].id, 50, {  
        amplifier: effectLevel,  
        showParticles: !hideParticles,  
      });  
    }  
  });  
}
```

--------------------------------

### Create a Simple Action Menu with CustomForm

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-ui.CustomForm-1.html

Demonstrates how to register a custom command that opens a menu with buttons, using a helper function to handle user selections.

```typescript
// Adapted from Microsoft's DDUI intro doc:  
// https://learn.microsoft.com/en-us/minecraft/creator/documents/scripting/intro-to-ddui  
import { CustomForm } from "@minecraft/server-ui";  
import { CommandPermissionLevel, CustomCommandStatus, Player, system } from "@minecraft/server";  
  
// This helper keeps the button callbacks easy to read for beginners.  
function runMenuAction(player: Player, action: "play" | "settings" | "exit") {  
   switch (action) {  
       case "play":  
           console.log(`${player.name} selected: Play Game`);  
           break;  
       case "settings":  
           console.log(`${player.name} selected: Settings`);  
           break;  
       case "exit":  
           console.log(`${player.name} selected: Exit`);  
           break;  
   }  
}  
  
// Run /test:simplemenu in chat.  
system.beforeEvents.startup.subscribe((event) => {  
   event.customCommandRegistry.registerCommand(  
       {  
           name: "test:simplemenu",  
           description: "Open a basic DDUI action menu",  
           permissionLevel: CommandPermissionLevel.Any,  
       },  
       (origin) => {  
           const player = origin.sourceEntity;  
           if (!(player instanceof Player)) {  
               return {  
                   message: "This command can only be used by a player.",  
                   status: CustomCommandStatus.Failure,  
               };  
           }  
  
           CustomForm.create(player, "Main Menu")  
               .label("What would you like to do?")  
               .spacer()  
               .button("Play Game", () => runMenuAction(player, "play"))  
               .button("Settings", () => runMenuAction(player, "settings"))  
               .button("Exit", () => runMenuAction(player, "exit"))  
               .show()  
               .catch((e) => {  
                   console.error(e);  
               });  
  
           return {  
               message: "Opening simple menu...",  
               status: CustomCommandStatus.Success,  
           };  
       }  
   );  
});
```

--------------------------------

### get

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.StructureManager.html

Retrieves a Structure that is saved to memory or the world.

```APIDOC
## get(identifier: string): Structure | undefined

### Description
Gets a Structure that is saved to memory or the world.

### Parameters
- **identifier** (string) - Required - The name of the structure to get.

### Returns
- **Structure | undefined** - Returns a Structure if it exists, otherwise undefined.
```

--------------------------------

### getBlocks

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server.Dimension-1.html

Gets all the blocks in a volume that satisfy the filter.

```APIDOC
## getBlocks(volume: BlockVolumeBase, filter: BlockFilter, allowUnloadedChunks?: boolean)

### Description
Gets all the blocks in a volume that satisfy the filter.

### Parameters
- **volume** (BlockVolumeBase) - Required - Volume of blocks that will be checked.
- **filter** (BlockFilter) - Required - Block filter that will be checked against each block in the volume.
- **allowUnloadedChunks** (boolean) - Optional - If set to true will suppress the UnloadedChunksError if some or all of the block volume is outside of the loaded chunks. Defaults to: false.

### Returns
- **ListBlockVolume** - Returns the ListBlockVolume that contains all the block locations that satisfied the block filter.

### Remarks
This function can't be called in early-execution mode. Throws UnloadedChunksError.
```

--------------------------------

### show()

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-ui.MessageBox-1.html

Displays the message box to the player.

```APIDOC
## show()

### Description
Shows the message box to the player. Returns a promise that resolves with a MessageBoxResult containing the close reason and the player's button selection.

### Returns
- **Promise<MessageBoxResult>**
```

--------------------------------

### getSpawnPoint()

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.SimulatedPlayer.html

Gets the current spawn point of the player.

```APIDOC
## getSpawnPoint()

### Description
Gets the current spawn point of the player.

### Returns
- **DimensionLocation | undefined** - The spawn point location or undefined if not set.
```

--------------------------------

### getPing()

Source: https://jaylydev.github.io/scriptapi-docs/latest/classes/_minecraft_server-gametest.SimulatedPlayer.html

Gets the player's ping in milliseconds.

```APIDOC
## getPing()

### Description
Returns the player's ping in milliseconds.

### Returns
- **number** - The player's ping in milliseconds.
```
Tokens:
Raw