Class CommandUtils

This is a collection of utility methods for working with commands until a proper API is available. Once a proper API is available and stable, I'll change function to use that instead and mark it as deprecated.

Hierarchy

CommandUtils

Index

Constructors

Methods

addCameraShake destroyBlock setInputPermission stopCameraShake

Constructors

constructor

new CommandUtils(): CommandUtils
Returns CommandUtils

Methods

`Static` addCameraShake

addCameraShake(player, type, intensity, duration): void
Adds camera shake effect to the specified player.
Parameters
- player: Player
  
  The player to apply the camera shake effect to.
- type: CameraShakeType
  
  The type of camera shake effect.
- intensity: number
  
  The intensity of the camera shake effect.
- duration: number
  
  The duration of the camera shake effect in seconds.
Returns void
- Defined in index.d.ts:1109

`Static` destroyBlock

destroyBlock(dimension, location): void
Destroys the block as if it's broken by a player.
Parameters
- dimension: Dimension
  
  The dimension in which to destroy the block.
- location: Vector3
  
  The location of the block to destroy.
Returns void
- Defined in index.d.ts:1120

`Static` setInputPermission

setInputPermission(player, permission, value): void
Sets the input permission for a player.
Parameters
- player: Player
  
  The player for whom to set the input permission.
- permission: InputPermission
  
  The input permission to set.
- value: boolean
  
  The value to set the input permission to.
Returns void

Deprecated
Use player.inputPermissions.setPermissionCategory instead.
- Defined in index.d.ts:1101

`Static` stopCameraShake

stopCameraShake(player): void
Stops the camera shake for the specified player.
Parameters
- player: Player
  
  The player for whom to stop the camera shake.
Returns void
- Defined in index.d.ts:1114