yolkbot logoyolkbot
Page Navigator

Information about the game is available through the bot.game object.

Important

These values, when modified, do nothing. They are ONLY to be used for information.

General

  • bot.game.code - the invite code of the game
  • bot.game.gameMode - the game mode of the game ('ffa', 'team', 'spatula', 'kotc')
  • bot.game.map - the map of the game (instanceof Map)
  • bot.game.region - the game region (a string name based on Regions)
  • bot.game.playerLimit - the player limit of the game
  • bot.game.isGameOwner - if the bot is the game owner
  • bot.game.isPrivate - if the game is private
  • bot.game.options - the options of the game
    • bot.game.options.gravity - the gravity of the game
    • bot.game.options.damage - the damage of the game
    • bot.game.options.healthRegen - the health regen of the game
    • bot.game.options.locked - if the game is locked
    • bot.game.options.noTeamChange - if the game has no team change
    • bot.game.options.noTeamShuffle - if the game has no team shuffle
    • bot.game.options.weaponsDisabled - the weapons disabled in the game - in the order of GunList - 1 = disabled, 0 = enabled
    • bot.game.options.mustUseSecondary - if the player must use the secondary weapon due to all weapons being disabled
  • bot.game.teamScore - the team score of the game
  • bot.game.spatula - the spatula of the game
    • bot.game.spatula.coords - the coords of the spatula
    • bot.game.spatula.controlledBy - the player id controlling the spatula
    • bot.game.spatula.controlledByTeam - the team controlling the spatula
  • bot.game.kotc - kotc information
    • bot.game.kotc.stage - the stage of the game (instanceof CoopStates)
    • bot.game.kotc.zoneNumber - the active coop zone number
    • bot.game.kotc.activeZone - an array of x/y/z coord objects that the current zone consists of
    • bot.game.kotc.teamCapturing - the team ID capturing the coop (see Team)
    • bot.game.kotc.captureProgress - a number 1-1000 that signifies the progress of the capture
    • bot.game.kotc.numCapturing - the number of players capturing
    • bot.game.kotc.capturePercent - the capture percent of the game (as bot.game.captureProgress is a number, this is for convenience)
  • bot.game.collectables - an array with index 0 as an ammo array and index 1 as a grenade array -- each ammo has an ID and an x/y/z coord

Join the community for the most up to date news!