A node-steam plugin for Dota 2, consider it in alpha state.
Check out my blog post (my 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.
A few backwards incompatible API changes were included with version 4.0.0.
- The following functions are no longer supported by Valve so they have been commented:
requestPassportDatarequestTeamProfilerequestTeamIDByNamerequestTeamMemberProfile
- The
teamDataevent now throws an extra parameterleague_id - The
matchMakingStatsDataevent's first two parameters changed as the old values no longer exist. - The
matchMinimalDetailsDataevent now returns thelast_matchbool as first argument.
npm install steam; npm installin the repository root (install Steam first to work around a node-steam#222)- Copy
config.js.exampletoconfig.jsand edit appropriately - 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.jsand launching again. - Make sure to use at least version 4.4.5 of node js
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);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.
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.
##Properties
###AccountID
The current steam ID of the SteamClient converted to Dota 2 Account ID format. Not available until launch is called.
###Lobby The current lobby object (see CSODOTALobby). Null if the bot is not in a lobby.
###Party The current party object (see CSODOTAParty). Null if the bot is not in a party.
###PartyInvite The current party invite object (see CSODOTAPartyInvite). Null if the bot does not have an active incoming party invite.
###LobbyInvite The current lobby invite object (see CSODOTALobbyInvite). Null if the bot does not have an active incoming lobby invite.
All methods require the SteamClient instance to be logged on.
Reports to Steam that you're playing Dota 2, and then initiates communication with the Game Coordinator.
Tells Steam you were feeding.
###Utilities
- Takes an input steam ID in any format and converts it into an int Account ID.
- Takes an input Dota 2 acount ID in any format and converts it into a string steam ID.
item_positions- An array of tuples (itemid, position).
Attempts to move items within your inventory to the positions you set. Requires the GC to be ready (listen for the ready event before calling).
Attempts to delete an item. Requires the GC to be ready (listen for the ready event before calling).
Limited Steam accounts cannot interact with chat!
channel- A string for the channel name.[type]- The type of the channel being joined. Defaults toDota2.schema.DOTAChatChannelType_t.DOTAChannelType_Custom.
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.
Notable channels:
Guild_##########- The chat channel of the guild with guild_id = ##########Lobby_##########- The chat channel of the lobby with lobby_id = ##########
channel- A string for the channel name.
Leaves a chat channel.
channel- A string for the channel name.message- The message you want to send.
Sends a message to the specified chat channel. Won't send if you're not in the channel you try to send to.
channel- A string for the channel name.
Sends a coin flip to the specified chat channel. Won't send if you're not in the channel you try to send to.
channel- A string for the channel name.min- Lower bound of the dice roll.max- Upper bound of the dice roll.
Sends a dice roll to the specified chat channel. Won't send if you're not in the channel you try to send to.
Requests a list of chat channels from the GC. Listen for the chatChannelsData event for the GC's response.
Sends a request to the GC for new guild data, which returns guildOpenPartyData events - telling the client the status of current open parties for each guild, as well as exposing guildIds to the client.
guild_id- ID of a guild.target_account_id- Account ID (lower 32-bits of a 64-bit steam id) of user to invite to guild.[callback]- optional callback, returns args:err, response.
Attempts to invite a user to guild. Requires the GC to be ready (listen for the ready event before calling).
guild_id- ID of a guild.target_account_id- Account ID (lower 32-bits of a 64-bit steam id) of user whoms guild invite you wish to cancel.[callback]- optional callback, returns args:err, response.
Attempts to cancel a user's guild invitation; use this on your own account ID to reject guild invitations. Requires the GC to be ready (listen for the ready event before calling).
guild_id- ID of a guild.target_account_id- Account ID (lower 32-bits of a 64-bit steam id) of user whoms guild invite you wish to cancel.target_role- Role in guild to have.0- Kick member from guild.1- Leader.2- Officer.3- Member.
[callback]- optional callback, returns args:err, response.
Attempts to set a user's role within a guild; use this with your own account ID and the 'Member' role to accept guild invitations. Requires the GC to be ready (listen for the ready event before calling).
[callback]- optional callback, returns args:err, response.
Requests the authenticated user's team data.
team_id- ID of a team[callback]- optional callback, returns args:err, response.
Requests the profile for a given team.
Warning protobuf no longer exists, function is now deprecated.
steam_id- Steam ID of the user whose team profile you want[callback]- optional callback, returns args:err, response.
Requests the profile of the team a given user belongs to.
Warning protobuf no longer exists, function is now deprecated.
team_name- Name of a team[callback]- optional callback, returns args:err, response.
Requests the ID for a given team name.
Warning protobuf no longer exists, function is now deprecated.
[callback]- optional callback, returns args:err, response.
Requests the list of pro teams.
Warning this request no longer triggers a response from the GC. This might be temporary.
account_id- Account ID of the user whose match history you wish to retrieve.[options]- A mapping of options for the query he results:[start_at_match_id]- Which match ID to start searching at (pagination)[matches_requested]- How many matches to retrieve[hero_id]- The ID of the hero the given account ID had played[request_id]- I have no idea.
[callback]- optional callback, returns args:err, response.
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 for the GC's response. Requires the GC to be ready (listen for the ready event before calling).
account_id- Account ID (lower 32-bits of a 64-bit Steam ID) of the user whose profile data you wish to view.request_name- Boolean, whether you want the GC to return the accounts current display name.[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting account_id's profile data. Provide a callback or listen for profileData event for Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
Warning Valve's privacy policy has become stricter since reborn. This function is now reserved for internal use.
account_id- Account ID (lower 32-bits of a 64-bit Steam ID) of the user whose profile card you wish to view.[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting account_id's profile card. Provide a callback or listen for profileCardData event for Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
account_id- Account ID (lower 32-bits of a 64-bit Steam ID) of the user whose passport data you wish to view.[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting account_id's passport data. Provide a callback or listen for passportData event for Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
This function is no longer supported by Valve, it's only left here for historical purposes. It will be removed in a future release.
[week]- The week of which you wish to know the Hall of Fame members; will return latest week if omitted. Weeks also randomly start at 2233 for some reason, valf please.[callback]- optional callback, returns args:err, response.
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 (listen for the ready event before calling).
account_ids- Either a single or array of Account IDs (lower 32-bits of a 64-bit Steam ID) of desired user(s) player info.
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 (listen for the ready event before calling).
account_id- Account ID (lower 32-bits of a 64-bit Steam ID) of the user whose trophy data you wish to view.[callback]- optional callback, returns args:err, response.
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 (listen for the ready event before calling). Notably, this data contains the profile_name field, which is the user's name displayed on their profile page in dota.
[criteria]- The options available for searching matches:[hero_id][game_mode][date_min][date_max][matches_requested][start_at_match_id][min_players][tournament_games_only][account_id][league_id][skill][team_id]-
[callback]- optional callback, returns args:err, response.
Requests matches from the GC matching the given criteria. Provide a callback or listen for the matchesData event for teh Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
match_id- The match's ID[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting match_id's match details. Provide a callback or listen for matchDetailsData event for Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
Note: There is a server-side rate-limit of 100 requests per 24 hours on this method.
match_ids- The match IDs that you want concise details of[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting the match details for matches corresponding to match_ids. Provide a callback or listen for matchMinimalDetailsData event for Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
Sends a message to the Game Coordinator requesting some matchmaking stats. Listen for the matchmakingStatsData event for the Game Coordinator's response (cannot take a callback because of Steam's backend, or RJackson's incompetence; not sure which). Requires the GC to be ready (listen for the ready event before calling).
Sends a message to the Game Coordinator requesting the top matches of your friends. Listen for the topFriendMatchesData event for the Game Coordinator's response (cannot take a callback because of Steam's backend). Requires the GC to be ready (listen for the ready event before calling).
[id]- Number, party ID.[accept]- Accept or decline the invite.
Responds to an incoming party invite. The PartyInvite property is cleared after the response has been sent.
[id]- The steam ID to invite.
Invites a player to a party. This will create a new party if you aren't in one.
[id]- The steam ID to kick.
Kicks a player from the party. This will create a new party if you aren't in one.
[coach]- Boolean, if the bot wants to be coach or not.
Set the bot's status as a coach.
Leaves the current party. See the Party property.
[id]- Practice lobby ID[accept]- Boolean, whether or not you accept the invitation.
Sends a message to the Game Coordinator confirming a lobby invitation. The LobbyInvite property is cleared after the response is sent.
[id]- Practice lobby ID[password]- Practice lobby password[callback]- Optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting to join a lobby. Provide a callback or listen for practiceLobbyJoinResponse for the Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
[password]- Password to restrict access to the lobby (optional).[options]- Options available for the lobby. All are optional, but send at least one.game_name: String, lobby title.server_region: Use the ServerRegion enum.game_mode: Use the DOTA_GameMode enum.game_version: Use the game version enum.cm_pick: Use the DOTA_CM_PICK enum.allow_cheats: Boolean, allow cheats.fill_with_bots: Boolean, fill available slots with bots?allow_spectating: Boolean, allow spectating?pass_key: Password.series_type: Use the series type enum.radiant_series_wins: # of games won so far, e.g. for a Bo3 or Bo5.dire_series_wins: # of games won so far, e.g. for a Bo3 or Bo5.allchat: Enable all chat for VOIPleague_id: The league this lobby is being created for. Optionaldota_tv_delay: Number of seconds the game should be delayed for DotaTV.custom_game_mode: TODO.custom_map_name: TODO.custom_difficulty: TODO.custom_game_id: TODO.
[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting to create a lobby. Listen for practiceLobbyUpdate response for a snapshot-update of the newly created lobby. Requires the GC to be ready (listen for the ready event before calling).
[password]- See paramter description in [#createPracticeLobby][tournament_game_id]- TODO[tournament_id]- TODO[options]- See paramter description in [#createPracticeLobby][callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting to create a tournament lobby. Listen for practiceLobbyUpdate response for a snapshot-update of the newly created lobby. Requires the GC to be ready (listen for the ready event before calling).
slot- The slot you want to fill (1-10)team- The team you want to be on. Use theGOTA_GC_TEAMenum[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting to join a particular team in the lobby. Provide a callback or listen for practiceLobbyResponse for the Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
slot- The slot you want to fill (1-10)team- The team you want to be on. Use theDOTA_GC_TEAMenumbot_difficulty- The difficulty setting of the bot. Use theDOTABotDifficultyenum[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting to add a bot to the given team in the lobby. Provide a callback or listen for practiceLobbyResponse for the Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
channel- The channel slot you want to fill (default: 1)[callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting to add a bot to the broadcast channel. Provide a callback or listen for practiceLobbyResponse for the Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
Shuffles the lobby teams.
Flips the teams in a lobby.
lobby_id- Lobby IDoptions- See paramter description in [#createPracticeLobby][callback]- optional callback, returns args:err, response.
Sends a message to the Game Coordinator requesting to configure some options of the active lobby. Requires the GC to be ready (listen for the ready event before calling).
Sends a message to the GC requesting the currrent lobby be started (server found and game begins). You will receive updates in the practiceLobbyUpdate response.
steam_idThe Steam ID of the player you want to invite.
Asks to invite a player to your lobby. This creates a new default lobby when you are not already in one.
account_idThe ID of the player you want to kick.
Asks to kick someone from your current practice lobby.
account_idThe ID of the player you want to kick from the team.
Asks to kick someone from his chosen team in your current practice lobby.
Sends a message to the Game Coordinator requesting to leave the current lobby. Requires the GC to be ready (listen for the ready event before calling).
TODO
TODO
[region]- Enum for the server region, defaults to Dota2.ServerRegion.UNSPECIFIED
Sends a message to the Game Coordinator requesting a list of joinable custom games for a given region.
[month]- Int for the month (MM) you want to query data for. Defaults to current month. IMPORTANT NOTE: Month is zero-aligned, not one-aligned; so Jan = 00, Feb = 01, etc.[year]- Int for the year (YYYY) you want to query data for . Defaults to current year.[tier]- Search only for a specific tier of tournaments. Defaults to 0.[callback]- optional callbackreturns args:errresponse.
Sends a message to the Game Coordinator requesting data on leagues being played in the given month. Provide a callback or listen for leaguesInMonthData for the Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
Requests info on all available official leagues from the GC. Listen for leagueData for the Game Coordinator's response. Requires the GC to be ready (listen for the ready event before calling).
Sends a message to the Game Coordinator requesting the top league matches. Listen for the topLeagueMatchesData event for the Game Coordinator's response (cannot take a callback because of Steam's backend). Requires the GC to be ready (listen for the ready event before calling).
[filterOption]- Object to override the default filters
Returns a list of current ongoing matches (from live games tab).
Default filterOptions:
{
search_key: '',
league_id: 0,
hero_id: 0,
start_game: 0, // This is not the game offset, only values in [0, 10, 20, ... 90] are valid, and yield [1,2,3 ... 10] responses
game_list_index: 0,
lobby_ids: [], // This is for getting player specific matches (pro player) games on the live games list, but where the lobby_ids are derived from is unknown.
}Important: The useful parameters are
league_id,hero_id, andstart_game. The rest have unclear usage conditions.
Emitted when the GC is ready to receive messages. Be careful not to declare anonymous functions as event handlers here, as you'll need to be able to invalidate event handlers on an unready event.
Emitted when the connection status to the GC changes, and renders the library unavailable to interact. You should clear any event handlers set in the ready event here, otherwise you'll have multiple handlers for each message every time a new ready event is sent.
channel- Channel name.senderName- Persona name of user who sent message.message- Wot u think?chatObject- The raw chat object to do with as you wish.
Emitted for chat messages received from Dota 2 chat channels
channel- Channel name.joiner_name- Persona name of user who joined.joiner_steam_id- Steam ID of the user who joined.otherJoined_object- The rawCMsgDOTAOtherJoinedChatChannelobject for you to do with as you wish.
Emitted when another user joins a chat channel you are in.
channel- Channel name.leaver_steam_id- Steam ID of the user who left.otherLeft_object- The rawCMsgDOTAOtherLeftChatChannelobject for you to do with as you wish.
Emitted when another user leaves a chat channel you are in.
channels- An array of ChatChannel objects, each with the following properties:channel_namenum_memberschannel_type
The GC's response to a requestChatChannels call.
guild_id- ID of the guild.openParties- Array containing information about open guild parties. Each object has the following properties:partyId- Unique ID of the party.member_account_ids- Array of account ids.time_created- Something about Back to the Future.description- A user-inputted string. Do not trust.
Emitted for each guild the bot's account is a member of, containing information on open parties for each guild. Also exposes guild_id's, which is handy.
guild_id- ID of the guild.members- A list of members in the guild. Each object has the following properties:account_id- Account ID of the member.time_joined- Timestamp of when this user joined the guild.role- Role of the member withing the guild1- Leader2- Officer3- Member
guildDataObject- The rawCMsgDOTAGuildSDOobject.
Emitted when information on a particular guild is retrieved.
guild_id- ID of the guild.guildName- Name of the guild.inviter- Account ID of user whom invited you.guildInviteDataObject- The raw guildInviteData object to do with as you wish.
You can respond with cancelInviteToGuild or setGuildAccountRole.
teams- Array containing the teams the user is in or which are featured on the user's profile. Each object has the following properties:on_team- Whether or not the user is on this teamprofile_team- Whether or not this is a team featured on the user's profileteam- Info about the team. This contains among others:name- Name of the teammembers- Account ID and time joined for all memberswins- All winslosses- All lossesgamesplayed- Total amount of games playedrank- Team MMR- ...
league_id- League ID (no clue as of its meaning, feel free to suggest)
Emitted when GC responds to the requestMyTeams method.
See the protobuf schema for team's object structure.
team_id- ID of the team.team_info- Info about the team. This contains among others:name- Name of the teammembers- Account ID and time joined for all memberswins- All winslosses- All lossesgamesplayed- Total amount of games playedrank- Team MMR- ...
Emitted when GC responds to the requestTeamProfile and requestTeamMemberProfile method.
See the protobuf schema for team_info's object structure.
team_id- ID of the team. Null if none was found.
Emitted when GC responds to the requestTeamIDByName method.
teams- List of team entriesteam_id- ID of the teamtag- Tag of the teamtime_created- Timestamp when the team was createdlogo- Logo of the teamcountry_code- 2 letter country codemember_count- Number of team members in this team
Emitted when GC responds to the requestProTeamList method.
account_id- Account ID whom the data is associated with.profileData- The raw profile data object.
Emitted when GC responds to the requestProfile method.
See the protobuf schema for profileData's object structure.
account_id- Account ID whom the data is associated with.profileCardData- The raw profileCard object.
Emitted when GC responds to the requestProfileCard method.
See the protobuf schema for profileCardData's object structure.
playerInfoResponse- The raw playerInfo object.leaderboards- Empty array, details unknown.player_infos- List of player informationaccount_id- The Account ID of the requested user.name- The display name for the user.country_code- The abbreviated country code for the user, i.e.us,cn, etc...fantasy_role- The role of the player, either core or support,1and2respectively.team_id- The numerical id of the user's team.team_name- The name of the team the user is on, ex:Cloud9team_tag- The abbreviated tag of a team prepended to a player's name, ex:C9sponsor- The sponsor listed in the player's official info, ex:HyperXis_locked- Whether or not the user's official player info has been locked from editing,trueorfalse.is_pro- Whether the player is considered a pro player by Valve,trueorfalse.
Emitted when GC responds to the requestPlayerInfo method.
See the protobuf schema for playerInfoData's object structure.
trophyListResponse- The raw trophyListResponse object.profile_name- The name displayed on the user's dota profile page and profile card.trophies- List of trophies owned by the user. The following values are all integers.trophy_id- Id of the trophy.trophy_score- The score this trophy has counted. This is usually a level, but can represent other things, like number of challenges completed, or coins collected, etc...last_updated- The last time the trophy has been updated, in Unix time.
Emitted when GC responds to the requestTrophyList method.
TODO
account_id- Account ID whom the passport belongs to.passportData- The raw passport data object.
Emitted when GC responds to the requestPassportData method.
See the protobuf schema for passportData's object structure.
week- Week the data is associated with.featuredPlayers- Array of featured players for that week.[{ account_id, heroId, averageScaledMetric, numGames }]featuredFarmer- Featured farmer for that week.{ account_id, heroId, goldPerMin, match_id }hallOfFameResponse- Raw response object.
Emitted when the GC responds to the requestHallOfFame method.
TODO
match_id- Match ID whom the data is associatd with.matchDetailsData- The raw match details data object.
Emitted when GC responds to the requestmatchDetails method.
See the protobuf schema for matchDetailsData's object structure.
last_match- Bool, usage unknownmatchMinimalDetailsData- The raw match details data object.
Emitted when GC responds to the requestMatchMinimalDetails method.
See the protobuf schema for matchMinimalDetailsData's object structure.
matchgroups_version- Version of the current list of match groups.match_groups- Array of CMsgMatchmakingMatchGroupInfo objects. Contains info on the number of people searching and ping penalty.matchmakingStatsResponse- Raw response object.
Emitted when te GC response to the requestMatchmakingStats method. The array order dictates which matchmaking groups the figure belongs to.
The groups are discoverable through regions.txt in Dota 2's game files. We maintain an indicative list without guarantees in this README.
This list is manually updated only when changes are detected by community members, so it can be out of date.
Here are the groups at the time of this sentence being written (with unecessary data trimmed out):
"USWest": {"matchgroup": "0"},
"USEast": {"matchgroup": "1"},
"Europe": {"matchgroup": "2"},
"Singapore": {"matchgroup": "3"},
"Shanghai": {"matchgroup": "4"},
"Brazil": {"matchgroup": "5"},
"Korea": {"matchgroup": "6"},
"Stockholm": {"matchgroup": "7"},
"Austria": {"matchgroup": "8"},
"Australia": {"matchgroup": "9"},
"SouthAfrica": {"matchgroup": "10"},
"PerfectWorldTelecom": {"matchgroup": "11"},
"PerfectWorldUnicom": {"matchgroup": "12"},
"Dubai": {"matchgroup": "13"},
"Chile": {"matchgroup": "14"},
"Peru": {"matchgroup": "15"},
"India": {"matchgroup": "16"},
"PerfectWorldTelecomGuangdong": {"matchgroup": "17"},
"PerfectWorldTelecomZhejiang": {"matchgroup": "18"},
"Japan": {"matchgroup": "19"}
matches- A list of matches. Each match contains:match_id- Match IDstart_time- Unix time of the start of the matchduration- Duration of the match in secondsgame_mode- Game modewinning_team- Team who won the matchplayers- List of all the players in the game, contains id, hero, K/D/A and itemsleague- Information on the league if this is a league match
Emitted when the GC responds to the requestTopFriendMatches method.
lobby- The full lobby object (see CSODOTALobby).
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.
Emitted when the Lobby Invite is cleared, for example when accepting/rejecting it or when the lobby is closed.
result- The result object frompracticeLobbyJoinResponse.practiceLobbyJoinResponse- The raw response object.
Emitted when the GC responds to joinPracticeLobby method.
Emitted when leaving a lobby (aka, the lobby is cleared). This can happen when kicked, upon leaving a lobby, etc. There are other callbacks to tell when the bot has been kicked.
result- The result object frompracticeLobbyJoinResponse.practiceLobbyResponse- The raw response object.
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 practiceLobbyUpdate events.
TODO
game_modes- List of custom game modes that are available in a given server regioncustom_game_id- ID corresponding to a custom game modelobby_count- Number of lobbies available for the game modeplayer_count- Number of players playing this game mode
Emitted when the GC responds to requestJoinableCustomGameModes. Never seems to return more then ten results.
steam_id- The steam ID of the person the invite was sent togroup_id- The group ID of the person the invite was sent tois_online- Whether or not the person the invite was sent to is online
Emitted when the GC has created the invitation. The invitation is only sent when the invitee is online.
party- The full party object (see CSODOTAParty).
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.
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.
partyInvite- The full party invite object (see CSODOTAPartyInvite).
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.
Emitted when the Party Invite is cleared, for example when accepting/rejecting it or when the party is closed.
null- nothingliveLeaguesResponse- Integer representing number of live league games.
month- Int representing which month this data represents.year- Int representing which year this data represents.leagues- Array of CMsgLeague objects
Emitted when the GC responds to requestLeaguesInMonth method.
Notes:
- The
monthproperty is used to filter the data to the leagues which have matches scheduled in the given month, however thescheduleobject contains schedules for a league's entire duration - i.e. before or aftermonth. monthis also zero-aligned, so January = 0, Febuary = 1, March = 2, etc.- Not every participating team seems to be hooked up to Dota 2's team system, so there will be a few
{ teamId: 0 }objects for some schedule blocks.
The leagues object is visualized as follows:
leagues: [{ // An array of CMsgLeague objects
leagueId, // ID of the league associated
schedule: [{ // An array of CMsgLeagueScheduleBlock objects
blockId, // ID represending this block
startTime, // Unix timestamp of a scheduled match (or group of matches)
finals, // Boolean represending if this match is a final.
comment, // Comment about this scheduled block - often the team names & position in bracket
teams: [{ // An array of CMsgLeagueScheduleBlockTeamInfo objects
teamId, // ID of the associated team
name, // The teams name
tag, // The teams tag
logo // The teams logo
}]
}]
}]
matches- A list of matches. Each match contains:match_id- Match IDstart_time- Unix time of the start of the matchduration- Duration of the match in secondsgame_mode- Game modewinning_team- Team who won the matchplayers- List of all the players in the game, contains id, hero, K/D/A and itemsleague- Information on the league if this is a league match
Emitted when the GC responds to the requestTopLeagueMatches method.
TODO
sourceTVGamesResponse- The raw response object
Emitted when the GC responds to the requestSourceTVGames method. Multiple events are emitted when requestSourceTVGames is passed with start_game > 0 or with one or more lobby_ids.
UNSPECIFIED: 0USWEST: 1USEAST: 2EUROPE: 3KOREA: 4SINGAPORE: 5AUSTRALIA: 7STOCKHOLM: 8AUSTRIA: 9BRAZIL: 10SOUTHAFRICA: 11PERFECTWORLDTELECOM: 12PERFECTWORLDUNICOM: 13
Use this to pass valid server region data to createPracticeLobby.
DOTA_GAMEMODE_NONE: 0- NoneDOTA_GAMEMODE_AP: 1- All PickDOTA_GAMEMODE_CM: 2- Captain's ModeDOTA_GAMEMODE_RD: 3- Random DraftDOTA_GAMEMODE_SD: 4- Single DraftDOTA_GAMEMODE_AR: 5- All RandomDOTA_GAMEMODE_INTRO: 6- UnknownDOTA_GAMEMODE_HW: 7- DiretideDOTA_GAMEMODE_REVERSE_CM: 8- Reverse Captain's ModeDOTA_GAMEMODE_XMAS: 9- The GreevilingDOTA_GAMEMODE_TUTORIAL: 10- TutorialDOTA_GAMEMODE_MO: 11- Mid OnlyDOTA_GAMEMODE_LP: 12- Least PlayedDOTA_GAMEMODE_POOL1: 13- Limited HeroesDOTA_GAMEMODE_FH: 14- CompendiumDOTA_GAMEMODE_CUSTOM: 15- Unknown, probably ti4 techies reveal.
Use this to pass valid game mode data to createPracticeLobby.