Class EvrimaRCON

constructor

• new EvrimaRCON(options: ConnectionOptions): EvrimaRCON

  Creates a client.

  Parameters

  • options: ConnectionOptions

    Connection options.

  Returns EvrimaRCON

Static ReadonlyDEFAULT_PORT

Static ReadonlyDEFAULT_TIMEOUT

Static ReadonlyPERMANENT_BAN

announce

• announce(message: string): Promise<void>

  Sends an announcement message to all online players.

  Parameters

  • message: string

    Message text; max 998 characters.

  Returns Promise<void>

  Throws

  Error if not connected.

ban

• ban(
      name: string,
      steamId: string,
      reason: string,
      duration?: number | null,
  ): Promise<boolean>

  Bans a player.

  Parameters

  • name: string

    Name of the player.

  • steamId: string

    SteamID64 of the player.

  • reason: string

    Reason; must not contain ,.

  • duration: number | null = EvrimaRCON.PERMANENT_BAN

    Duration in seconds; 0, null and Infinity ban permanently.

  Returns Promise<boolean>

  whether the player was online and got kicked; the ban applies either way.

  Throws

  RangeError if the duration is not a non-negative integer, Infinity or null.

  Throws

  Error if not connected.

close

• close(): void

  Closes the connection to the server.

  Returns void

connect

• connect(): Promise<void>

  Connects to the server and authenticates.

  Returns Promise<void>

  Throws

  Error if authentication fails.

kick

• kick(steamId: string, reason: string): Promise<boolean>

  Kicks a player.

  Parameters

  • steamId: string

    SteamID64 of the player.

  • reason: string

    Reason; must not contain ,.

  Returns Promise<boolean>

  whether the player was online and got kicked.

  Throws

  Error if not connected.

listPlayerData

• listPlayerData(): Promise<Character[]>

  Lists character data of all online players.

  Returns Promise<Character[]>

  Character data of each online player.

  Throws

  Error if not connected.

listPlayers

• listPlayers(): Promise<Player[]>

  Lists online players.

  Returns Promise<Player[]>

  Online players.

  Throws

  Error if not connected.

wipeCorpses

• wipeCorpses(): Promise<void>

  Wipes all corpses.

  Returns Promise<void>

  Throws

  Error if not connected.