Awesome

node-dota2

A node-steam plugin for Dota 2, consider it in alpha state.

Contributing

Check out @RJacksonm1's blog post (his only blog post), Extending node-dota2, for a rough overview of adding new functionality to the library. A fair warning, while the way you search for new functionality is still the same, quite a lot has changed (and been simplified) implementation wise. It is now easier to implement new functionality than it was back when this blog was written.

Be careful, you'll need SVN if you want to work on the project! Executing an npm install inside the project directory has node-steam fetch the most recent node-steam-resources, which needs SVN to obtain the protobufs.

Installation and setup

• npm install dota2 in your repository root
• Copy node_modules/dota2/examples/config.js.example to config.js in your project root and edit appropriately
• Copy node_modules/dota2/examples/example.js in your project root and change line 5 to dota2 = require("dota2"),
• Run the example script: node example.js
• If you receive Error 63 you need to provide a Steam Guard code by setting the Steam Guard code in config.js and launching again.
• Make sure to use at least version 4.4.5 of node js

WARNING

At the moment the serverlist that is kept internally by node-steam contains IP addresses which are no longer responsive. This causes timeouts and makes node-dota2 seem unresponsive. The examples contain a fix for this behaviour. In short, node-steam emits a servers event that will always contain the latest version of the server list. You need to make sure that your bot handles this event and saves its contents so that upon next startup you can initialize node-steam with a more up to date list. The examples folder contains a (as of the beginning of October 2018) working list that is read by the example bots. You can use this list to bootstrap your bot until node-steam updates their embedded list.

Initializing

Parameters:

• steamClient - Pass a SteamClient instance to use to send & receive GC messages.
• debug - A boolean noting whether to print information about operations to console.
• debugMore - A boolean noting whether to print extended debug information. Activating this will log messages for each proto message exchanged with the GC.

var Steam = require('steam'),
    steamClient = new Steam.SteamClient(),
    dota2 = require('dota2'),
    Dota2 = new dota2.Dota2Client(steamClient, true, false);

Disclaimer

We do not in any way encourage people to use their own accounts when using this library. This library tries to mimic the behavior of the Dota 2 client to allow people to programmatically interact with the Dota 2 GC, however we make no efforts to hide this fact and it's pretty easy for Valve to detect clients using this library based on the generated traffic. While Valve has not yet expressed a dislike regarding reverse engineering projects like this one, it's not unimaginable that this might one day change and result in VAC bans.

Examples

The examples directory contains two Dota2 bots as an example. One contains commented-out dota2 methods, the other has boolean activated methods. Both examples show how to interact with the library.

Testing

There is a partial automated test suite for node-dota2, which is located in the test directory. You need to configure the STEAM_USERNAME and STEAM_PASSWORD environment variables to be able to run it. You can launch the tests by running the file with mocha.

API

The API doc can be consulted here or at doclets.io <a name="module_Dota2"></a>

Dota2

Dota 2 module

