Client

Extends EventEmitter

The main hub for interacting with the higher level gametest API.

warning

You should never have to construct this class yourself. Timers depend on its initialization before being exported.

import { client } from 'beapi-core';

client.executeCommand('say Hello :)');

Constructor

new Client();

Properties

players READONLY

Manager for all currently connected players.

Type: PlayerManager

---

entities READONLY

Manager for all active entities in the world.

Type: EntityManager

---

commands READONLY

Manager for controlling BeAPI commands.

Type: CommandManager

---

world READONLY

Manager for doing tasks as the world.

Type: WorldManager

---

currentVersion READONLY

BeAPI-core current version.

Type: string

---

currentMCBE READONLY

note

We may forget to update, please submit an issue if outdated.

Minecraft Bedrock Edition current version.

Type: string

---

currentProtocol READONLY

note

We may forget to update, please submit an issue if outdated.

Minecraft Bedrock Edition current protocol version.

Type: number

---

Methods

loadEvent

Add an event to BeAPI client.

loadEvent(event);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	AbstractEvent	❌	undefined	Extended AbstractEvent constructor.

Returns

void

---

removeEvent

Add an event to BeAPI client.

loadEvent(name);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
name	string	❌	undefined	The name of the event.

Returns

void

---

getEvent

Add an event to BeAPI client.

loadEvent(name);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
name	string	❌	undefined	The name of the event.

Returns

AbstractEvent | undefined

---

verifyIEvent

Ensures given event exists in gametests events.

verifyIEvent(name);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
name	string	❌	undefined	The name of the event.

note

The name "custom" will return true because this is telling us the event is not provided by Minecraft.

Returns

boolean

---

getAllIEvents

Returns the names of all gametest events.

getAllIEvents();

Returns

string[]

---

executeCommand

Execute a command as system admin.

executeCommand(cmd, dimension, debug);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
cmd	string	❌	undefined	Minecraft command to execute.
dimension	Dimension?	✔️	overworld	Dimension to execute given command in.
debug	boolean?	✔️	false	Pipe logs to debug console.

Returns

ServerCommandResponse

---

Events

OnChat

Emitted on player chat message.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	OnChatEvent	-	-	Chat data.

---

OnJoin

Emitted on player join.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

OnLeave

Emitted on player leave.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player | string	-	-	Player instance or player name.

---

Tick

Emitted on every tick (1 /50ms).

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
tick	TickEvent	-	-	Tick data.

---

ItemUse

Emitted on item usage.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	ItemUseEvent	-	-	Item use data.

---

ItemInteract

Emitted on item interact.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	ItemInteractEvent	-	-	Item interact data.

---

EntityDestroyed

Emitted when an entity is destroyed.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
entity	Entity	-	-	Entity that was destroyed.

---

EntityCreated

Emitted when an entity is created.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
entity	Entity	-	-	Entity that was created.

---

BlockDestroyed

Emitted when a client breaks a block.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	ClientBlockBreakEvent	-	-	Block break event data.

---

BlockCreated

Emitted when a client places a block.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	ClientBlockEvent	-	-	Block place event data.

---

PlayerInViewVector

Emitted when a player is in view vector of another player.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	PlayerInViewVectorEvent	-	-	View vector event data.

---

PlayerAttacked

Emitted when a player is attacked.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	PlayerInViewVectorEvent	-	-	View vector event data.

---

EntityInViewVector

Emitted when an entity is in view vector of a player.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	EntityInViewVectorEvent	-	-	View vector event data.

---

EntityAttacked

Emitted when an entity is attacked.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	EntityInViewVectorEvent	-	-	View vector event data.

---

PlayerTag

Emitted when a player recieves a tag prefixed with beapi:.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	PlayerTagEvent	-	-	Player tag event data.

---

EntityTag

Emitted when an entity recieves a tag prefixed with beapi:.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	EntityTagEvent	-	-	Entity tag event data.

---

Explosion

Emitted when on explosion.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
data	ExplosionEvent	-	-	Explosion event data.

---

EnteredWater

Emitted when a player enters water.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

ExitedWater

Emitted when a player exits water.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StartedBurning

Emitted when a player starts burning.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StoppedBurning

Emitted when a player stops burning.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

Jump

Emitted when a player jumps.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

Landed

Emitted when a player lands.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StartedMoving

Emitted when a player starts moving.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StoppedMoving

Emitted when a player stops moving.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StartedRiding

Emitted when a player starts riding.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StoppedRiding

Emitted when a player stops riding.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StartedSleeping

Emitted when a player starts sleeping.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StoppedSleeping

Emitted when a player stops sleeping.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StartedSneaking

Emitted when a player starts sneaking.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StoppedSneaking

Emitted when a player stops sneaking.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StartedSprinting

Emitted when a player starts sprinting.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StoppedSprinting

Emitted when a player stops sprinting.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StartedSwimming

Emitted when a player starts swimming.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

StoppedSwimming

Emitted when a player stops swimming.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

Swing

Emitted when a player swings arm.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

Death

Emitted when a player dies.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---

Respawn

Emitted when a player respawns.

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
player	Player	-	-	Player instance.

---