Minecraft Script API Reference Documentation

https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/
Admin
This documentation provides a reference for the experimental Script APIs for Minecraft: Bedrock...
Tokens:704,062
Snippets:8,216
Trust Score:10
Update:6 days ago
Show doc for...
Tokens:
Raw
### startBuild

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-gametest/simulatedplayer

Starts building with the simulated player.

```APIDOC
## startBuild

### Description
Starts building with the simulated player.

### Method
startBuild

### Parameters
- **slot** (number) - Optional - Default: `0`.

### Returns
void

### Notes
- This function can't be called in restricted-execution mode.
- This function can throw errors.
```

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

### getFirstHotbarItem.ts - getItem example

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/container

Example for the getItem method. Iterates over all players, gets their inventory component, and retrieves the item in slot 0 (first hotbar slot). Logs the item type ID if present and returns the item stack. Requires the player to have an inventory component.

```TypeScript
import { world, EntityInventoryComponent, DimensionLocation } from '@minecraft/server';

function getFirstHotbarItem(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  for (const player of world.getAllPlayers()) {
    const inventory = player.getComponent(EntityInventoryComponent.componentId) as EntityInventoryComponent;
    if (inventory && inventory.container) {
      const firstItem = inventory.container.getItem(0);

      if (firstItem) {
        log('First item in hotbar is: ' + firstItem.typeId);
      }

      return inventory.container.getItem(0);
    }
    return undefined;
  }
}

```

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

### getAll

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/effecttypes

Gets all effects available in the system.

```APIDOC
## getAll

### Description
Gets all effects.

### Method
static getAll(): EffectType[]

### Returns
- **EffectType[]** - A list of all effects.
```

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

### getPresets(): AimAssistPreset[]

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/aimassistregistry

Gets all available presets in the registry.

```APIDOC
## getPresets(): AimAssistPreset[]

### Description
Gets all available presets in the registry.

### Method
getPresets

### Returns
AimAssistPreset[] - An array of all available preset objects.
```

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

### getTotalXp(): number

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/player

Gets the total experience of the Player.

```APIDOC
## getTotalXp(): number

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

### Method
Function

### Signature
`getTotalXp(): number`

### Returns
- **number** - The total experience of the Player.

### Notes
- This function can throw errors.
```

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

### transferBetweenContainers.ts - transferItem example

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/container

TypeScript example showing how to use the transferItem method to transfer an item from a player's inventory to a chest minecart's inventory. It spawns a chest minecart, gets the player's inventory component, and calls transferItem(0, toInventory.container).

```TypeScript
import { world, EntityInventoryComponent, EntityComponentTypes, DimensionLocation } from '@minecraft/server';
import { MinecraftEntityTypes } from '@minecraft/vanilla-data';

function transferBetweenContainers(targetLocation: DimensionLocation) {
  const players = world.getAllPlayers();

  const chestCart = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.ChestMinecart, {
    x: targetLocation.x + 1,
    y: targetLocation.y,
    z: targetLocation.z,
  });

  if (players.length > 0) {
    const fromPlayer = players[0];

    const fromInventory = fromPlayer.getComponent(EntityComponentTypes.Inventory) as EntityInventoryComponent;
    const toInventory = chestCart.getComponent(EntityComponentTypes.Inventory) as EntityInventoryComponent;

    if (fromInventory && toInventory && fromInventory.container && toInventory.container) {
      fromInventory.container.transferItem(0, toInventory.container);
    }
  }
}

```

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

### activateTutorial

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/builtinuimanager

Activates the tutorial overlay for the player.

```APIDOC
## activateTutorial()

### Description
Activates tutorial overlay.

### Method
activateTutorial

### Signature
`activateTutorial(): void`

### Parameters
None

### Returns
void
```

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

### IIntroductionPaneOptions Interface

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/iintroductionpaneoptions

The options to create introduction pane. Extends IPropertyPaneOptions.

```APIDOC
## IIntroductionPaneOptions Interface

### Description
The options to create introduction pane.

### Extends
- _IPropertyPaneOptions_

### Properties

#### title
`title?: LocalizedString;`

Localized title of the property pane

Type: _LocalizedString_

#### uniqueId
`uniqueId?: string;`

Unique identifier for the pane

Type: _string_

```

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

### moveBetweenContainers.ts - moveItem example

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/container