• Dota2
  • static
    • .Dota2Client ⇐ <code>EventEmitter</code>
      • new Dota2.Dota2Client(steamClient, debug, debugMore)
      • instance
        • .Logger : <code>winston.Logger</code>
        • .Inventory : <code>Array.<CSOEconItem></code>
        • .chatChannels : <code>Array.<CMsgDOTAJoinChatChannelResponse></code>
        • .Lobby : <code>CSODOTALobby</code>
          • .Options : <code>Object</code>
        • .LobbyInvite : <code>CSODOTALobbyInvite</code>
        • .Party : <code>CSODOTAParty</code>
        • .PartyInvite : <code>CSODOTAPartyInvite</code>
        • .launch()
        • .exit()
        • .joinChat(channel_name, [channel_type])
        • .leaveChat(channel_name, [channel_type])
        • .sendMessage(message, channel_name, [channel_type])
        • .shareLobby(channel_name, [channel_type])
        • .flipCoin(channel_name, [channel_type])
        • .rollDice(min, max, channel_name, [channel_type])
        • .requestChatChannels()
        • .requestPlayerMatchHistory(account_id, [options], [callback])
        • .requestProfileCard(account_id, [callback])
        • .requestProfile(account_id, [callback])
        • .requestHallOfFame(week, [callback])
        • .requestPlayerInfo(account_ids)
        • .requestTrophyList(account_id, [callback])
        • .requestPlayerStats(account_id, [callback])
        • .tipPlayer(account_id, steam_id, steam_id)
        • .requestJoinableCustomGameModes([server_region])
        • .requestPlayerCardsByPlayer() ⇒ <code>Array.<FantasyPlayer></code>
          • .FantasyPlayer : <code>Object</code>
        • .requestPlayerCardRoster(league_id, timestamp, [callback])
        • .draftPlayerCard(league_id, timestamp, slot, player_card_id, [callback])
        • .setItemPositions(item_positions)
        • .deleteItem(item_id)
        • .requestTopLeagueMatches()
        • .createPracticeLobby(options, [callback])
        • .configPracticeLobby(lobby_id, options, [callback])
        • .requestPracticeLobbyList([callback])
        • .requestFriendPracticeLobbyList([callback])
        • .balancedShuffleLobby([callback])
        • .flipLobbyTeams([callback])
        • .inviteToLobby(steam_id)
        • .practiceLobbyKick(account_id, [callback])
        • .practiceLobbyKickFromTeam(account_id, [callback])
        • .joinPracticeLobby(id, password, [callback])
        • .leavePracticeLobby([callback])
        • .destroyLobby([callback])
        • .abandonCurrentGame([callback])
        • .launchPracticeLobby([callback])
        • .joinPracticeLobbyTeam(slot, team, [callback])
        • .joinPracticeLobbyBroadcastChannel([channel], [callback])
        • .addBotToPracticeLobby(slot, team, bot_difficulty, [callback])
        • .respondLobbyInvite(id, accept)
        • .requestMatches([criteria], [callback])
        • .requestMatchDetails(match_id, [callback])
        • .requestMatchMinimalDetails(match_id, [callback])
        • .requestMatchmakingStats()
        • .requestTopFriendMatches()
        • .respondPartyInvite(id, [accept], [ping_data])
        • .leaveParty()
        • .setPartyLeader(steam_id)
        • .setPartyCoach(coach)
        • .inviteToParty(steam_id)
        • .kickFromParty(steam_id)
        • .requestSourceTVGames(filter_options)
        • .requestMyTeams([callback])
        • "ready"
        • "unhandled" (kMsg, kMsg_name)
        • "hellotimeout"
        • "inventoryUpdate" (inventory)
        • "gotItem" (item)
        • "gaveItem" (item)
        • "practiceLobbyUpdate" (lobby)
        • "practiceLobbyCleared"
        • "lobbyInviteUpdate" (lobbyInvite)
        • "lobbyInviteCleared"
        • "partyUpdate" (party)
        • "partyCleared"
        • "partyInviteUpdate" (partyInvite)
        • "partyInviteCleared"
        • "chatJoined" (channelData)
        • "chatJoin" (channel, joiner_name, joiner_steam_id, otherJoined_object)
        • "chatLeave" (channel, leaver_steam_id, otherLeft_object)
        • "chatLeft" (channel)
        • "chatMessage" (channel, sender_name, message, chatData)
        • "chatChannelsData" (channels)
        • "playerMatchHistoryData" (requestId, matchHistoryResponse)
        • "profileCardData" (account_id, profileCardResponse)
        • "profileData" (profileResponse)
        • "hallOfFameData" (week, featured_players, featured_farmer, hallOfFameResponse)
        • "playerInfoData" (playerInfoData)
        • "trophyListData" (trophyListResponse)
        • "playerStatsData" (account_id, playerStatsResponse)
        • "tipResponse" (tipResponse)
        • "tipped" (tipper_account_id, tipper_name, recipient_account_id, recipient_name, event_id)
        • "joinableCustomGameModes" (joinableCustomGameModes)
        • "playerCardRoster" (playerCardRoster)
        • "playerCardDrafted" (playerCardRoster)
        • "popup" (id, popup)
        • "liveLeagueGamesUpdate" (live_league_games)
        • "leagueData" (leagues)
        • "topLeagueMatchesData" (matches)
        • "lobbyDestroyed" (result, response)
        • "practiceLobbyJoinResponse" (result, response)
        • "practiceLobbyListData" (practiceLobbyListResponse)
        • "practiceLobbyResponse" (result, response)
        • "friendPracticeLobbyListData" (practiceLobbyListResponse)
        • "inviteCreated" (steam_id, group_id, is_online)
        • "matchesData" (requestId, total_results, results_remaining, matches, series, matchResponse)
        • "matchDetailsData" (match_id, matchDetailsResponse)
        • "matchMinimalDetailsData" (last_match, matchMinimalDetailsResponse)
        • "matchmakingStatsData" (matchgroups_version, match_groups, matchmakingStatsResponse)
        • "topFriendMatchesData" (matches)
        • "sourceTVGamesData" (sourceTVGamesResponse)
        • "teamData" (teams, league_id)
      • static
        • .ToAccountID(steamID) ⇒ <code>number</code>
        • .ToSteamID(accid) ⇒ <code>Long</code>
    • .schema
      • .CMsgGCToClientPlayerStatsResponse : <code>Object</code>
    • .FantasyStats : <code>enum</code>
    • .ServerRegion : <code>enum</code>
    • .SeriesType : <code>enum</code>
  • inner
    • ~requestCallback : <code>function</code>
    • ~Long
    • ~steam

<a name="module_Dota2.Dota2Client"></a>

Dota2.Dota2Client ⇐ <code>EventEmitter</code>

