Generic Player Object

Constructors

Properties

_controller: OHD
_events: EventEmitter
created: Date
id: number
name: string
steam64: null | string

Accessors

  • get isBot(): boolean

    Is the player a Bot

    Returns boolean

Methods

  • Ban the current Player

    Parameters

    • duration: number = 0
    • Optionalreason: string

    Returns Promise<{ reason: string; success: false }> | Promise<PlayerBanned>

  • Returns Promise<{ reason: string; success: false }>

  • Kick the current Player

    Parameters

    • reason: string = 'You have been Kicked!'

    Returns Promise<{ reason: string; success: false }> | Promise<PlayerKicked>

  • The player has Left the Server

    Parameters

    • event: "PLAYER_LEFT"
    • cb: () => void

    Returns EventEmitter

  • The player has been cleared out of memory

    Parameters

    • event: "PLAYER_DELETED"
    • cb: () => void

    Returns EventEmitter

  • The player has been Kicked

    Parameters

    Returns EventEmitter

  • The player has been Banned

    Parameters

    Returns EventEmitter

  • Parameters

    • event: string | symbol
    • cb: (...args: any[]) => void

    Returns EventEmitter

  • Set the team of the current Player

    Parameters

    Returns Promise<unknown>