TypeScript example showing how to use the moveItem method to move an item from a player's inventory to a chest minecart's inventory. It spawns a chest minecart, gets the player's inventory component, and calls moveItem(0, 0, toInventory.container).

```TypeScript
import { world, EntityInventoryComponent, EntityComponentTypes, DimensionLocation } from '@minecraft/server';
import { MinecraftEntityTypes } from '@minecraft/vanilla-data';

function moveBetweenContainers(targetLocation: DimensionLocation) {
  const players = world.getAllPlayers();

  const chestCart = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.ChestMinecart, {
    x: targetLocation.x + 1,
    y: targetLocation.y,
    z: targetLocation.z,
  });

  if (players.length > 0) {
    const fromPlayer = players[0];

    const fromInventory = fromPlayer.getComponent(EntityComponentTypes.Inventory) as EntityInventoryComponent;
    const toInventory = chestCart.getComponent(EntityComponentTypes.Inventory) as EntityInventoryComponent;

    if (fromInventory && toInventory && fromInventory.container && toInventory.container) {
      fromInventory.container.moveItem(0, 0, toInventory.container);
    }
  }
}

```

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

### navigateToSamples

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/builtinuimanager

Navigates to the github-samples site.

```APIDOC
## navigateToSamples()

### Description
Navigates to the github-samples site.

### Method
navigateToSamples

### Signature
`navigateToSamples(): void`

### Parameters
None

### Returns
void
```

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

### givePlayerElytra.ts - Give player Elytra using EntityEquippableComponent

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/entityequippablecomponent

TypeScript example that gives the player Elytra by getting the Equippable component and setting the chest equipment slot. Uses @minecraft/server and @minecraft/vanilla-data imports.

```TypeScript
// Gives the player Elytra
import { EquipmentSlot, ItemStack, Player, EntityComponentTypes } from '@minecraft/server';
import { MinecraftItemTypes } from '@minecraft/vanilla-data';

function giveEquipment(player: Player) {
  const equipmentCompPlayer = player.getComponent(EntityComponentTypes.Equippable);
  if (equipmentCompPlayer) {
    equipmentCompPlayer.setEquipment(EquipmentSlot.Chest, new ItemStack(MinecraftItemTypes.Elytra));
  }
}

```

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

### addTranslatedSign.ts - Set a sign with translated text

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/blockpermutation

This example finds the first player, gets a sign block at the target location, sets its permutation to a standing sign with a specific direction, and then sets the sign's text using a translation key and player name.

```TypeScript
import { world, BlockPermutation, BlockSignComponent, BlockComponentTypes, DimensionLocation } from '@minecraft/server';
import { MinecraftBlockTypes } from '@minecraft/vanilla-data';

function addTranslatedSign(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  const players = world.getPlayers();

  const dim = players[0].dimension;

  const signBlock = dim.getBlock(targetLocation);

  if (!signBlock) {
    log('Could not find a block at specified location.');
    return -1;
  }
  const signPerm = BlockPermutation.resolve(MinecraftBlockTypes.StandingSign, { ground_sign_direction: 8 });

  signBlock.setPermutation(signPerm);

  const signComponent = signBlock.getComponent(BlockComponentTypes.Sign) as BlockSignComponent;

  signComponent?.setText({ translate: 'item.skull.player.name', with: [players[0].name] });
}

```

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

### getAll

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/audiosettings

Retrieves all audio settings properties.

```APIDOC
## getAll

### Description
Retrieves all audio settings properties.

### Method
`getAll(): AudioSettingsPropertyTypeMap`

### Returns
_AudioSettingsPropertyTypeMap_
```

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

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

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/structuremanager

Gets 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.

### Method
get

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

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

### Notes
- This function can't be called in restricted-execution mode.
```

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

### createIntroductionPane

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/ipanemanager

Creates a pane to be shown on the introduction window.

```APIDOC
## createIntroductionPane

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

### Method
createIntroductionPane

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

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

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

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

### createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void, flatLayout?: boolean): ISubPanePropertyItem | undefined

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/brushshape

Creates a settings pane for the brush shape.

```APIDOC
## Method: createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void, flatLayout?: boolean): ISubPanePropertyItem | undefined

### Description
Creates a settings pane for the brush shape.

### Parameters
- **parentPane** (IPropertyPane) - Required - The parent property pane.
- **onSettingsChange** (() => void) - Optional - Callback invoked when settings change.
- **flatLayout** (boolean) - Optional - Whether to use a flat layout.

### Returns
- **ISubPanePropertyItem | undefined** - The created sub-pane property item, or undefined if not created.
```

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