Kind: static class of <code>Dota2</code>
Extends: <code>EventEmitter</code>
Emits: <code>ready</code>, <code>unhandled</code>, <code>hellotimeout</code>, <code>popup</code>, <code>sourceTVGamesData</code>, <code>inventoryUpdate</code>, <code>practiceLobbyUpdate</code>, <code>practiceLobbyCleared</code>, <code>lobbyInviteUpdate</code>, <code>lobbyInviteCleared</code>, <code>practiceLobbyJoinResponse</code>, <code>practiceLobbyListData</code>, <code>practiceLobbyResponse</code>, <code>lobbyDestroyed</code>, <code>friendPracticeLobbyListData</code>, <code>inviteCreated</code>, <code>partyUpdate</code>, <code>partyCleared</code>, <code>partyInviteUpdate</code>, <code>partyInviteCleared</code>, <code>joinableCustomGameModes</code>, <code>chatChannelsData</code>, <code>chatJoin</code>, <code>chatJoined</code>, <code>chatLeave</code>, <code>chatMessage</code>, <code>profileCardData</code>, <code>playerMatchHistoryData</code>, <code>playerInfoData</code>, <code>playerStatsData</code>, <code>trophyListData</code>, <code>hallOfFameData</code>, <code>playerCardRoster</code>, <code>playerCardDrafted</code>, <code>liveLeagueGamesUpdate</code>, <code>topLeagueMatchesData</code>, <code>teamData</code>, <code>matchesData</code>, <code>matchDetailsData</code>, <code>matchMinimalDetailsData</code>, <code>matchmakingStatsData</code>, <code>topFriendMatchesData</code>, <code>tipResponse</code>, <code>tipped</code>

• .Dota2Client ⇐ <code>EventEmitter</code>
  • new Dota2.Dota2Client(steamClient, debug, debugMore)
  • instance
    • .Logger : <code>winston.Logger</code>
    • .Inventory : <code>Array.<CSOEconItem></code>
    • .chatChannels : <code>Array.<CMsgDOTAJoinChatChannelResponse></code>
    • .Lobby : <code>CSODOTALobby</code>
      • .Options : <code>Object</code>
    • .LobbyInvite : <code>CSODOTALobbyInvite</code>
    • .Party : <code>CSODOTAParty</code>
    • .PartyInvite : <code>CSODOTAPartyInvite</code>
    • .launch()
    • .exit()
    • .joinChat(channel_name, [channel_type])
    • .leaveChat(channel_name, [channel_type])
    • .sendMessage(message, channel_name, [channel_type])
    • .shareLobby(channel_name, [channel_type])
    • .flipCoin(channel_name, [channel_type])
    • .rollDice(min, max, channel_name, [channel_type])
    • .requestChatChannels()
    • .requestPlayerMatchHistory(account_id, [options], [callback])
    • .requestProfileCard(account_id, [callback])
    • .requestProfile(account_id, [callback])
    • .requestHallOfFame(week, [callback])
    • .requestPlayerInfo(account_ids)
    • .requestTrophyList(account_id, [callback])
    • .requestPlayerStats(account_id, [callback])
    • .tipPlayer(account_id, steam_id, steam_id)
    • .requestJoinableCustomGameModes([server_region])
    • .requestPlayerCardsByPlayer() ⇒ <code>Array.<FantasyPlayer></code>
      • .FantasyPlayer : <code>Object</code>
    • .requestPlayerCardRoster(league_id, timestamp, [callback])
    • .draftPlayerCard(league_id, timestamp, slot, player_card_id, [callback])
    • .setItemPositions(item_positions)
    • .deleteItem(item_id)
    • .requestTopLeagueMatches()
    • .createPracticeLobby(options, [callback])
    • .configPracticeLobby(lobby_id, options, [callback])
    • .requestPracticeLobbyList([callback])
    • .requestFriendPracticeLobbyList([callback])
    • .balancedShuffleLobby([callback])
    • .flipLobbyTeams([callback])
    • .inviteToLobby(steam_id)
    • .practiceLobbyKick(account_id, [callback])
    • .practiceLobbyKickFromTeam(account_id, [callback])
    • .joinPracticeLobby(id, password, [callback])
    • .leavePracticeLobby([callback])
    • .destroyLobby([callback])
    • .abandonCurrentGame([callback])
    • .launchPracticeLobby([callback])
    • .joinPracticeLobbyTeam(slot, team, [callback])
    • .joinPracticeLobbyBroadcastChannel([channel], [callback])
    • .addBotToPracticeLobby(slot, team, bot_difficulty, [callback])
    • .respondLobbyInvite(id, accept)
    • .requestMatches([criteria], [callback])
    • .requestMatchDetails(match_id, [callback])
    • .requestMatchMinimalDetails(match_id, [callback])
    • .requestMatchmakingStats()
    • .requestTopFriendMatches()
    • .respondPartyInvite(id, [accept], [ping_data])
    • .leaveParty()
    • .setPartyLeader(steam_id)
    • .setPartyCoach(coach)
    • .inviteToParty(steam_id)
    • .kickFromParty(steam_id)
    • .requestSourceTVGames(filter_options)
    • .requestMyTeams([callback])
    • "ready"
    • "unhandled" (kMsg, kMsg_name)
    • "hellotimeout"
    • "inventoryUpdate" (inventory)
    • "gotItem" (item)
    • "gaveItem" (item)
    • "practiceLobbyUpdate" (lobby)
    • "practiceLobbyCleared"
    • "lobbyInviteUpdate" (lobbyInvite)
    • "lobbyInviteCleared"
    • "partyUpdate" (party)
    • "partyCleared"
    • "partyInviteUpdate" (partyInvite)
    • "partyInviteCleared"
    • "chatJoined" (channelData)
    • "chatJoin" (channel, joiner_name, joiner_steam_id, otherJoined_object)
    • "chatLeave" (channel, leaver_steam_id, otherLeft_object)
    • "chatLeft" (channel)
    • "chatMessage" (channel, sender_name, message, chatData)
    • "chatChannelsData" (channels)
    • "playerMatchHistoryData" (requestId, matchHistoryResponse)
    • "profileCardData" (account_id, profileCardResponse)
    • "profileData" (profileResponse)
    • "hallOfFameData" (week, featured_players, featured_farmer, hallOfFameResponse)
    • "playerInfoData" (playerInfoData)
    • "trophyListData" (trophyListResponse)
    • "playerStatsData" (account_id, playerStatsResponse)
    • "tipResponse" (tipResponse)
    • "tipped" (tipper_account_id, tipper_name, recipient_account_id, recipient_name, event_id)
    • "joinableCustomGameModes" (joinableCustomGameModes)
    • "playerCardRoster" (playerCardRoster)
    • "playerCardDrafted" (playerCardRoster)
    • "popup" (id, popup)
    • "liveLeagueGamesUpdate" (live_league_games)
    • "leagueData" (leagues)
    • "topLeagueMatchesData" (matches)
    • "lobbyDestroyed" (result, response)
    • "practiceLobbyJoinResponse" (result, response)
    • "practiceLobbyListData" (practiceLobbyListResponse)
    • "practiceLobbyResponse" (result, response)
    • "friendPracticeLobbyListData" (practiceLobbyListResponse)
    • "inviteCreated" (steam_id, group_id, is_online)
    • "matchesData" (requestId, total_results, results_remaining, matches, series, matchResponse)
    • "matchDetailsData" (match_id, matchDetailsResponse)
    • "matchMinimalDetailsData" (last_match, matchMinimalDetailsResponse)
    • "matchmakingStatsData" (matchgroups_version, match_groups, matchmakingStatsResponse)
    • "topFriendMatchesData" (matches)
    • "sourceTVGamesData" (sourceTVGamesResponse)
    • "teamData" (teams, league_id)
  • static
    • .ToAccountID(steamID) ⇒ <code>number</code>
    • .ToSteamID(accid) ⇒ <code>Long</code>

