yolkbot
    Preparing search index...

    Class Player

    A Player in a BaseGameMode

    Index

    Constructors

    Methods

    • Updates the inKotcZone property on the player when the zone changes

      Parameters

      Returns void

    Properties

    activeGun: number

    The active gun (0 = primary, 1 = secondary) the player is using ingame

    admin?: { dbId: string; ip: string }

    The admin information, viewable if the Bot is an admin or something

    character: PlayerCharacter

    The player's skin data and stuff (i don't like writing these my fingers are so tired let me free ive got like 5 classes left today)

    climbing: boolean

    Whether the player is climbing

    grenades: number

    The number of grenades the player has

    hp: number

    The health of the player

    hpShield: number

    The shield health of the player (involves the shield effect)

    id: number

    The player's ingame ID, does not persist between games

    inKotcZone: boolean = false

    Whether the player is in a KoTC zone

    isVip: boolean

    Whether the player is a VIP

    jumping: boolean

    Whether the player is jumping

    name: string

    The player's ingame name

    playing: boolean

    Whether the player is actively spawned in and playing

    position: Position

    The player's physical position ingame

    randomSeed: number

    The random seed the player's aim will use on the next shot

    safeName: string

    The "safe" name sent by the server, if the user has hid player names or if the name is filtered

    scale: number

    The player's scale (involves the Mini Egg powerup)

    scoping: boolean

    Whether the player is scoping

    selectedGun: GunIds

    The selected gun (eggk, scrambler, etc) the player is using as their primary

    shellStreaks: ShellStreak[]

    the player's shellstreaks/powerups

    showBadge: boolean

    Whether the player has opted to show their badge (either VIP or social)

    socials: { id: SocialMedia; type: string; username: string }[]

    The player's social media platforms as displayed ingame

    spawnShield: number

    The "spawn shield" ticks (0 = no spawn shield)

    The player's stats for the specific game

    streak: number

    The player's killstreak

    team: Team

    The team the player is on

    uniqueId: string

    The unique ID associated with the player's account, the first 10 or so characters persist between games and the last 4 are random (iirc)

    The direction the player is looking ingame (yaw/pitch)

    weapons: PlayerGun[]

    The primary and secondary weapons in an array the player is using