### get(name: string): unknown | undefined

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-admin/servervariables

Documentation for the get method of the ServerVariables class, which retrieves a configured server variable.

```APIDOC
## [GET] variables.get(name)

### Description
Returns the value of a variable that has been configured in a dedicated server configuration JSON file.

### Method
GET

### Endpoint
variables.get(name)

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the server variable to retrieve.

### Response
#### Success Response (200)
- **value** (unknown | undefined) - The value of the configured server variable, or undefined if not found.

#### Response Example
```json
{
  "value": "https://example.com"
}
```

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

### Example
```typescript
import { variables } from '@minecraft/server-admin';

const serverUrl = variables.get('serverEndpoint');
```
```

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

### new WidgetComponentRenderPrimitiveTypeLine(start, end, color)

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/widgetcomponentrenderprimitivetypeline

Creates a new WidgetComponentRenderPrimitiveTypeLine instance with the specified start and end vectors and color.

```APIDOC
## Constructor: new WidgetComponentRenderPrimitiveTypeLine(start, end, color)

### Description
Creates a new WidgetComponentRenderPrimitiveTypeLine instance with the specified start and end vectors and color.

### Method
Constructor

### Parameters
- **start** (@minecraft/server.Vector3) - Required - The starting point of the line.
- **end** (@minecraft/server.Vector3) - Required - The ending point of the line.
- **color** (@minecraft/server.RGBA) - Required - The color of the line.

### Returns
WidgetComponentRenderPrimitiveTypeLine
```

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

### createSettingsPane

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/pyramidbrushshape

Creates a settings pane for the pyramid brush shape.

```APIDOC
## createSettingsPane

### Description
Creates a settings pane for the pyramid brush shape.

### Method
createSettingsPane

### Signature
`createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void, flatLayout?: boolean): ISubPanePropertyItem`

### Parameters
- **parentPane** (IPropertyPane) - Required - The parent property pane.
- **onSettingsChange** (function) - Optional - Callback invoked when settings change.
- **flatLayout** (boolean) - Optional - Whether to use a flat layout.

### Returns
- `ISubPanePropertyItem` - The created sub-pane property item.
```

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

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

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-net/httpclient

Performs a simple HTTP GET request to the specified URI. Returns a promise that resolves to the HTTP response.

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

### Description
Performs a simple HTTP get request.

### Method
get

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

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

### Notes
- This function can be called in early-execution mode.

```

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

### constructor

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/aimassistpresetsettings

Creates a new AimAssistPresetSettings instance with a unique identifier that must have a namespace.

```APIDOC
## constructor

### Description
Creates a new AimAssistPresetSettings instance with a unique identifier that must have a namespace.

### Method
constructor

### Signature
`new AimAssistPresetSettings(identifier: string)`

### Parameters
- **identifier** (string) - Required - A unique Id to associate with the created AimAssistPreset. Must have a namespace.

### Returns
AimAssistPresetSettings
```

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

### constructor(player, title, options?)

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-ui/messagebox

Creates a new MessageBox for the specified player with the given title. Optional configuration can be provided.

```APIDOC
## constructor(player, title, options?)

### Description
Creates a new MessageBox for the specified player with the given title.

### Method
constructor

### Signature
`new MessageBox(player: minecraftserver.Player, title: ObservableString | ObservableUIRawMessage | string | UIRawMessage, options?: MessageBoxOptions)`

### Parameters
- **player** (@minecraft/server.Player) - Required - The player to show this message box to.
- **title** (ObservableString | ObservableUIRawMessage | string | UIRawMessage) - Required - The title text to display at the top of the message box.
- **options** (MessageBoxOptions) - Optional - Optional configuration for the message box, such as the button layout. Defaults to `null`.

### Returns
MessageBox

### Notes
- This function is still in pre-release. Its signature may change or it may be removed in future releases.
- This function can throw errors.
  - Throws @minecraft/server.InvalidEntityError
```

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

### getDimension

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-gametest/test

Gets the dimension of this test.

```APIDOC
## getDimension

### Description
Gets the dimension of this test.

### Method
Function

### Signature
`getDimension(): minecraftserver.Dimension`