<a name="new_module_Dota2.Dota2Client_new"></a>

new Dota2.Dota2Client(steamClient, debug, debugMore)

The Dota 2 client that communicates with the GC

<a name="module_Dota2.Dota2Client+Logger"></a>

dota2Client.Logger : <code>winston.Logger</code>

The logger used to write debug messages. This is a WinstonJS logger, feel free to configure it as you like

Kind: instance property of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+Inventory"></a>

dota2Client.Inventory : <code>Array.<CSOEconItem></code>

The current state of the bot's inventory. Contains cosmetics, player cards, ...

Kind: instance property of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+chatChannels"></a>

dota2Client.chatChannels : <code>Array.<CMsgDOTAJoinChatChannelResponse></code>

The chat channels the bot has joined

Kind: instance property of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+Lobby"></a>

dota2Client.Lobby : <code>CSODOTALobby</code>

The lobby the bot is currently in. Falsy if the bot isn't in a lobby.

Kind: instance property of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+Lobby.Options"></a>

Lobby.Options : <code>Object</code>

Kind: static typedef of <code>Lobby</code>
Properties

<a name="module_Dota2.Dota2Client+LobbyInvite"></a>

dota2Client.LobbyInvite : <code>CSODOTALobbyInvite</code>

The currently active lobby invitation. Falsy if the bot has not been invited.

Kind: instance property of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+Party"></a>

dota2Client.Party : <code>CSODOTAParty</code>

The party the bot is currently in. Falsy if the bot isn't in a party.

Kind: instance property of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+PartyInvite"></a>

dota2Client.PartyInvite : <code>CSODOTAPartyInvite</code>

The currently active party invitation. Falsy if the bot has not been invited.

Kind: instance property of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+launch"></a>

dota2Client.launch()

Reports to Steam that you're playing Dota 2, and then initiates communication with the Game Coordinator.

Kind: instance method of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+exit"></a>

dota2Client.exit()

Stop sending a heartbeat to the GC and report to steam you're no longer playing Dota 2

Kind: instance method of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+joinChat"></a>

dota2Client.joinChat(channel_name, [channel_type])

Joins a chat channel. If the chat channel with the given name doesn't exist, it is created. Listen for the chatMessage event for other people's chat messages. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+leaveChat"></a>

dota2Client.leaveChat(channel_name, [channel_type])

Leaves a chat channel. If you've joined different channels with the same name, specify the type to prevent unexpected behaviour. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+sendMessage"></a>

dota2Client.sendMessage(message, channel_name, [channel_type])

Sends a message to the specified chat channel. Won't send if you're not in the channel you try to send to. If you've joined different channels with the same name, specify the type to prevent unexpected behaviour. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+shareLobby"></a>

dota2Client.shareLobby(channel_name, [channel_type])

Shares the lobby you're currently in with the chat so other people can join. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+flipCoin"></a>

dota2Client.flipCoin(channel_name, [channel_type])

Sends a coin flip to the specified chat channel. Won't send if you're not in the channel you try to send to. If you've joined different channels with the same name, specify the type to prevent unexpected behaviour. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+rollDice"></a>

dota2Client.rollDice(min, max, channel_name, [channel_type])

Sends a dice roll to the specified chat channel. Won't send if you're not in the channel you try to send to. If you've joined different channels with the same name, specify the type to prevent unexpected behaviour. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestChatChannels"></a>

