Skip to main content

Player class

not to be confused with User

Properties​

username string

username​

The Player's Roblox username

userID string

userID​

The Player's Roblox user ID

server Server

server​

The Player's Roblox user ID

permissions UserPermissionsType

permissions​

The permissions the Player has

team string

team​

The name of the team the Player is on

callsign string

callsign​

The Player's callsign (null if on civilian)

Methods​

constructor(username : string, userID : string, server: Server, permission: UserPermissionsType, team: string, callsign?: string) returns Player

constructor​

Creates a Player object with the provided information

kick(reason: string) returns void

kick​

Kick the Player from the server with the given reason

ban() returns void

ban​

Ban the Player from the server

getUser() returns Promise<User>

getUser​

Get the Roblox User from the Player