### Returns
@minecraft/server.Dimension

### Notes
- This function can throw errors. Throws _GameTestCompletedError_, _GameTestError_.
```

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

### getComponents

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/widget

Gets all components of the widget.

```APIDOC
## getComponents

### Description
Gets all components of the widget.

### Method
getComponents

### Signature
`getComponents(): WidgetComponentBase[]`

### Parameters
None

### Returns
WidgetComponentBase[]

### Notes
- This function can't be called in restricted-execution mode.
- This function can throw errors. Throws InvalidWidgetError.
```

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

### createSettingsPane

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/cuboidbrushshape

Creates a settings pane for the cuboid brush shape.

```APIDOC
## createSettingsPane

### Description
Creates a settings pane for the cuboid brush shape.

### Signature
`createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void, flatLayout?: boolean): ISubPanePropertyItem`

### Parameters
- **parentPane** (IPropertyPane) - Required - The parent property pane.
- **onSettingsChange** (function) - Optional - Callback invoked when settings change.
- **flatLayout** (boolean) - Optional - Whether to use a flat layout.

### Returns
- **ISubPanePropertyItem** - The created sub-pane property item.
```

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

### isMeMarkerShown

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/iminimappropertyitem

Gets me marker visibility.

```APIDOC
## isMeMarkerShown

### Description
Gets me marker visibility.

### Method
isMeMarkerShown(): boolean

### Returns
boolean
```

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

### constructor

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/itemstack

Creates a new instance of a stack of items for use in the world.

```APIDOC
## constructor

### Description
Creates a new instance of a stack of items for use in the world.

### Method
constructor

### Signature
`new ItemStack(itemType: ItemType | string, amount?: number)`

### Parameters
- **itemType** (ItemType | string) - Required - Type of item to create.
- **amount** (number) - Optional - Number of items to place in the stack, between 1-255. The provided value will be clamped to the item's maximum stack size. Note that certain items can only have one item in the stack. Default: `1`. Bounds: [`1`, `255`].

### Returns
- **ItemStack** - The created item stack.

### Notes
- This function can throw errors. Throws if `itemType` is invalid, or if `amount` is outside the range of 1-255.
```

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

### getEntryByIndex

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/icollectiontreefolder

Gets the entry at the index.

```APIDOC
## getEntryByIndex

### Description
Gets the entry at the index.

### Method
getEntryByIndex

### Signature
`getEntryByIndex(index: number): ICollectionTreeEntry | undefined`

### Parameters
- **index** (number) - Required - Index of the entry.

### Returns
ICollectionTreeEntry | undefined
```

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

### createSettingsPane

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/conebrushshape

Creates a settings pane for the cone brush shape.

```APIDOC
## createSettingsPane

### Description
Creates a settings pane for the cone brush shape.

### Method
createSettingsPane

### Signature
`createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void, flatLayout?: boolean): ISubPanePropertyItem`

### Parameters
- **parentPane** (IPropertyPane) - Required - The parent property pane.
- **onSettingsChange** (function) - Optional - Callback invoked when settings change.
- **flatLayout** (boolean) - Optional - Whether to use a flat layout.

### Returns
- **ISubPanePropertyItem** - The created sub-pane property item.
```

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

### getDifficulty

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/world

Gets the difficulty from the world.

```APIDOC
## getDifficulty

### Description
Gets the difficulty from the world.

### Method
getDifficulty

### Signature
`getDifficulty(): Difficulty`

### Returns
- **Difficulty** - Returns the world difficulty.
```

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

### constructor

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/aimassistcategorysettings

Creates a new AimAssistCategorySettings instance with a unique identifier.

```APIDOC
## constructor

### Description
Creates a new AimAssistCategorySettings instance with a unique identifier.

### Method
constructor

### Signature
`new AimAssistCategorySettings(identifier: string)`

### Parameters
- **identifier** (string) - Required - A unique Id to associate with the created AimAssistCategory. Must have a namespace.

### Returns
AimAssistCategorySettings
```

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

### getTags

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/block

Gets the tags of this block.

```APIDOC
## getTags

### Description
Gets the tags of this block.

### Method
getTags

### Returns
string[]
```

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

### getParts

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/block

Gets the parts of this block.

```APIDOC
## getParts

### Description
Gets the parts of this block.

### Method
getParts