dota2Client.requestChatChannels()

Requests a list of chat channels from the GC. Listen for the chatChannelsData event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+requestPlayerMatchHistory"></a>

dota2Client.requestPlayerMatchHistory(account_id, [options], [callback])

Requests the given player's match history. The responses are paginated, but you can use the start_at_match_id and matches_requested options to loop through them. Provide a callback or listen for the playerMatchHistoryData event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestProfileCard"></a>

dota2Client.requestProfileCard(account_id, [callback])

Sends a message to the Game Coordinator requesting account_id's profile card. This method is heavily rate limited. When abused, the GC just stops responding. Even the regular client runs into this limit when you check too many profiles. Provide a callback or listen for profileCardData event for Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestProfile"></a>

dota2Client.requestProfile(account_id, [callback])

Sends a message to the Game Coordinator requesting account_id's profile page. This method is heavily rate limited. When abused, the GC just stops responding. Even the regular client runs into this limit when you check too many profiles. Provide a callback or listen for profileData event for Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestHallOfFame"></a>

dota2Client.requestHallOfFame(week, [callback])

Sends a message to the Game Coordinator requesting the Hall of Fame data for week. Provide a callback or listen for the hallOfFameData event for the Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestPlayerInfo"></a>

dota2Client.requestPlayerInfo(account_ids)

Sends a message to the Game Coordinator requesting one or multiple account_ids player information. This includes their display name, country code, team info and sponsor, fantasy role, official information lock status, and if the user is marked as a pro player. Listen for the playerInfoData event for the Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestTrophyList"></a>

dota2Client.requestTrophyList(account_id, [callback])

Sends a message to the Game Coordinator requesting account_id's trophy data. Provide a callback or listen for trophyListData event for Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestPlayerStats"></a>

dota2Client.requestPlayerStats(account_id, [callback])

Sends a message to the Game Coordinator requesting account_id's player stats. Provide a callback or listen for playerStatsData event for Game Coordinator's response. This data contains all stats shown on a player's profile page. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+tipPlayer"></a>

dota2Client.tipPlayer(account_id, steam_id, steam_id)

Attempts to tip a player for his performance during a match. Listen for the tipResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestJoinableCustomGameModes"></a>

dota2Client.requestJoinableCustomGameModes([server_region])

Requests a list of custom game modes for which there are currently lobbies available. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestPlayerCardsByPlayer"></a>

dota2Client.requestPlayerCardsByPlayer() ⇒ <code>Array.<FantasyPlayer></code>

Requests the player stats for each of the players for which you have one or multiple player cards. All requests are staggered in 200ms intervals and time out after 2s. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+requestPlayerCardsByPlayer.FantasyPlayer"></a>

requestPlayerCardsByPlayer.FantasyPlayer : <code>Object</code>

Player with player cards

Kind: static typedef of <code>requestPlayerCardsByPlayer</code>
Properties

<a name="module_Dota2.Dota2Client+requestPlayerCardRoster"></a>

dota2Client.requestPlayerCardRoster(league_id, timestamp, [callback])

Sends a message to the Game Coordinator requesting your fantasy line-up for a specific day of a given tournament. Provide a callback or listen for the playerCardRoster event for the Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+draftPlayerCard"></a>

dota2Client.draftPlayerCard(league_id, timestamp, slot, player_card_id, [callback])

Sends a message to the Game Coordinator requesting to draft a certain player card in a specific slot, for a given day in a tournament. Provide a callback or listen for the playerCardDrafted event for the Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+setItemPositions"></a>

dota2Client.setItemPositions(item_positions)

Attempts to change the position of one or more items in your inventory. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+deleteItem"></a>

dota2Client.deleteItem(item_id)

Attempts to delete an item in your inventory. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestTopLeagueMatches"></a>

dota2Client.requestTopLeagueMatches()

Sends a message to the Game Coordinator requesting the top league matches. Listen for the topLeagueMatchesData event for the Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+createPracticeLobby"></a>

dota2Client.createPracticeLobby(options, [callback])

Sends a message to the Game Coordinator requesting to create a lobby. This will automatically make the bot join the first slot on radiant team. Listen for practiceLobbyUpdate response for a snapshot-update of the newly created lobby. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+configPracticeLobby"></a>

dota2Client.configPracticeLobby(lobby_id, options, [callback])

Sends a message to the Game Coordinator requesting to configure some options of the active lobby. Listen for practiceLobbyUpdate response for a snapshot-update of the newly created lobby. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestPracticeLobbyList"></a>

dota2Client.requestPracticeLobbyList([callback])

Requests a lists of joinable practice lobbies. Provide a callback or listen for the practiceLobbyListData event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestFriendPracticeLobbyList"></a>

dota2Client.requestFriendPracticeLobbyList([callback])

Requests a lists of joinable practice lobbies which have one of your friends in them. Provide a callback or listen for the friendPracticeLobbyListData event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+balancedShuffleLobby"></a>

dota2Client.balancedShuffleLobby([callback])

Shuffles the lobby based on skill level. Requires you to be in a lobby and to be the host. Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+flipLobbyTeams"></a>

dota2Client.flipLobbyTeams([callback])

Flips the radiant and dire team players. Requires you to be in a lobby and to be the host. Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+inviteToLobby"></a>

