package tbmatch
Get desktop application:
View/edit binary Protocol Buffers messages
service AccountService
account.proto:178rpc ChangeEmailAddress (, )
account.proto:259Update the account login email address.
message
account.proto:114Change the e-mail address for this account.
optional string new_email_address = 1
optional string secret_answer = 2
Provide 2 forms of authentication.
optional string password = 3
rpc ChangePassword (, )
account.proto:254Update the account password.
message
account.proto:105Change the password for this account.
optional string old_password = 1
Provide the correct existing account password.
optional string new_password = 2
Provide a new password that adheres to the password requirements.
rpc CheckHandle (, )
account.proto:183Check if a user handle is valid and available for use.
message
account.proto:173optional string handle = 1
rpc GetSecretQuestion (, )
account.proto:198Get the secret question for sending a password reset code mail.
message
account.proto:141optional string email = 1
message
account.proto:145optional string secret_question_msg = 1
rpc GetUserInfo (, )
account.proto:221Fetch basic account information
rpc GetUserPrefs (, )
account.proto:243Fetch current account preferences.
rpc RedeemAccessCode (, )
account.proto:264Apply a registration or access code.
message
account.proto:123Redeem an access code to grant the account additional roles or objects.
optional string code = 1
rpc RegisterUser (, )
account.proto:188Apply for an account.
message
account.proto:128Request to create an account.
optional spec = 1
optional prefs = 2
optional string registration_key = 10
Registration key (if required)
For unverified accounts, send a new validation e-mail.
rpc ResetPassword (, )
account.proto:214Reset the account password using a validation code.
message
account.proto:164optional string email = 1
Account to reset.
optional string validation_code = 2
String from the email sent by SendPasswordResetRequest.
optional string new_password = 3
New password to set. Must obey password restrictions.
Send a password reset mail with a temporary validation code. Must provide valid secondary authentication.
message
account.proto:149optional string email = 1
optional string secret_question_msg = 2
Secret question message ID for the account.
optional string secret_question_answer = 3
Answer to secret question.
rpc SetContactAddress (, )
account.proto:238Update the user's contact address fields. A new account has no contact address; but once set it cannot be removed.
rpc SetLocale (, )
account.proto:232Change the user's locale. Fails of the given locale string is not supported.
message
account.proto:100Request to change the default locale of the account.
optional string locale = 1
rpc SetUserPrefs (, )
account.proto:249Update account preferences. Only set fields will be updated.
rpc ValidateUser (, )
account.proto:193Validate a pending account using the secret key.
message
account.proto:137Validate a pending account or e-mail address change.
optional string nonce = 1
Checks a reset code for validity.
message
account.proto:157optional string email = 1
Account to verify.
optional string validation_code = 2
String from the email sent by SendPasswordResetRequest.
service CrashReportService
crash.proto:14rpc CrashReport (, )
crash.proto:16message
crash.proto:7optional string app_name = 1
optional string build_version = 2
optional string machine_id = 3
Unique Windows identifier for the machine that crashed.
optional bytes bundle = 4
Zip of crash report contents
service EventService
event.proto:342rpc EventPing (, )
event.proto:351No-op ping method for client to (re-)establish connectivity.
rpc GetEvent (, )
event.proto:345Get any pending events matching the current filter, or wait for new events.
message
event.proto:333optional string version = 1
message
event.proto:337optional string version = 1
repeated event = 2
service LobbyService
lobby.proto:123rpc CreateLobby (, )
lobby.proto:127Create a new lobby and join it, with the creator as owner. Fails if user is already in a lobby. Success confirmed by LobbyJoin event.
message
lobby.proto:71optional LobbyType type = 1
optional string name = 2
rpc GetLobbyJoinCode (, )
lobby.proto:134Get the secret code for joining this lobby. Only members marked as owner may request the code.
message
lobby.proto:77optional int64 lobby_id = 1
message
lobby.proto:80optional string join_code = 1
rpc JoinLobbyByCode (, )
lobby.proto:141Join a lobby using a secret code provided by a lobby owner. Fail if user is already joined to another lobby. Success confirmed by LobbyJoin event.
message
lobby.proto:85optional string code = 1
rpc LeaveLobby (, )
lobby.proto:149Leave the currently joined lobby. If the player is the last owner, another owner is assigned at random. If player is last member, lobby is destroyed. Success confirmed by LobbyLeave event.
rpc LobbyBanUser (, )
lobby.proto:173Remove a user from the lobby and permanently restrict them from re-entering.
message
lobby.proto:110optional int64 lobby_id = 1
optional int64 account_id = 2
rpc LobbyRemoveUser (, )
lobby.proto:179Remove a user from the lobby.
message
lobby.proto:115optional int64 lobby_id = 1
ID of the lobby.
optional int64 account_id = 2
Account ID of the user to kick.
rpc LobbySetGameOptions (, )
lobby.proto:167Set the global options for matches generated by this lobby -- owner only.
message
lobby.proto:98optional options = 1
Any set fields will be updated in the lobby GameConfig template.
rpc LobbySetOwner (, )
lobby.proto:161Grant or revoke owner status to another member of the lobby -- owner only.
message
lobby.proto:103optional int64 lobby_id = 1
optional int64 account_id = 2
optional bool set_owner = 3
rpc LobbySetReady (, )
lobby.proto:155Set ourselves ready or not-ready for a match in the joined lobby if the lobby state allows it.
message
lobby.proto:90optional bool ready = 2
optional network = 10
If ready == true, layer network and character data for the next match.
optional character = 11
service MatchService
match.proto:657rpc CancelGetMatch (, )
match.proto:690Cancel an outstanding match request.
rpc DesyncReport (, )
match.proto:711Report a desync.
message
match.proto:293optional int64 match_id = 2
optional int32 slot = 3
optional bytes bundle = 4
rpc GetGameProfile (, )
match.proto:660Get the full GameProfile to bootstrap after a successful login.
message
match.proto:630Everything the RT client needs at startup.
optional int64 account_id = 1
optional string handle = 2
optional string given_name = 3
optional string locale = 4
optional stats = 10
Player and character experience
optional player_prefs = 13
Saved preferences for the player
optional feature_set = 20
Server capabilities enabled for this session.
rpc GetGameReplayRecord (, )
match.proto:705Fetch saved replay data for a given game that the calling player participated in. Old games may be not be available after a while.
message
match.proto:424optional int64 match_id = 1
Match to fetch replay for.
optional int32 game_number = 2
Game number of the replay.
message
match.proto:431optional record = 1
rpc GetMatch (, )
match.proto:676Request to be matched with another player.
message
match.proto:366optional MatchType type = 1
Type of match requested.
optional int64 arena_id = 2
If MT_TOURNAMENT, arena ID.
optional network = 10
Client's claimed network address.
optional character = 11
Client's desired character loadout for the match.
optional SkillEstimateType skill_estimate = 15
Client's approximation of their skill. Only taken into account after first login/first match.
rpc GetPlayerStats (, )
match.proto:720message
match.proto:621optional stats = 1
rpc GetRecentGames (, )
match.proto:725message
match.proto:625repeated game = 1
rpc PingTest (, )
match.proto:670Request a server ping test. This must be done before queuing for a match, and every so often afterward. Returns a server and port awaiting a brief ping test session.
message
match.proto:288optional config = 1
Server to use for an immediate latency test.
rpc ResetGame (, )
match.proto:698Resets the character layout of a training match in progress. If successful, results in a GameOverEvent, GameBeginEvent with the requested GameOptions and updated character for the given slot.
message
match.proto:646optional int64 match_id = 1
The in-progress match to reset.
optional character_spec = 2
The new character spec to use for the next game.
optional training_options = 3
Proposed training game options for the next game.
rpc ResumeGetMatch (, )
match.proto:683Request to be matched with another player; attempt to resume old spot in match queue.
message
match.proto:502optional updated_prefs = 1
New preferences. If setting character preferences, set the entire state (spec and all variants).
service SessionService
session.proto:47rpc GetGameSessionTicket (, )
session.proto:55Get a ticket for the indicated game type. May only be granted if the corresponding game access bit is held by the user.
message
session.proto:39optional GameType game = 1
optional string client_build_version = 2
Build number of the client. If set, checks that the build is allowed.
message
session.proto:26optional GameType game = 1
optional string nonce = 2
rpc Login (, )
session.proto:49Establish an authenticated session.
message
session.proto:14optional string login = 1
Either handle or e-mail address can be used.
optional string password = 2
optional string build_version = 5
Client build. May require certain version to login.
optional string __deprecated_remote_ip = 10
Remote IP now passed via XFF header by TBFE
rpc Logout (, )
session.proto:66Invalidate session.
Redeem a game session ticket. The resulting session is distinct from the launcher session but enforced max one per account.
message
session.proto:31optional GameType game = 1
optional string nonce = 2
optional string build_version = 5
Client build. Server may require a certain version to login.
service ShopService
shop.proto:314********************** Stored Payment Methods *************************
Add a stored payment method used to make in-game purchases. Also makes it the default method.
rpc GetAccountBalance (, )
shop.proto:377Get the current account balance.
message
shop.proto:301optional string currency = 1
Currency of the balance to retreive. If not given, uses the user's default currency.
optional bool include_pending = 2
message
shop.proto:307optional string currency = 1
optional balance = 2
optional pending = 3
Get order records that affected the account balance. Server-enforced limit on time range and result size.
message
shop.proto:275optional string currency = 1
Currency of the balance. If not specified, will use the account's default currency.
optional create_time = 2
Creation date time range. Server may impose limit; will return last 30 days if not set.
optional sort = 4
Sort order to sort the orders in short order.
optional int32 offset = 5
Skip past this many records in the result.
message
shop.proto:290optional string currency = 1
Currency of the affected balance.
repeated entry = 2
Summaries of orders that affected the balance.
optional bool end_of_data = 3
True when the included results reached the end of the query result.
rpc GetAccountOrderHistory (, )
shop.proto:363Get order records belonging to the calling account. Server-enforced result size limit per-call.
message
shop.proto:260Get the account's purchase order history. Result size limit controlled by server configuration.
optional sort = 2
Order sorting
optional int32 offset = 5
Skip past this many records in the result.
message
shop.proto:267repeated orders = 1
Orders that matched the criteria.
optional bool end_of_data = 2
True when the included results reached the end of the query result.
rpc GetPurchaseOrder (, )
shop.proto:357Get an existing purchase order. For a non-admin user, the query will be restricted to those orders belonging to the account.
message
shop.proto:254Load a specific purchase order.
optional int64 order_number = 1
Get the current stored payment method. Returns msg.shop.paymentMethod.notExist if none has been set.
message
shop.proto:82repeated method_list = 1
List of all stored payment methods.
optional int64 default_method_id = 2
Which method is set as the default.
Remove the stored payment method from the account. If the default method is removed, no method will be marked as default; the user must elect a new one.
Set the payment method as the default.
rpc SubmitPurchaseOrder (, )
shop.proto:351Submit a new purchase order.
message
shop.proto:242Submit a purchase order. Provide minimum required fields in PurchaseOrder, and specify a funding source.
optional order = 1
optional funding = 20
message
shop.proto:246optional int64 order_number = 1
Generated order number.
optional OrderStatus order_status = 2
Current status of the order.
This overwrites all existing values. method_id must be set. Masked values returned by GetStoredPaymentInfo will keep their original values.
message
shop.proto:216Summary of an order that affected the account balance
Used in:
optional int64 order_number = 1
Order number.
optional bool balance_load = 2
True for balance load events.
optional amount = 3
Amount of the balance change. Balance loads will be positive, deductions will be negative.
optional OrderStatus order_status = 4
Status of the order.
optional string create_time = 5
Creation time of the order.
message
shop.proto:199Used in:
optional BalanceEntrySort.SortBy sort = 1
Sort-by column.
optional bool descending = 3
Set to true for highest values first.
Used in:
ORDER_ID = 1
STATUS = 2
CREATE_TIME = 3
ENTRY_AMOUNT = 4
message
shop.proto:30Used in:
optional string first_name = 1
AuthNet customerAddressType
50
optional string last_name = 2
50
optional string company = 3
50
optional string address = 4
Obscured on fetch. Submit obscured value to leave unchanged.
60
optional string city = 5
40
optional string state = 6
40
optional string zip = 7
20
optional string country = 8
60
optional string phone_number = 9
Obscured on fetch. Submit obscured value to leave unchanged.
255
message
match.proto:69Definition of the character the user intends to play in the next available match.
Used in: , , , , , , , ,
optional string type_name = 1
Type name of character, e.g. "atl"
optional int32 secondary_meter = 10
Selected option for secondary meter (defensive or offensive)
optional variants = 22
Special move variants selection
message
match.proto:438Used in:
optional string type_name = 1
Type name of the game character.
optional int32 xp_level = 2
Experience level.
optional int32 xp = 3
Total experience points.
optional int32 wins = 4
Total wins & losses.
optional int32 losses = 5
repeated int32 level_xp_min = 6
Total experience point thresholds for the current and subsequent levels.
message
match.proto:152A single chat stream event.
optional int64 time = 1
Unix time the chat was generated.
optional string origin = 2
Handle of the originating player. If unset, system-generated message.
optional string text = 3
Chat text.
message
match.proto:48Which optional client features the server has instructed to enable.
Used in: , ,
repeated feature = 1
List of enabled features and config values.
message
account.proto:58User's contact address fields.
Used as request type in: AccountService.SetContactAddress
Used as field type in: ,
optional string address_1 = 1
optional string address_2 = 2
optional string city = 3
optional string region = 4
optional string zip_code = 5
optional string phone_number = 6
message
match.proto:300Internal-only type for tracking pending desyncs.
Used in:
optional int64 match_id = 1
optional int32 slot = 2
optional string report_path = 3
optional game_config = 4
optional int64 timestamp = 5
optional string build_version = 6
message
event.proto:260Event container union. Returned in GetEvent.
Used in: ,
optional int64 event_id = 1
Unique ID for the event.
optional Event.Type type = 2
Type of the event.
optional int64 timestamp_msec = 3
Time the event was generated.
optional filter_changed = 13
Event fields based on type.
optional wait_match_progress = 14
optional match_created = 15
optional match_outcome = 18
optional match_abandoned = 21
optional match_connected = 23
optional match_over = 24
optional game_begin = 25
optional game_input = 26
optional game_over = 27
optional user_check_network = 30
optional user_session_closed = 31
optional ping_test_complete = 40
optional lobby_join = 50
optional lobby_leave = 51
optional lobby_update = 52
optional lobby_match_start = 53
Used in:
E_UNKNOWN = 0
E_FILTER_CHANGED = 13
E_WAIT_MATCH_PROGRESS = 14
E_MATCH_CREATED = 15
E_MATCH_OUTCOME = 18
E_MATCH_ABANDONED = 21
E_MATCH_CONNECTED = 23
E_MATCH_OVER = 24
E_GAME_BEGIN = 25
E_GAME_INPUT = 26
E_GAME_OVER = 27
E_USER_CHECK_NETWORK = 30
E_USER_SESSION_CLOSED = 31
E_PING_TEST_COMPLETE = 40
E_LOBBY_JOIN = 50
E_LOBBY_LEAVE = 51
E_LOBBY_UPDATE = 52
E_LOBBY_MATCH_START = 53
message
match.proto:39Used in:
optional string tag = 1
Feature's unique tag.
optional string value = 2
Config value set for the feature, if any.
message
event.proto:11The event filter has been updated; any pending GetEvent call should reload the filter. Target: q_user_N
Used in:
(message has no fields)
message
shop.proto:105Used in:
optional Funding.Source source = 1
optional int64 stored_method_id = 2
optional string stored_method_card_code = 3
When using a stored method, use this CVV value for validation.
optional custom_method = 4
Used in:
FS_NONE = 0
None indicated.
FS_ACCOUNT_BALANCE = 1
Use available account balance for the order's currency.
FS_STORED_DEFAULT = 2
Use the current default stored payment method.
FS_STORED = 3
Use the stored payment method identified by stored_method_id.
FS_CUSTOM = 4
Use a custom payment method described by custom_method.
message
event.proto:79The next game is beginning in this match. Target queue: match
Used in:
optional int64 match_id = 1
optional next_game = 2
optional int32 sequence_id = 3
Populated from the sequenceId field in Redis under the match's key. Should be used by the client, if present, to determine whether to process this event.
message
match.proto:181Configuration for a single game in a match, suitable for sending to one of the participating clients.
Used in: , , , , , , , , , ,
repeated player = 2
Each player's character info.
optional options = 5
Global options for this game.
optional int64 match_id = 3
The server-assigned unique ID of the match.
optional int32 __deprecated_game_number = 4
deprecated
message
match.proto:182Used in:
optional int64 user_id = 1
optional string handle = 2
optional character = 3
optional int32 echelon = 10
optional int32 tier = 11
message
match.proto:234Server-side record of the game in progress.
Used in:
optional game = 1
Game being played.
optional GameDescriptor.Source source = 8
repeated player = 7
Extra details for each player slot.
optional bytes portal_uuid = 3
Portal session in use.
optional MatchType type = 4
For source == MATCH_MAKER, queue this match was generated by. MT_LOBBY indicates a lobby match.
optional string build_version = 5
Build version of the matched clients.
optional int64 lobby_id = 9
For source == LOBBY, lobby ID of the owning lobby.
repeated __deprecated_endpoint = 2
repeated string __deprecated_remote_ip = 6
message
match.proto:247Used in:
optional endpoint = 1
GameEndpointConfig player is using to connect to Portal.
optional string remote_ip = 2
Remote IP of the player.
optional float rating = 3
Rating used to create the match.
optional float wait_time = 5
How long waiting in the match queue, in seconds.
optional float ping_score = 6
The ping score to the opponent in the match. 0 if no existing ping score.
optional int32 echelon = 10
Ranking values used to make the match.
optional int32 tier = 11
optional int32 points = 12
Used in:
MATCH_MAKER = 1
Match by blind-queue rating match-maker.
LOBBY = 2
Matched by user lobby.
message
match.proto:216Connection information for one of the players.
Used in: , , , ,
optional int32 slot = 1
Which player slot to control (0 = one, 1 = two)
optional server = 2
Server address.
optional fixed64 secret = 3
64-bit secret to gain access to the match.
optional float ping_score_threshold = 4
Ping threshold for the handshake between peers.
optional bytes shared_key = 5
The 128-bit shared key used to hash client packets
message
event.proto:90Batch of compressed inputs. Target queue: match
Used in:
optional int64 match_id = 1
optional int32 start_frame = 2
First frame number of input stored in bits.
optional int32 num_bits = 3
Number of bits to read from bits.
optional bytes bits = 4
Encoded frame inputs.
optional bool final = 5
True if this is the last set of inputs for a game.
message
match.proto:164Used in: , , , ,
optional GameOptions.Mode mode = 1
optional training_options = 20
Stage etc.
Used in:
GM_FIGHT = 1
Fight to the finish -- best of N games, etc.
GM_TRAINING = 2
No one dies -- client exit completes the match.
Player-specific outcome enum of a particular game.
Used in:
GO_WON = 1
GO_LOST = 2
GO_DRAW = 3
message
event.proto:108Game reached a valid outcome. Target queue: match
Used in:
optional int64 match_id = 1
optional report = 2
optional int32 sequence_id = 3
message
match.proto:598Information about a previously played game.
Used in:
optional int64 match_id = 1
optional int32 game_number = 2
optional MatchType type = 3
Type of match the game belonged to.
optional config = 4
Match start conditions.
optional int32 win_slot = 5
Which slot won the match.
optional string start_time = 6
Game start time (RFC3339 string).
optional int32 duration_secs = 7
Game duration in seconds.
optional bool has_replay = 10
Is replay data available?
message
match.proto:316The GameReplayRecord allows us to replay the game.
Used in:
optional config = 1
Initial config
optional input_record = 2
P1 and P2 inputs for all the frames that matter (between GGPO Ready and confirmed last hit)
optional int32 game_number = 3
Game number
message
match.proto:389The GameReport is serialized in the Goodbye packet send to portal immediately upon determination of the game outcome. Iff both players sent the same GameReport, the game outcome is considered valid and the match will proceed. The serialized size of this proto should not exceed PORTAL_MAX_OUTCOME_SIZE.
Used in: ,
optional int32 win_slot = 1
Player slot (0, 1) that won the match.
optional bool draw = 2
Was match a draw?
message
match.proto:508Outcome of a game within a match.
optional int64 match_id = 1
Match ID.
optional int32 game_number = 2
Game number in the match.
optional GameOutcome outcome = 3
Resolution of the game.
repeated int32 slot_wins = 5
Number of games in the match each player slot has won.
optional int32 duration_secs = 6
Game duration in seconds.
Used in: , ,
GT_RISING_THUNDER = 100
Rising Thunder.
message
match.proto:310The InputRecord is a serialized version of both player's inputs
Used in: ,
optional bytes input_record = 1
Input record blob. Engine knows how to decode it.
message
lobby.proto:38Used in: ,
optional int64 lobby_id = 1
Unique identifier for this lobby.
optional LobbyType type = 2
Style of gameplay conducted in the lobby.
optional string name = 3
Name given by creator.
optional LobbyState state = 5
Current state of the lobby. Updated by LobbyStatusEvent.
repeated member = 10
People currently in the lobby. Updated by LobbyMemberUpdateEvent.
optional options = 11
Options included for the next match generated by this lobby.
optional game_config = 20
For state == LS_MATCH, start config of the game being played.
repeated int64 queue = 30
For type == LT_QUEUED, this is the current queue order of account IDs. Updated by LobbyMemberUpdateEvent.
message
event.proto:191Player has now joined a lobby.
Used in:
optional lobby = 1
Current state of the joined lobby.
message
event.proto:198Player has left the current lobby, either voluntarily, because they were banned, or because the last owner left.
Used in:
optional int64 lobby_id = 1
optional LobbyLeaveEvent.Reason reason = 2
Used in:
LEFT = 1
Left lobby voluntarily.
BANNED = 2
Banned from the lobby.
REMOVED = 3
Removed by owner, but not banned permanently
message
event.proto:244An idle lobby has two ready players. New match started, and the recipient is involved.
Used in:
optional int64 lobby_id = 1
optional int64 match_id = 2
The ID of the newly created match.
optional config = 3
Game config for first game of the match.
optional endpoint = 4
Player slot and connection.
message
lobby.proto:26Used in: ,
optional int64 account_id = 1
optional string handle = 2
optional bool owner = 10
Lobby owner?
optional bool ready = 11
Ready for next match?
Used in: ,
LS_IDLE = 1
Waiting for 2 ready players.
LS_MATCH_PENDING = 2
Match is ready to start.
LS_MATCH = 3
A match is in progress.
Used in: ,
LT_QUEUED = 1
message
event.proto:219Sent to current members about changes in the lobby state. Notifies users joining and leaving, change of ready states, queue order, and other lobby states. Any fields not set should be left at their previous state.
Used in:
optional int64 lobby_id = 1
repeated update = 2
Members added or whose state changed.
repeated int64 removed = 3
Members who left.
optional LobbyState state = 4
Current state of the lobby.
optional game_config = 5
For state == LS_MATCH, GameConfig that started the running match.
repeated int64 queue = 6
Order of queued members by account_id.
optional options = 7
Options for games generated by this lobby.
message
log.proto:7This represents a single log message generated by an application pertaining to some entity. e.g.: One log message from Portal for a given Match.
optional int64 timestamp_msec = 1
The timestamp at which this message was generated.
optional string message = 2
The log or debug message.
optional LogMessage.Priority priority = 3
The log level of the message.
optional source = 4
The source of the log message.
The type of entity to which the log message pertains
MATCH = 1
An online match
The various possible log levels
Used in:
FATAL = 1
The application will probably terminate after this message is logged.
ERROR = 2
An error was encountered, but the application will resume.
INFO = 3
Something unexpected or noteworthy occurred that didn't break anything.
TRIVIA = 4
Verbose log entries, debug information, etc.
message
log.proto:15Information about the originator of the log message
Used in:
optional string application = 1
The name of the application that generated the message.
optional string address = 2
The IP address or hostname of the machine from which the message originated.
Used in: , , ,
ACTIVE = 1
Account accepts logins with a valid password.
DISABLED = 3
Account is permanently frozen and can only be enabled by an administrator.
PENDING_VALIDATION = 4
Account uses an e-mail address that has not yet been confirmed.
message
event.proto:118A match user was playing has been abandoned, because players sent conflicting goodbye packets (either intentionally or because the p2p connection got broken) Stop playing the match and exit back to the menu. Target queue: user
Used in:
optional int64 match_id = 1
message
event.proto:73Observed match has successfully established player connection and loading has begun. Target queue: match
Used in:
optional int64 match_id = 1
message
event.proto:63A new match was created. Target queue: match
Used in:
optional game_config = 3
optional int64 __deprecated_match_id = 1
repeated int64 __deprecated_user_id = 2
message
match.proto:560Used in:
optional int32 player_xp = 10
Starting player total XP.
optional int32 player_level = 11
Starting player level.
repeated int32 player_level_xp_min = 12
Experience thresholds for current player level (index 0), plus a few more in case the player levels up.
optional int32 player_match_xp = 21
XP earned from the match.
optional int32 player_win_bonus_xp = 22
XP bonus for winning.
optional int32 player_boost_xp = 23
Optional XP boost.
optional int32 character_start_xp = 30
Original character XP.
optional int32 character_match_xp = 31
XP earned by character from the match.
optional int32 character_win_bonus_xp = 32
Character XP bonus for winning.
optional int32 character_boost_xp = 33
Optional character XP boost.
optional int32 character_level = 35
Starting character level.
repeated int32 character_level_xp_min = 34
Experience thresholds for current character level (index 0), plus a few more in case the character levels up.
optional int32 rank_points = 40
Ranking tier points awarded. Could be 0 or negative.
Player-specific outcome enum of a complete match.
Used in:
MO_WON = 1
MO_LOST = 2
MO_DISCONNECT = 3
message
event.proto:152Match completed that user participated in. Notify about what the server recorded. This event could arrive anywhere along the game sequence, since it may also indicate early disconnection of the opponent.
Used in:
optional result = 1
What happened in the match.
optional exp = 2
Spoils of war.
optional stats_update = 3
Updates to user stats.
message
event.proto:124Observed match has completed. Target queue: match
Used in:
optional int64 match_id = 1
optional MatchOverEvent.Status status = 2
optional int32 win_slot = 3
if status==VALID, player slot that won if any.
optional bool draw = 4
if status==VALID, true iff the result was a draw.
Used in:
ABANDONED = 1
Match did not complete due to a server error, desync or a network problem that affected both players.
DISCONNECT = 2
Match ended because one player disconnected.
VALID = 3
Match ended with a valid outcome.
Used in:
EQUALS = 1
String must equal the match value exactly.
PREFIX = 2
String begins with the match value.
CONTAINS = 3
String contains the match value.
message
match.proto:410The MatchReport is sent from portal to TBMatch.
Used in:
optional bool players_agree = 1
Did the players have the same reported results?
optional int32 win_slot = 2
Player slot (0, 1) that won the match.
optional bool draw = 3
Was match a draw?
repeated game_report = 4
The game reports for the individual games
message
match.proto:525Used in:
optional int64 match_id = 1
Match ID.
optional MatchType type = 2
Type of match played.
optional string character_type_name = 3
Character played.
optional MatchOutcome outcome = 4
Won or lost?
optional bool peer_disconnect = 5
True if we won because the opponent disconnected.
optional string start_time = 6
Match start time (RFC3339 string).
optional int32 duration_secs = 7
Match duration in seconds.
optional int32 game_count = 8
Number of games played and won.
optional int32 games_won = 9
optional string opponent_character_type_name = 20
Opponent.
optional int64 opponent_user_id = 21
optional string opponent_handle = 22
optional bool __deprecated_has_replay = 30
Deprecated fields.
Used in: , , , , , , , , , ,
MT_UNRANKED = 1
Earn experience, but not ranking points.
MT_RANKED = 2
Earn experience, ranking points adjusted from outcome.
MT_TOURNAMENT = 3
Join elimination tournament.
MT_LOBBY = 4
Custom lobby match.
How the meter refills in training mode
Used in:
MRT_NORMAL = 1
Same as in online mode
MRT_REFILL = 2
Increase at constant rate
MRT_MAX = 3
Max out on reset
message
match.proto:53Used in: , , ,
optional string host_name = 1
Host name or IP address where the client or server can be reached.
optional int32 port = 2
UDP port on which the client will be listening for a match.
message
match.proto:206Configuration for the next game in a match, allowing for users to change their character specs.
Used in: ,
repeated character_spec = 1
The new character specs to use for the next game.
optional options = 2
Proposed game options for the next game. May only be specified during a training match.
message
shop.proto:179Used in: ,
optional OrderSort.SortBy first = 1
First sort-by column.
optional OrderSort.SortBy second = 2
Secondary sort-by column.
optional bool descending = 3
Set to true for highest values first.
Used in:
ORDER_ID = 1
STATUS = 2
CREATE_TIME = 3
MODIFY_TIME = 4
TOTAL_AMOUNT = 5
LAST_NAME = 6
Used in: , , , ,
NEW = 1
New order that has not been processed yet.
PENDING = 2
Order accepted and is pending settlement.
FAILED = 3
Order payment method failed.
COMPLETE = 4
Payment has been accepted and goods delivered. For item orders, this state occurs on approval. For balance loads, after settlement has been observed.
CANCELED = 5
Order canceled before payment settled. Any goods that delivered in advance have been returned.
RETURN_PENDING = 6
Item return / refund requested; pending settlement.
RETURN_FAILED = 7
Refund was approved but failed to settle. Items not returned.
RETURNED = 8
Refund settled and items returned.
message
shop.proto:48Used as request type in: ShopService.CreateStoredPaymentMethod, ShopService.UpdateStoredPaymentMethod
Used as field type in: , ,
optional int64 method_id = 1
Unique ID provided by server. Leave unset during creation.
optional string card_number = 2
13-16 digits, no dashes or spaces. Obscured on fetch. Submit obscured value to leave unchanged.
optional string card_exp = 3
YYYY-MM Obscured on fetch. Submit obscured value to leave unchanged.
optional string card_ccv = 4
3 or 4 digit CCV numeric value. Not stored in AuthNet, but used during validation of create stored method, update stored method, and for transactions with a custom payment method.
optional string card_type = 5
Observed card issuer type (Visa, Discover, etc). This field is ignored for stored payment methods, but may be returned for processed orders.
optional billing = 10
The billing address. Unset indicates this payment method should use the account's first and last name, country, and current contact address. It is an error to leave unset when the contact address has not yet been stored.
optional string label = 60
Payment label, used to easily identify the card to the user.
message
shop.proto:90Used as request type in: ShopService.RemoveStoredPaymentMethod, ShopService.SetDefaultStoredPaymentMethod
optional int64 method_id = 1
message
event.proto:173The requested ping test has completed - now eligible to join a matching queue.
Used in:
optional int32 avg_rtt_ms = 1
Average measured round-trip time.
optional int32 max_rtt_ms = 2
Max round-trip time.
optional float loss_ratio = 3
Fraction of packets lost.
optional bool success = 4
Was the ping successful or not?
message
match.proto:490Used in: ,
optional string selected_char = 1
The last character the player selected
optional bytes local_player_prefs = 2
Serialized tbui LocalPlayerPreferences proto for local information that the server doesn't care about.
repeated char_prefs = 10
Character-specific preferences
message
user.proto:13optional PlayerState state = 1
optional active_match = 2
optional menu = 101
optional queue = 102
optional lobby = 103
message
user.proto:16Used in:
optional int64 match_id = 1
optional bool spectator = 2
message
user.proto:39Used in:
optional int64 lobby_id = 1
message
user.proto:22Used in:
optional Menu.Screen screen = 1
Used in:
SUMMARY = 1
PLAYER_STATS = 2
PLAYER_HISTORY = 3
STORE = 4
message
user.proto:33Used in:
optional MatchType match_type = 1
optional int64 start_time = 2
Used in:
PS_MENU = 101
PS_QUEUE = 102
PS_LOBBY = 103
message
match.proto:456Used in: , , ,
optional int32 xp_level = 1
Experience level.
optional int32 xp = 2
Total experience points.
optional int32 wins = 3
Total wins & losses.
optional int32 losses = 4
repeated char_stats = 5
Stats for each character. Any not present are assumed to be level 1 with 0 exp.
repeated int32 level_xp_min = 6
Total experience point thresholds for the current and subsequent levels.
optional int32 win_streak = 10
Number of consecutive wins.
optional int32 echelon = 20
Echelon index (0=Carbon, etc.) Display: "msg.rank.echelon.%d"
optional int32 tier = 21
Tier index within echelon (0=I, 1=II, etc.) Display: "msg.rank.tier.%d"
optional int32 points = 22
Points within tier.
optional int32 tier_max_points = 23
Number of points required before next tier can be reached.
optional int32 ranked_standing = 24
Player's standing in the echelon (only valid for highest echelon)
message
match.proto:399The report sent from portal to TBMatch to record information about a game. It's a superset of GameReport
Used in:
optional game_report = 1
optional int64 start_time = 2
optional int64 end_time = 3
optional game_config = 4
message
shop.proto:137Used as response type in: ShopService.GetPurchaseOrder
Used as field type in: , ,
optional int64 order_number = 1
System-generated order number. Unset in new requests.
optional string currency = 2
Currency used for all items and amounts in this order. For game currency, account balance funding source is required.
repeated item = 3
List of items requested for purchase. Minimum 1, max 30.
optional tax_amount = 4
Amount of tax and shipping included in the total.
optional ship_amount = 5
optional total_amount = 6
Total amount to charge the customer for this order. Must be equal to the sum of each item unit price times quantity, plus tax.
optional OrderStatus status = 10
Status of the order.
optional bool use_account_balance = 11
Was account balance used?
optional payment_method = 12
If not drawn from account balance, snapshot of the payment method used.
optional string create_time = 13
Creation and last modification time (RFC3339).
optional string modify_time = 14
optional int64 account_id = 32
Account that created the order.
optional payment_transaction = 33
optional refund_transaction = 34
message
shop.proto:128Used in:
optional int64 item_id = 1
Catalog item ID of the item.
optional int32 quantity = 10
Quantity of this item to be purchased.
optional unit_price = 11
Unit price for the item.
message
event.proto:322Wrapper for server-stored events.
optional event = 1
The event queued for delivery.
optional string restrict_session_id = 2
If set, only return the event if the requesting session matches this ID.
optional int64 expiry_timestamp_msec = 3
If set, discard the event after this time is reached.
message
match.proto:327Used in:
optional int32 old_frame = 1
The frame before the rollback
optional int32 rollback_frame = 2
The frame to roll back to
message
match.proto:335Used in:
optional input = 1
Both players inputs, including for frames that we later rolled back from.
repeated rollback_data = 2
Information about rollbacks
message
match.proto:345Rollbacks count, so P1 and P2 need their own RollbackInputRecord since their rollback histories are different.
repeated config = 1
Initial config for each game in a match
repeated rollback_record = 2
P1 and P2's inputs with rollbacks.
Self-estimate of user's familiarity with/skills at fighting games.
Used in:
SET_NONE = 0
SET_BEGINNER = 1
SET_INTERMEDIATE = 2
SET_ADVANCED = 3
SET_THUNDEROUS = 4
message
query.proto:15Matches a string value in a search criteria.
Used in: , ,
optional MatchPattern pattern = 1
optional string value = 2
message
query.proto:21Possible limits for a time range.
Used in: , , ,
optional string start = 1
Beginning of the allowed time range (RFC3339)
optional string end = 2
End of the allowed time range (RFC3339)
How the dummy opponent blocks
Used in:
TBT_DONT = 1
Same as in online mode
TBT_BLOCK = 2
Increase at constant rate
TBT_ALWAYS = 3
Max out on reset
message
match.proto:138Training mode configurable options
optional training_options = 1
repeated characters = 4
optional bool reset_level = 5
optional TrainingMovementType opponent_movement = 20
optional TrainingBlockType opponent_block = 21
message
match.proto:125Training mode configurable options that are also part of GameConfig
Used in: , ,
optional bool stun_enabled = 1
optional MeterRefillType super_refill = 2
optional MeterRefillType kinetic_refill = 3
optional bool short_cooldowns = 4
optional bool show_stats = 5
How the dummy opponent moves
Used in:
TMT_STAND = 1
Same as in online mode
TMT_CROUCH = 2
Increase at constant rate
TMT_JUMP = 3
Max out on reset
TMT_RECORD = 11
Max out on reset
TMT_PLAYBACK = 12
Max out on reset
message
shop.proto:95State of a merchant gateway transaction.
Used in:
optional int64 transaction_id = 33
External payment transaction ID.
optional string authorization_code = 34
Payment processor generated authorization code.
optional string transaction_status = 35
Last observed external transaction state. See http://www.authorize.net/support/ReportingGuide_XML.pdf page 26.
message
account.proto:9Used to create or update accounts.
Used in: , , ,
optional string email = 1
E-mail address. Required.
optional string password = 2
Desired password. Required for CreateUser and Register; existing accounts must use ResetPassword.
optional string handle = 3
Username as seen by other users.
optional string given_name = 4
Given (first) name. Required.
optional string family_name = 5
Family (last) name. Required.
optional string salutation = 6
Salutation, optional.
optional string birth_date = 10
Date of birth (RFC3339 string). Required.
optional string country = 11
3-letter code for country of residence.
optional string locale = 12
Locale for messages, currency format, etc.
optional string secret_question_msg = 20
Secret question message ID. Required.
optional string secret_question_answer = 21
Answer to the secret question. Required.
message
event.proto:162User failed to handshake during a match, check network settings.
Used in:
(message has no fields)
message
account.proto:81Full details and status of a user account. Can be returned both for the active session, and for account administration.
Used as response type in: tbadmin.AccountAdminService.LookupUser, AccountService.GetUserInfo, AccountService.ValidateUser
Used as field type in:
optional int64 account_id = 1
optional spec = 2
optional contact_address = 3
optional prefs = 4
optional int32 access_bits = 10
optional LoginStatus login_status = 11
optional string create_time = 60
When account was created (RFC 3339 string).
optional string modify_time = 61
Last time account was modified (RFC 3339 string).
optional string last_login_time = 62
Last login time, if any (RFC3339 string).
message
account.proto:46User settable options and preferences for the website.
Used as request type in: AccountService.SetUserPrefs
Used as response type in: AccountService.GetUserPrefs
Used as field type in: , , ,
optional bool balance_purchase_in_game = 1
Allow using account balance for in-game purchases.
optional bool email_offers = 20
Elect to receive special offers and promotional e-mail.
optional string default_currency = 30
Currency last used/selected.
message
event.proto:168The session is being forcibly closed. Could be due to login on another session, terminated by an administrator.
Used in:
optional string reason_msg_id = 1
message
match.proto:62Definition of variants selected for a character's moves
Used in:
repeated int32 specials = 1
4-element array for variant ids for special 1, 2, 3 and super
message
event.proto:16Progress updates from the GetMatch method. Target: q_user_N
Used in:
optional WaitMatchProgressEvent.Status status = 1
optional int64 match_id = 2
The ID of the newly created match.
optional config = 3
Game config to run for game 0 (when status == MATCH).
optional endpoint = 4
Player slot and connection for game 0 (when status == MATCH).
optional int32 users_waiting = 21
Some extra stats for a WAITING progress.
optional int32 __deprecated_users_online = 20
DEPRECATED FIELDS
Used in:
WAITING = 1
Waiting for an available match.
TIMEOUT = 2
Gave up waiting.
MATCH = 3
Match found.
CANCEL = 4
Request canceled by user.
PING_TEST_REQUIRED = 5
Failed to enter queue. A ping test must be performed before re-queuing for a match.
DENY_VERSION = 6
The build version is not allowed to enter the queue. A client update is required.
SERVER_MAINTENANCE = 7
The match-making server is down for maintenance. Try again later.