Interface Game

Hierarchy

Game

Index

Methods

captureCursor executeCommand getDimension getFeaturedServer getInputBinding getLocalPlayer getMousePos getPort getScreenSize getServer getWorld isInUI playSoundUI releaseCursor sendChatMessage

Methods

captureCursor

captureCursor(): void
Captures the mouse cursor (hides it and allows the player to look around using the mouse cursor.)

Returns void
- Defined in game.d.ts:75

executeCommand

executeCommand(cmd): void
Execute an in-game command.
Parameters
- cmd: string
  
  The command to send. Be sure to add '/' before your command.
Returns void
- Defined in game.d.ts:12

getDimension

getDimension(): Dimension
Returns Dimension

Deprecated
use dimension Get the Dimension object.
- Defined in game.d.ts:55

getFeaturedServer

getFeaturedServer(): null | string
Gets the featured server name you are connected to. This will return null if you are not in a featured server.

Featured server examples: "The Hive" "CubeCraft" "InPvP" "Mineplex"

Returns null | string
- Defined in game.d.ts:37

getInputBinding

getInputBinding(name): number
Gets the user's input setting. Usually a key code; for example, "forward" returns KeyCode.W by default.

If this function returns 0, either the key is set to nothing or the specified name was not found.
Parameters
- name: InputBinding
Returns number
- Defined in game.d.ts:87

getLocalPlayer

getLocalPlayer(): null | LocalPlayer
Get your player. This will return null if you are not in a game.

Returns null | LocalPlayer
- Defined in game.d.ts:25

getMousePos

getMousePos(): Vector2
Get the mouse position.

Returns Vector2
- Defined in game.d.ts:70

getPort

getPort(): number
Gets the port of the server you're connected to. If you are not in a server, it returns 0.

Returns number
- Defined in game.d.ts:42

getScreenSize

getScreenSize(): Vector2
Gets the size of the viewport.

Returns Vector2
- Defined in game.d.ts:65

getServer

getServer(): null | string
Gets the server you are connected to. This will return null if you are not in a server.

Returns null | string
- Defined in game.d.ts:30

getWorld

getWorld(): World
Returns World

Deprecated
use world Get the World object.
- Defined in game.d.ts:48

isInUI

isInUI(): boolean
Get whether you are in a UI screen

Returns boolean
- Defined in game.d.ts:60

playSoundUI

playSoundUI(soundName, volume, pitch): void
Plays a sound. Refer to https://www.digminecraft.com/lists/sound_list_pe.php for sounds
Parameters
- soundName: string
  
  The sound name, for example: mob.enderdragon.growl
- volume: number
  
  The volume of the sound. Default is 1
- pitch: number
  
  Pitch of the sound. Default is 1
Returns void
- Defined in game.d.ts:20

releaseCursor

releaseCursor(): void
Releases the mouse cursor.

Returns void
- Defined in game.d.ts:80

sendChatMessage

sendChatMessage(msg): void
Sends a chat message.
Parameters
- msg: string
  
  The message to send.
Returns void
- Defined in game.d.ts:6

Generated using TypeDoc