dota2Client.inviteToLobby(steam_id)

Asks to invite a player to your lobby. This creates a new default lobby when you are not already in one. Listen for the inviteCreated event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+practiceLobbyKick"></a>

dota2Client.practiceLobbyKick(account_id, [callback])

Asks to kick someone from your current practice lobby. Requires you to be in a lobby and to be the host. Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+practiceLobbyKickFromTeam"></a>

dota2Client.practiceLobbyKickFromTeam(account_id, [callback])

Asks to kick someone from his chosen team in your current practice lobby. The player will be added to the player pool Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+joinPracticeLobby"></a>

dota2Client.joinPracticeLobby(id, password, [callback])

Sends a message to the Game Coordinator requesting to join a lobby. Provide a callback or listen for the practiceLobbyJoinResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+leavePracticeLobby"></a>

dota2Client.leavePracticeLobby([callback])

Sends a message to the Game Coordinator requesting to leave the current lobby. Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+destroyLobby"></a>

dota2Client.destroyLobby([callback])

Destroy the current lobby. Requires you to be the host. Provide a callback or listen for the lobbyDestroyed event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+abandonCurrentGame"></a>

dota2Client.abandonCurrentGame([callback])

Abandons the current game. Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+launchPracticeLobby"></a>

dota2Client.launchPracticeLobby([callback])

Start the practice lobby. The bot will continue to receive lobby updates, but won't join the actual game. Requires you to be in a lobby and to be the host. Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+joinPracticeLobbyTeam"></a>

dota2Client.joinPracticeLobbyTeam(slot, team, [callback])

Sends a message to the Game Coordinator requesting to join a particular team in the lobby. Requires you to be in a lobby. Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+joinPracticeLobbyBroadcastChannel"></a>

dota2Client.joinPracticeLobbyBroadcastChannel([channel], [callback])

Sends a message to the Game Coordinator requesting to add a bot to the broadcast channel. Requires you to be in a lobby. Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+addBotToPracticeLobby"></a>

dota2Client.addBotToPracticeLobby(slot, team, bot_difficulty, [callback])

Sends a message to the Game Coordinator requesting to add a bot to the given team in the lobby. Requires you to be in a lobby and to be the host Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+respondLobbyInvite"></a>

dota2Client.respondLobbyInvite(id, accept)

Sends a message to the Game Coordinator confirming/denying a lobby invitation Provide a callback or listen for the practiceLobbyResponse event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestMatches"></a>

dota2Client.requestMatches([criteria], [callback])

Requests a list of matches corresponding to the given criteria. The responses are paginated, but you can use the start_at_match_id and matches_requested options to loop through them. Provide a callback or listen for the matchesData event for the GC's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestMatchDetails"></a>

dota2Client.requestMatchDetails(match_id, [callback])

Sends a message to the Game Coordinator requesting the match details for the given match ID. This method is rate limited. When abused, the GC just stops responding. Provide a callback or listen for matchDetailsData event for Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestMatchMinimalDetails"></a>

dota2Client.requestMatchMinimalDetails(match_id, [callback])

Sends a message to the Game Coordinator requesting the minimal match details for the given match ID. This method is rate limited. When abused, the GC just stops responding. Provide a callback or listen for matchMinimalDetailsData event for Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestMatchmakingStats"></a>

dota2Client.requestMatchmakingStats()

Sends a message to the Game Coordinator requesting the current match making stats. Listen for matchmakingStatsData event for Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+requestTopFriendMatches"></a>

dota2Client.requestTopFriendMatches()

Sends a message to the Game Coordinator requesting the current top matches played by your friends. Listen for topFriendMatchesData event for Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+respondPartyInvite"></a>

dota2Client.respondPartyInvite(id, [accept], [ping_data])

Responds to a party invite. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+leaveParty"></a>

dota2Client.leaveParty()

Leaves the current party. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+setPartyLeader"></a>

dota2Client.setPartyLeader(steam_id)

Tries to assign a party member as party leader. Only works if you are a party leader and the proposed user is a member of the current party. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+setPartyCoach"></a>

dota2Client.setPartyCoach(coach)

Announces whether or not you want to be coach of the current party. GC will take action accordingly. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+inviteToParty"></a>

dota2Client.inviteToParty(steam_id)

Invite a player to your party. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+kickFromParty"></a>

dota2Client.kickFromParty(steam_id)

Kick a player from your party. Only works if you're party leader. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestSourceTVGames"></a>

dota2Client.requestSourceTVGames(filter_options)

Requests a list of SourceTV games based on the given criteria. Listen for sourceTVGamesData for results Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+requestMyTeams"></a>

dota2Client.requestMyTeams([callback])

Sends a message to the Game Coordinator requesting the authenticated user's team data. Provide a callback or listen for teamData for the Game Coordinator's response. Requires the GC to be ready.

Kind: instance method of <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_ready"></a>

"ready"

Emitted when the connection with the GC has been established and the client is ready to take requests.

Kind: event emitted by <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+event_unhandled"></a>

"unhandled" (kMsg, kMsg_name)

Emitted when the GC sends a message that isn't yet treated by the library.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_hellotimeout"></a>

"hellotimeout"

Emitted when the connection with the GC takes longer than 30s