### Returns
Block[]
```

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

### getAll

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/speedsettings

Retrieves all speed settings as a map of property names to values.

```APIDOC
## getAll

### Description
Retrieves all speed settings as a map of property names to values.

### Method
`getAll(): SpeedSettingsPropertyTypeMap`

### Returns
`SpeedSettingsPropertyTypeMap`
```

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

### getComponents

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/block

Gets all components of this block.

```APIDOC
## getComponents

### Description
Gets all components of this block.

### Method
getComponents

### Returns
BlockComponent[]
```

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

### getAll

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/graphicssettings

Retrieves all graphics settings properties and their values.

```APIDOC
## getAll

### Description
Retrieves all graphics settings properties and their values.

### Method
`getAll(): GraphicsSettingsPropertyTypeMap`

### Returns
- **GraphicsSettingsPropertyTypeMap** - Returns a property value map for all available properties.
```

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

### createSettingsPane

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/ellipsoidbrushshape

Creates a settings pane for the ellipsoid brush shape.

```APIDOC
## createSettingsPane

### Description
Creates a settings pane for the ellipsoid brush shape.

### Method
createSettingsPane

### Signature
`createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void, flatLayout?: boolean): ISubPanePropertyItem`

### Parameters
- **parentPane** (IPropertyPane) - Required. The parent property pane.
- **onSettingsChange** (function) - Optional. Callback invoked when settings change.
- **flatLayout** (boolean) - Optional. Whether to use a flat layout.

### Returns
- **ISubPanePropertyItem** - The created sub-pane property item.
```

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

### minibiomes.ts - addRider example

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/entityrideablecomponent

Example from the minibiomes.ts file showing how to use the addRider method to add a pig as a rider to a minecart in a game test. It imports necessary modules and registers a test with a structure and max ticks.

```TypeScript
import { EntityComponentTypes } from '@minecraft/server';
import { Test, register } from '@minecraft/server-gametest';
import { MinecraftBlockTypes, MinecraftEntityTypes } from '@minecraft/vanilla-data';

function minibiomes(test: Test) {
  const minecart = test.spawn(MinecraftEntityTypes.Minecart, { x: 9, y: 7, z: 7 });
  const pig = test.spawn(MinecraftEntityTypes.Pig, { x: 9, y: 7, z: 7 });

  test.setBlockType(MinecraftBlockTypes.Cobblestone, { x: 10, y: 7, z: 7 });

  const minecartRideableComp = minecart.getComponent(EntityComponentTypes.Rideable);

  minecartRideableComp?.addRider(pig);

  test.succeedWhenEntityPresent(MinecraftEntityTypes.Pig, { x: 8, y: 3, z: 1 }, true);
}
register('ChallengeTests', 'minibiomes', minibiomes).structureName('gametests:minibiomes').maxTicks(160);
```

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

### setHighlightsMin

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-graphics/biomecolorgrading

Sets the highlights min.

```APIDOC
## setHighlightsMin()

### Description
Sets the highlights min.

### Method
setHighlightsMin

### Signature
`setHighlightsMin(): void`

### Return Value
void

### Throws
- @minecraft/common.EngineError

### Notes
- This function can't be called in restricted-execution mode.
- This function can throw errors.
```

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

### getComponent

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/widget

Gets a component from the widget by name.

```APIDOC
## getComponent

### Description
Gets a component from the widget by name.

### Method
getComponent

### Signature
`getComponent(componentName: string): WidgetComponentBase`

### Parameters
- **componentName** (string) - Required - The name of the component.

### Returns
WidgetComponentBase

### Notes
- This function can't be called in restricted-execution mode.
- This function can throw errors.
```

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

### getTime

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/itimelineplayer

Gets the playhead time in seconds.

```APIDOC
## getTime

### Description
Gets the playhead time in seconds.

### Method
getTime(): number

### Returns
number
```

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

### setHorizonBlendStart

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-graphics/biomeatmospherics

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

```APIDOC
## setHorizonBlendStart

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

### Method
Function

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

