Class SevenDaysToDie

constructor

• new SevenDaysToDie(
      config: SdtdConnectionInfo,
      settings?: Partial<Settings>,
  ): SevenDaysToDie

  Parameters

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

  Returns SevenDaysToDie

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(): SevenDaysToDieEmitter

  Returns SevenDaysToDieEmitter

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
  • Optionalquality: string

  Returns Promise<void>

kickPlayer

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

  Parameters

  • player: IPlayerReferenceDTO
  • 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[]>

platformIdToGameId

• platformIdToGameId(id: string): Promise<IGamePlayer | undefined>

  Resolve any raw platform id (Steam_…, XBL_…, PSN_…, EOS_…, or a bare id) to an online player. Matching on the normalized platformId keeps this working for platforms that have no dedicated legacy field, PSN included.

  Parameters

  • id: string

  Returns Promise<IGamePlayer | undefined>

sendMessage

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

  Parameters

  • message: string
  • Optionalopts: 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>