Kind: event emitted by <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+event_inventoryUpdate"></a>

"inventoryUpdate" (inventory)

Emitted when the GC sends an inventory snapshot. The GC is incredibly inefficient and will send the entire object even if it's a minor update. You can use this to detect when a change was made to your inventory (e.g. drop) Note that the Inventory property will be the old value until after this event completes to allow comparison between the two.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_gotItem"></a>

"gotItem" (item)

Emitted when you receive an item through a trade. Note that the Inventory property will be the old value until after this event completes to allow comparison between the two.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_gaveItem"></a>

"gaveItem" (item)

Emitted when you trade away an item. Note that the Inventory property will be the old value until after this event completes to allow comparison between the two.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_practiceLobbyUpdate"></a>

"practiceLobbyUpdate" (lobby)

Emitted when the GC sends a lobby snapshot. The GC is incredibly inefficient and will send the entire object even if it's a minor update. You can use this to detect when a lobby has been entered / created successfully as well. Note that the Lobby property will be the old value until after this event completes to allow comparison between the two.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_practiceLobbyCleared"></a>

"practiceLobbyCleared"

Emitted when leaving a lobby (aka, the lobby is cleared). This can happen when kicked, upon leaving a lobby, etc. There are other events to tell when the bot has been kicked.

Kind: event emitted by <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+event_lobbyInviteUpdate"></a>

"lobbyInviteUpdate" (lobbyInvite)

Emitted when the bot received an invite to a lobby

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_lobbyInviteCleared"></a>

"lobbyInviteCleared"

Emitted when the Lobby Invite is cleared, for example when accepting/rejecting it or when the lobby is closed.

Kind: event emitted by <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+event_partyUpdate"></a>

"partyUpdate" (party)

Emitted when the GC sends a party snapshot. The GC is incredibly inefficient and will send the entire object even if it's a minor update. You can use this to detect when a party has been entered / created successfully as well. Note that the Party property will be the old value until after this event completes to allow comparison between the two.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_partyCleared"></a>

"partyCleared"

Emitted when leaving a party (aka, the party is cleared). This can happen when kicked, upon leaving a party, etc. There are other callbacks to tell when the bot has been kicked.

Kind: event emitted by <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+event_partyInviteUpdate"></a>

"partyInviteUpdate" (partyInvite)

Emitted when the GC sends a party invite snapshot. The GC is incredibly inefficient and will send the entire object even if it's a minor update. You can use this to detect when an incoming party invite has been sent. Note that the PartyInvite property will be the old value until after this event completes to allow comparison between the two.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_partyInviteCleared"></a>

"partyInviteCleared"

Emitted when the Party Invite is cleared, for example when accepting/rejecting it or when the party is closed

Kind: event emitted by <code>Dota2Client</code>
<a name="module_Dota2.Dota2Client+event_chatJoined"></a>

"chatJoined" (channelData)

Event that's emitted whenever the bot joins a chat channel

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_chatJoin"></a>

"chatJoin" (channel, joiner_name, joiner_steam_id, otherJoined_object)

Event that's emitted whenever someone else joins a chat channel the bot is in

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_chatLeave"></a>

"chatLeave" (channel, leaver_steam_id, otherLeft_object)

Event that's emitted whenever someone else leaves a chat channel the bot is in

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_chatLeft"></a>

"chatLeft" (channel)

Event that's emitted whenever the bot left a chat channel

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_chatMessage"></a>

"chatMessage" (channel, sender_name, message, chatData)

Event that's emitted whenever someone sends a message in a channel the bot is in

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_chatChannelsData"></a>

"chatChannelsData" (channels)

Event that's emitted after requesting a list of chat channels via requestChatChannels

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_playerMatchHistoryData"></a>

"playerMatchHistoryData" (requestId, matchHistoryResponse)

Emitted in response to a request for a player's match history

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_profileCardData"></a>

"profileCardData" (account_id, profileCardResponse)

Emitted in response to a request for a player's profile card

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_profileData"></a>

"profileData" (profileResponse)

Emitted in response to a request for a player's profile page

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_hallOfFameData"></a>

"hallOfFameData" (week, featured_players, featured_farmer, hallOfFameResponse)

Emitted in response to a request for a player's profile card

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_playerInfoData"></a>

"playerInfoData" (playerInfoData)

Emitted in response to a request for a player's info

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_trophyListData"></a>

"trophyListData" (trophyListResponse)

Emitted in response to a request for a player's trophy list

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_playerStatsData"></a>

"playerStatsData" (account_id, playerStatsResponse)

Emitted in response to a request for a player's stats

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_tipResponse"></a>

"tipResponse" (tipResponse)

Event that's emitted in response to a request for tipping a player

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_tipped"></a>

"tipped" (tipper_account_id, tipper_name, recipient_account_id, recipient_name, event_id)

Event that's emitted whenever the bot got tipped

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_joinableCustomGameModes"></a>

"joinableCustomGameModes" (joinableCustomGameModes)

Emitted in response to a request for joinable custom game modes.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_playerCardRoster"></a>

"playerCardRoster" (playerCardRoster)

Emitted in response to a request for a player's fantasy roster

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_playerCardDrafted"></a>

"playerCardDrafted" (playerCardRoster)

Emitted in response to a draft of a player card

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_popup"></a>