### Parameters
- **blendStart** (number | Record<number, number>) - Required - Either a number (range [0,1]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a number (range [0,1]) to signify a time of day (0.0 and 1.0 are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is sunrise). The value is also a number (range [0,1]).

### Notes
- This function can't be called in restricted-execution mode.
- This function can throw errors.
  - Throws _@minecraft/common.InvalidArgumentError_

### Return Value
void
```

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

### addExperience(amount: number): number

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/player

Adds or removes experience to/from the Player and returns the current experience of the Player.

```APIDOC
## addExperience(amount: number): number

### Description
Adds or removes experience to/from the Player and returns the current experience of the Player.

### Method
Function

### Signature
`addExperience(amount: number): number`

### Parameters
- **amount** (number) - Required - Amount of experience to add. Note that this can be negative. Bounds: [-16777216, 16777216].

### Returns
- **number** - Returns the current experience of the Player.

### Notes
- This function can't be called in restricted-execution mode.
- This function can throw errors.
```

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

### getPlaybackState

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/itimelineplayer

Gets the current playback state.

```APIDOC
## getPlaybackState

### Description
Gets the current playback state.

### Method
getPlaybackState(): TimelinePlayerPlaybackState

### Returns
TimelinePlayerPlaybackState
```

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

### getGroups

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/itimelineplayer

Gets the current list of groups.

```APIDOC
## getGroups

### Description
Gets the current list of groups.

### Method
getGroups(): ITimelinePlayerGroup[]

### Returns
ITimelinePlayerGroup[]
```

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

### constructor(player, title)

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-ui/messagebox

Creates a new MessageBox for the specified player with the given title. This is a convenience overload without options.

```APIDOC
## constructor(player, title)

### Description
Creates a new MessageBox for the specified player with the given title.

### Method
constructor

### Signature
`new MessageBox(player: minecraftserver.Player, title: ObservableString | ObservableUIRawMessage | string | UIRawMessage)`

### Parameters
- **player** (@minecraft/server.Player) - Required - The player to show this message box to.
- **title** (ObservableString | ObservableUIRawMessage | string | UIRawMessage) - Required - The title text to display at the top of the message box.

### Returns
MessageBox

### Notes
- This function can throw errors.
  - Throws @minecraft/server.InvalidEntityError
```

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

### setHorizonBlendMieStart

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-graphics/biomeatmospherics

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

```APIDOC
## setHorizonBlendMieStart

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

### Method
Function

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

### Parameters
- **blendMieStart** (number | Record<number, number>) - Required - Either a number (range [0,1.2]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a number (range [0,1]) to signify a time of day (0.0 and 1.0 are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is sunrise). The value is also a number (range [0,1.2]).

### Notes
- This function can't be called in restricted-execution mode.
- This function can throw errors.
  - Throws _@minecraft/common.InvalidArgumentError_

### Return Value
void
```

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

### getDuration

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/itimelineplayer

Gets the total duration in seconds.

```APIDOC
## getDuration

### Description
Gets the total duration in seconds.

### Method
getDuration(): number

### Returns
number
```

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

### getEntryById

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/icollectiontreefolder

Gets the entry by its unique identifier.

```APIDOC
## getEntryById

### Description
Gets the entry by its unique identifier.

### Method
getEntryById

### Signature
`getEntryById(id: string): ICollectionTreeEntry | undefined`

### Parameters
- **id** (string) - Required - Identifier of the folder.

### Returns
ICollectionTreeEntry | undefined
```

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

### createRootPane

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/ipanemanager

Creates a root pane.

```APIDOC
## createRootPane

### Description
Creates a root pane.

### Method
createRootPane

### Signature
`createRootPane(options: IRootPropertyPaneOptions): IRootPropertyPane`

### Parameters
- **options** (IRootPropertyPaneOptions) - Required - The options for the root property pane.

### Returns
- **IRootPropertyPane** - The created root property pane.
```

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

### getStructure

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/editorstructuremanager

Gets an editor structure by its ID.

```APIDOC
## getStructure

### Description
Gets an editor structure by its ID.

### Method
getStructure

### Signature
`getStructure(id: string): EditorStructure`

### Parameters
- **id** (string) - Required - The ID of the structure to retrieve.

### Returns
EditorStructure

### Notes
- This function can't be called in restricted-execution mode.
- This function can throw errors.
```

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

### Create HTTP headers for a request (simpleHttpRequest.ts)

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-net/httpheader

TypeScript example from the simpleHttpRequest.ts file. It creates an HttpRequest, sets its body, method, and headers using HttpHeader instances, then sends it with http.request. The example uses the '@minecraft/server-net' module and demonstrates the HttpHeader constructor with 'Content-Type' and 'auth' headers.

```TypeScript
import { HttpRequest, HttpHeader, HttpRequestMethod, http } from '@minecraft/server-net';

async function updateScore() {
  const req = new HttpRequest('http://localhost:3000/updateScore');

  req.body = JSON.stringify({
    score: 22,
  });

  req.method = HttpRequestMethod.Post;
  req.headers = [new HttpHeader('Content-Type', 'application/json'), new HttpHeader('auth', 'my-auth-token')];

  await http.request(req);
}

```

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

### get

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/enchantmenttypes

Retrieves an enchantment with the specified identifier.

```APIDOC
## get

### Description
Retrieves an enchantment with the specified identifier.

### Method
static get

### Signature
`static get(enchantmentId: string): EnchantmentType | undefined`

### Parameters
- **enchantmentId** (string) - Required - Identifier of the enchantment. For example, "minecraft:flame".

### Returns
- **EnchantmentType** | **undefined** - If available, returns an EnchantmentType object that represents the specified enchantment.
```

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

### constructor

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-editor/conebrushshape

Constructs a new instance of the ConeBrushShape class with optional settings.

```APIDOC
## constructor

### Description
Constructs a new instance of the `ConeBrushShape` class.

### Method
constructor

### Signature
`new ConeBrushShape(settings?: { uniform?: boolean; radius?: number; width?: number; height?: number; depth?: number; maxRadius?: number; maxHeight?: number; xRotation?: number; yRotation?: number; zRotation?: number; hollow?: boolean; thickness?: number; enableHollowSettings?: boolean; })`

### Parameters
- **settings** (object) - Optional - An object containing optional shape settings. Possible properties include:
  - `uniform` (boolean) - Optional
  - `radius` (number) - Optional
  - `width` (number) - Optional
  - `height` (number) - Optional
  - `depth` (number) - Optional
  - `maxRadius` (number) - Optional
  - `maxHeight` (number) - Optional
  - `xRotation` (number) - Optional
  - `yRotation` (number) - Optional
  - `zRotation` (number) - Optional
  - `hollow` (boolean) - Optional
  - `thickness` (number) - Optional
  - `enableHollowSettings` (boolean) - Optional

### Returns
- **ConeBrushShape** - The newly constructed ConeBrushShape instance.
```

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

### Subscribe to piston activation events (pistonAfterEvent.ts)

Source: https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/pistonactivateaftereventsignal

TypeScript example that sets up piston and button blocks, then subscribes to the pistonActivate event to log piston state changes. Requires @minecraft/server and @minecraft/vanilla-data modules. The callback checks if the event location matches the target location.

```TypeScript
import {
  world,
  system,
  BlockPermutation,
  BlockPistonState,
  PistonActivateAfterEvent,
  DimensionLocation,
} from '@minecraft/server';
import { MinecraftBlockTypes } from '@minecraft/vanilla-data';

function pistonAfterEvent(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  // set up a couple of piston blocks
  const piston = targetLocation.dimension.getBlock(targetLocation);
  const button = targetLocation.dimension.getBlock({
    x: targetLocation.x,
    y: targetLocation.y + 1,
    z: targetLocation.z,
  });

  if (piston === undefined || button === undefined) {
    log('Could not find block at location.');
    return -1;
  }

  piston.setPermutation(BlockPermutation.resolve(MinecraftBlockTypes.Piston).withState('facing_direction', 3));
  button.setPermutation(BlockPermutation.resolve(MinecraftBlockTypes.AcaciaButton).withState('facing_direction', 1));

  world.afterEvents.pistonActivate.subscribe((pistonEvent: PistonActivateAfterEvent) => {
    const eventLoc = pistonEvent.piston.block.location;

    if (eventLoc.x === targetLocation.x && eventLoc.y === targetLocation.y && eventLoc.z === targetLocation.z) {
      log(
        'Piston event at ' +
          system.currentTick +
          (pistonEvent.piston.isMoving ? ' Moving' : '') +
          (pistonEvent.piston.state === BlockPistonState.Expanding ? ' Expanding' : '') +
          (pistonEvent.piston.state === BlockPistonState.Expanded ? ' Expanded' : '') +
          (pistonEvent.piston.state === BlockPistonState.Retracting ? ' Retracting' : '') +
          (pistonEvent.piston.state === BlockPistonState.Retracted ? ' Retracted' : '')
      );
    }
  });
}

```
Tokens:
Raw