Ban

API reference for Ban in @erlcjs/core.

Represents a player banned from an ER:LC server.

Signature:

declare class Ban extends Base

Extends: Base

#Constructors

Constructor

Modifiers

Description

(constructor)(server, playerId, username)

Creates an instance of Ban.

#Properties

Property

Modifiers

Type

Description

player?

Player

(Optional) The Player instance representing the banned player, if they are online.

playerId

number

The UserId of the banned player.

username?

string

(Optional) The Roblox username of the banned player, if known.

#Methods

Method

Modifiers

Description

_patch(playerId, username)

Patches the Ban structure with new raw data.