"popup" (id, popup)

Emitted when the server wants the client to create a pop-up

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_liveLeagueGamesUpdate"></a>

"liveLeagueGamesUpdate" (live_league_games)

Emitted when the GC sends a CMsgDOTALiveLeagueGameUpdate.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_topLeagueMatchesData"></a>

"topLeagueMatchesData" (matches)

Emitted in response to a request for top league matches.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_lobbyDestroyed"></a>

"lobbyDestroyed" (result, response)

Event that's emitted when attempting to destroy the lobby

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_practiceLobbyJoinResponse"></a>

"practiceLobbyJoinResponse" (result, response)

Event that's emitted whenever the bot joins a lobby

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_practiceLobbyListData"></a>

"practiceLobbyListData" (practiceLobbyListResponse)

Event that's emitted in response to a request for the list of lobbies

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_practiceLobbyResponse"></a>

"practiceLobbyResponse" (result, response)

Emitted when an operation changing the state of a lobby was sent to the GC and processed. This event only contains the acknowledgement by the GC. The actual update of the lobby state is communicated via module:Dota2.Dota2Client#practiceLobbyUpdate events.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_friendPracticeLobbyListData"></a>

"friendPracticeLobbyListData" (practiceLobbyListResponse)

Event that's emitted in response to a request for the list of your friends' lobbies

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_inviteCreated"></a>

"inviteCreated" (steam_id, group_id, is_online)

Event that's emitted whenever the bot attempts to invite someone to a lobby

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_matchesData"></a>

"matchesData" (requestId, total_results, results_remaining, matches, series, matchResponse)

Emitted in response to a request for matches

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_matchDetailsData"></a>

"matchDetailsData" (match_id, matchDetailsResponse)

Emitted in response to a request for a match's details

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_matchMinimalDetailsData"></a>

"matchMinimalDetailsData" (last_match, matchMinimalDetailsResponse)

Emitted in response to a request for a/multiples match's minimal details

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_matchmakingStatsData"></a>

"matchmakingStatsData" (matchgroups_version, match_groups, matchmakingStatsResponse)

Emitted in response to a request for the match making stats

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_topFriendMatchesData"></a>

"topFriendMatchesData" (matches)

Emitted in response to a request for the current top matches played by your friends

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_sourceTVGamesData"></a>

"sourceTVGamesData" (sourceTVGamesResponse)

sourceTVGamesData event

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client+event_teamData"></a>

"teamData" (teams, league_id)

Emitted in response to a request for your teams.

Kind: event emitted by <code>Dota2Client</code>

<a name="module_Dota2.Dota2Client.ToAccountID"></a>

Dota2Client.ToAccountID(steamID) ⇒ <code>number</code>

Converts a 64bit Steam ID to a Dota2 account ID by deleting the 32 most significant bits

Kind: static method of <code>Dota2Client</code>
Returns: <code>number</code> - Dota2 account ID corresponding with steamID

<a name="module_Dota2.Dota2Client.ToSteamID"></a>

Dota2Client.ToSteamID(accid) ⇒ <code>Long</code>

Converts a Dota2 account ID to a 64bit Steam ID

Kind: static method of <code>Dota2Client</code>
Returns: <code>Long</code> - 64bit Steam ID corresponding to the given Dota 2 account ID

<a name="module_Dota2.schema"></a>

Dota2.schema

Protobuf schema created by Steam Resources. This is an alias of steam.GC.Dota.Internal. This object can be used to obtain Dota2 specific protobuf types. Object types can be created by new Dota2.schema.<TypeName>(payload :Object);. Enum types can be referenced by Dota2.schema.<EnumName>, which returns an object array representing the enum.

Kind: static property of <code>Dota2</code>
<a name="module_Dota2.schema.CMsgGCToClientPlayerStatsResponse"></a>

schema.CMsgGCToClientPlayerStatsResponse : <code>Object</code>

Player statistics

Kind: static typedef of <code>schema</code>
Properties

<a name="module_Dota2.FantasyStats"></a>

Dota2.FantasyStats : <code>enum</code>

Enum for the different fantasy stats

Kind: static enum of <code>Dota2</code>
Read only: true
Properties

<a name="module_Dota2.ServerRegion"></a>

Dota2.ServerRegion : <code>enum</code>

Enum for all server regions. This enum is kept up to date on a best effort base. For the up-to-date values, check your game's regions.txt or SteamDB's version

Kind: static enum of <code>Dota2</code>
Read only: true
Properties

<a name="module_Dota2.SeriesType"></a>

Dota2.SeriesType : <code>enum</code>

Enum for different types of series.

Kind: static enum of <code>Dota2</code>
Read only: true
Properties

<a name="module_Dota2..requestCallback"></a>

Dota2~requestCallback : <code>function</code>

Kind: inner typedef of <code>Dota2</code>

<a name="external_Long"></a>

Dota2~Long

A Long class for representing a 64 bit two's-complement integer value derived from the Closure Library for stand-alone use and extended with unsigned support.

Kind: inner external of <code>Dota2</code>
See: long npm package
<a name="external_steam"></a>

Dota2~steam

The Steam for Node JS package, allowing interaction with Steam.

Kind: inner external of <code>Dota2</code>
See: steam npm package