Class Rust

constructor

• new Rust(config: RustConnectionInfo, settings?: Partial<Settings>): Rust

  Parameters

  • config: RustConnectionInfo
  • settings: Partial<Settings> = {}

  Returns Rust

connectionInfo

banPlayer

• banPlayer(options: BanDTO): Promise<void>

  Parameters

  • options: BanDTO

  Returns Promise<void>

executeConsoleCommand

• executeConsoleCommand(rawCommand: string): Promise<CommandOutput>

  Parameters

  • rawCommand: string

  Returns Promise<CommandOutput>

getEventEmitter

• getEventEmitter(): RustEmitter

  Returns RustEmitter

getMapInfo

• getMapInfo(): Promise<MapInfoDTO>

  Returns Promise<MapInfoDTO>

getMapTile

• getMapTile(_x: number, _y: number, _z: number): Promise<string>

  Parameters

  • _x: number
  • _y: number
  • _z: number

  Returns Promise<string>

getPlayer

• getPlayer(player: IPlayerReferenceDTO): Promise<IGamePlayer | null>

  Parameters

  • player: IPlayerReferenceDTO

  Returns Promise<IGamePlayer | null>

getPlayerInventory

• getPlayerInventory(player: IPlayerReferenceDTO): Promise<IItemDTO[]>

  Parameters

  • player: IPlayerReferenceDTO

  Returns Promise<IItemDTO[]>

getPlayerLocation

• getPlayerLocation(player: IPlayerReferenceDTO): Promise<IPosition | null>

  Parameters

  • player: IPlayerReferenceDTO

  Returns Promise<IPosition | null>

getPlayers

• getPlayers(): Promise<IGamePlayer[]>

  Returns Promise<IGamePlayer[]>

giveItem

• giveItem(
      player: IPlayerReferenceDTO,
      item: string,
      amount?: number,
      _quality?: string,
  ): Promise<void>

  Parameters

  • player: IPlayerReferenceDTO
  • item: string
  • amount: number = 1
  • Optional_quality: string

  Returns Promise<void>

kickPlayer

• kickPlayer(player: IGamePlayer, reason: string): Promise<void>

  Parameters

  • player: IGamePlayer
  • reason: string

  Returns Promise<void>

listBans

• listBans(): Promise<BanDTO[]>

  Returns Promise<BanDTO[]>

listEntities

• listEntities(): Promise<IEntityDTO[]>

  Returns Promise<IEntityDTO[]>

listItems

• listItems(): Promise<IItemDTO[]>

  Returns Promise<IItemDTO[]>

listLocations

• listLocations(): Promise<ILocationDTO[]>

  Returns Promise<ILocationDTO[]>

sendMessage

• sendMessage(message: string, _opts?: IMessageOptsDTO): Promise<void>

  Parameters

  • message: string
  • Optional_opts: IMessageOptsDTO

  Returns Promise<void>

shutdown

• shutdown(): Promise<void>

  Returns Promise<void>

teleportPlayer

• teleportPlayer(
      player: IGamePlayer,
      x: number,
      y: number,
      z: number,
      _dimension?: string,
  ): Promise<void>

  Parameters

  • player: IGamePlayer
  • x: number
  • y: number
  • z: number
  • Optional_dimension: string

  Returns Promise<void>

testReachability

• testReachability(): Promise<TestReachabilityOutputDTO>

  Try and connect to the gameserver If anything goes wrong, this function will report a detailed reason

  Returns Promise<TestReachabilityOutputDTO>

unbanPlayer

• unbanPlayer(player: IPlayerReferenceDTO): Promise<void>

  Parameters

  • player: IPlayerReferenceDTO

  Returns Promise<void>