Repository navigation
Events Outgoing network messages
One event per message the client sends; names follow the game's message classes.
Generated from catalog/events.json by tools/gen_events_doc.py.
Contents (134 sections)
- net.out.AbilityCommandMessage
- net.out.AcceptInviteToGuildMessage
- net.out.AcceptPartyInviteMessage
- net.out.AckServerTimeMessage
- net.out.AuthenticateAsGameServerMessage
- net.out.AuthenticateSessionTicketMessage
- net.out.AvailableForQuickMatchMessage
- net.out.BrowseGuildsSearchByAbbreviationMessage
- net.out.BuildMessage
- net.out.CancelMatchmakingRequestMessage
- net.out.CancelTrainMessage
- net.out.CastInboxVoteMessage
- net.out.ChatRoomCommandMessage
- net.out.ChooseExtraGoldVariantMessage
- net.out.ChooseInitialExperienceLevelMessage
- net.out.ChooseMastermindVariantMessage
- net.out.ChooseMissionMessage
- net.out.ChoosePowerupMessage
- net.out.ClaimQuestMessage
- net.out.ClientConnectedToLoginMessage
- net.out.ClientLoginHandshakeMessage
- net.out.ClientTimeSyncedGameLoadMessage
- net.out.ClientToServerKeepAliveMessage
- net.out.CollectMasteryRewardMessage
- net.out.CollectPiggybankMessage
- net.out.ConsumeItemMessage
- net.out.ConvertItemToEssenceMessage
- net.out.DoneLoadingGameMessage
- net.out.EquipItemViaPassMessage
- net.out.FinishedLoadingScreenMessage
- net.out.ForceRefreshAnotherPlayerInbox
- net.out.ForwardedCreatePartyMessage
- net.out.ForwardedEnteredOrLeftMatchmakingV2Message
- net.out.ForwardedJoinPartyMessage
- net.out.ForwardedLeavePartyMessage
- net.out.GameServerWelcomeMessage
- net.out.GiftAFriendMessage
- net.out.GiftPEMessage
- net.out.GuildClientActionMessage
- net.out.HireMessage
- net.out.InQueueRequestMessage
- net.out.InitMessage
- net.out.KickFromPartyMessage
- net.out.LeavePartyMessage
- net.out.LendMoneyMessage
- net.out.LoadSavedTowerBuildMessage
- net.out.LobbyReadyMessage
- net.out.LogToServerMessage
- net.out.MatchFoundActionPropagationMessage
- net.out.OkLetsDualBuildMessage
- net.out.PartyMemberMatchFoundMessage
- net.out.PowerSendMessage
- net.out.QueueActionMessage
- net.out.ReadyForQuickMatchMessage
- net.out.RefreshAreaOfInterestMessage
- net.out.RefreshAutosendEnabledMessage
- net.out.RefreshBuildCursorMessage
- net.out.RejectInviteToPartyMessage
- net.out.RequestAcceptPartyInviteMessage
- net.out.RequestAutomaticItemUnlockMessage
- net.out.RequestAvatarMessage
- net.out.RequestBackendDataMessage
- net.out.RequestChatRoomSubscribersMessage
- net.out.RequestClassicInHouseGameServerMessage
- net.out.RequestCustomGameRoomMessage
- net.out.RequestCustomGameServerMessage
- net.out.RequestDiscordChatHistory
- net.out.RequestDisplayNameMessage
- net.out.RequestGameServerWelcomeMessage
- net.out.RequestGuildUpdateMessage
- net.out.RequestLinkedAccountsMessage
- net.out.RequestLiveGamesMessage
- net.out.RequestLoadingProgressesMessage
- net.out.RequestLobbyCallbackMessage
- net.out.RequestMapFileMessage
- net.out.RequestMatchmadeGameServerMessage
- net.out.RequestMatchmakingRadarUpdateMessage
- net.out.RequestMatchmakingTweakMessage
- net.out.RequestMatchmakingV2Message
- net.out.RequestOpeningsLeaderboardMessage
- net.out.RequestOpeningsMatchHistoryMessage
- net.out.RequestPlayVsAIGameServerMessage
- net.out.RequestRefreshGameCoachTipMessage
- net.out.RequestReportPlayerMessage
- net.out.RequestSteamIdMessage
- net.out.RequestSyncUnitMessage
- net.out.RequestTaglineMessage
- net.out.RequestTwitchMessage
- net.out.RerollQuestMessage
- net.out.ResearchMessage
- net.out.SelectMessage
- net.out.SelfMatchFoundActionMessage
- net.out.SendBotCommandMessage
- net.out.SendChatRoomChatMessage
- net.out.SendDiscordChatMessage
- net.out.SendEmoteMessage
- net.out.SendEnableDoubleDownMessage
- net.out.SendGameChatMessage
- net.out.SendInviteToCustomGameRoomMessage
- net.out.SendInviteToPartyMessage
- net.out.SendLaneSkinMessage
- net.out.SendMapPingMessage
- net.out.SendModeVotingVoteMessage
- net.out.SendRefreshLoadingProgressMessage
- net.out.SetAfkStatusMessage
- net.out.SetCustomGamePlayerSettingMessage
- net.out.SetCustomGameSettingMessage
- net.out.SetCustomGameSharedSettingMessage
- net.out.SkipTutorialMessage
- net.out.StartCustomClassicGameMessage
- net.out.StayAsTeamMessage
- net.out.SubmitSpecialCouponMessage
- net.out.TellPartyMyCampaignDlcOwnershipMessage
- net.out.TrainMessage
- net.out.TryCancelAutopauseMessage
- net.out.TryCloseSlotMessage
- net.out.TryJoinChatRoomMessage
- net.out.TryJoinCustomGameRoomMessage
- net.out.TryLeaveCustomGameRoomMessage
- net.out.TryMoveSlotMessage
- net.out.TryOpenSlotMessage
- net.out.TryPauseGameMessage
- net.out.TryQueueUpAsPartyMessage
- net.out.TryRefreshCustomGameRoomsMessage
- net.out.TryRerollCardTraderMessage
- net.out.TrySetBotSlotMessage
- net.out.UnequipItemViaPassMessage
- net.out.UpdateLastActivityMessage
- net.out.UpdateLoginQueuePositionMessage
- net.out.UpdateOwnedDLCMessage
- net.out.UpgradeBatchMessage
- net.out.ViewCameraBookmarkMessage
- net.out.VoluntarilyQuitMessage
- net.out.WantsToDualBuildMessage
Client message AbilityCommandMessage (subject 1), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of AbilityCommandMessage. |
orderString |
enum | yes | OrderStrings field of AbilityCommandMessage. One of: None, Attack, Move, AttackMove, AttackMoveApproachTarget, TowerAutoAttack, HoldPosition, Build, Sell, Cancel, CancelUpgrade, Harvest, Deliver, AcceptMythium, AcceptGold, SimpleAura, Bash, BounceAttack, EmpoweredAttack, SplashAttack, VioletWind, NaturesTouch, SummonChaosHound, ConjureDragon, RaiseImp, SkullStew, BloodRush, ManaShield, Overheat, Fatality, Necromancy, MagneticAccelerator, Anaphylaxis, Frenzy, CrushingBlow, StoneForm, Mindwarp, Shrapnel, Hotblood, RangedDamageReduction, SpellDamageReduction, AutoAttackDamageReduction, KillingSpree, Wither, GiantSlayer, Thorns, RampingDamage, Sacrifice, Hero, Ambush, Oracle, JuiceUp, Generator, IonicForce, CellRegrowth, Icewind, SearingArrows, GiantSlayerCurrentHealth, Delicacy, ExplodeOnAttackTargetDeath, Adapt, FishermanTraining, ManaTransferOnUpgrade, EliteFisherman, BigGameHunter, Intellect, Incubation, SplitOnDeath, BurstAttack, SearchForTreasure, SearchForTreasureEffect, LevelUp, Acrobatics, SearchForTreasureUndo, Dominion, ChainHeal, GaiaShield, Immolation, Stampede, LightningHammer, ExplodeOnDeath, AncientPower, SilentScream, Bipolar, SpiritOffering, ArmWithShuriken, ManaTransferOnBecomesFighter, ResetManaOnBecomesTower, ThrowShuriken, Evasion, BloodPrice, DimensionalRift, ActivateRageMode, ManaBlessing, Plunder, ManaBurn, DisableManaRegen, Aegis, FullThrottle, SplashAttackAroundMe, MetalForm, EarlyHarvest, Superbloom, SimpleBuff, MythiumOnAttack, Shadowbreeder, Tenacity, Exuberance, Devotion, ForbiddenFruit, EMP, CompoundInterest, ShortSelling, PotOHoney, SecretStash, Champion, UndoSpiritOffering, ExecutionerExecute, DivineBlessing, Executioner, GlacialTouch, Magician, Protector, Pulverizer, Sorcerer, Titan, Vampire, Villain, Wolverine, Artillery, AtomicAcceleration, RadiantShielding, TriumOfPower, Rage, Reposition, Evolve, UndoSpell, RotatingPotions, RotatingPotionHeal, RotatingPotionMana, RotatingPotionAtkSpd, Sniper, PortalOfTrash, Buzzinator. |
units |
list | no | Int16[] field of AbilityCommandMessage. |
target |
integer | yes | Int16 field of AbilityCommandMessage. |
point |
object | no | Point field of AbilityCommandMessage. |
abilityType |
string | yes | String field of AbilityCommandMessage. |
Client message AcceptInviteToGuildMessage (subject 78), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
guildId |
string | yes | String field of AcceptInviteToGuildMessage. |
inboxMessageId |
string | yes | String field of AcceptInviteToGuildMessage. |
senderDisplayName |
string | yes | String field of AcceptInviteToGuildMessage. |
Client message AcceptPartyInviteMessage (subject 39), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
inviterPlayFabId |
string | yes | String field of AcceptPartyInviteMessage. |
Client message AckServerTimeMessage (subject 15), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of AckServerTimeMessage. |
Client message AuthenticateAsGameServerMessage (subject 4), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
secretKey |
string | yes | String field of AuthenticateAsGameServerMessage. |
gameId |
string | yes | String field of AuthenticateAsGameServerMessage. |
Client message AuthenticateSessionTicketMessage (subject 3), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of AuthenticateSessionTicketMessage. |
sessionTicket |
string | yes | String field of AuthenticateSessionTicketMessage. |
partyMembers |
list | no | String[] field of AuthenticateSessionTicketMessage. |
partyJoinTime |
integer | yes | Int64 field of AuthenticateSessionTicketMessage. |
savedChatRoomType |
enum | yes | ChatRoomType field of AuthenticateSessionTicketMessage. One of: Standard, Guild, PostGame, CustomGameRoom, InGame, Party. |
savedChatRoomName |
string | yes | String field of AuthenticateSessionTicketMessage. |
previousGameId |
string | yes | String field of AuthenticateSessionTicketMessage. |
previousGameIdHash |
string | yes | String field of AuthenticateSessionTicketMessage. |
isSpectate |
bool | yes | Boolean field of AuthenticateSessionTicketMessage. |
Client message AvailableForQuickMatchMessage (subject 68), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
timeInQueue |
float | yes | Single field of AvailableForQuickMatchMessage. |
Client message BrowseGuildsSearchByAbbreviationMessage (subject 79), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
guildAbbreviation |
string | yes | String field of BrowseGuildsSearchByAbbreviationMessage. |
Client message BuildMessage (subject 0), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of BuildMessage. |
builder |
integer | yes | Int16 field of BuildMessage. |
unitType |
string | yes | String field of BuildMessage. |
point |
object | no | Point field of BuildMessage. |
facing |
object | no | AngleValue field of BuildMessage. |
Client message CancelMatchmakingRequestMessage (subject 25), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of CancelMatchmakingRequestMessage. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
cancellationReason |
enum | yes | MatchmakingCancellationReason field of CancelMatchmakingRequestMessage. One of: Voluntary, LeaveForQuickMatch, MatchmakingError, QuitApplication, FailedValidationOnLobby, FailedValidationOnClient, ClientInternalOrTimeoutError, ClientUnknownApiError, PartyMemberLeftOrDisconnected, PartyMemberJoined. |
debugReason |
string | yes | String field of CancelMatchmakingRequestMessage. |
Client message CancelTrainMessage (subject 4), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of CancelTrainMessage. |
unit |
integer | yes | Int16 field of CancelTrainMessage. |
Client message CastInboxVoteMessage (subject 102), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
id |
string | yes | String field of CastInboxVoteMessage. |
question |
string | yes | String field of CastInboxVoteMessage. |
selectedOptionId |
integer | yes | Int32 field of CastInboxVoteMessage. |
selectedOptionLabel |
string | yes | String field of CastInboxVoteMessage. |
senderDisplayName |
string | yes | String field of CastInboxVoteMessage. |
senderPlayFabId |
string | yes | String field of CastInboxVoteMessage. |
senderCountryCode |
string | yes | String field of CastInboxVoteMessage. |
senderLevel |
integer | yes | Int32 field of CastInboxVoteMessage. |
senderRankedElo |
integer | yes | Int32 field of CastInboxVoteMessage. |
senderRankedGames |
integer | yes | Int32 field of CastInboxVoteMessage. |
senderClassicElo |
integer | yes | Int32 field of CastInboxVoteMessage. |
senderClassicGames |
integer | yes | Int32 field of CastInboxVoteMessage. |
senderTotalValueUsd |
float | yes | Single field of CastInboxVoteMessage. |
senderBehaviorScorePercentage |
float | yes | Single field of CastInboxVoteMessage. |
Client message ChatRoomCommandMessage (subject 36), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
command |
string | yes | String field of ChatRoomCommandMessage. |
argument |
string | yes | String field of ChatRoomCommandMessage. |
Client message ChooseExtraGoldVariantMessage (subject 89), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
variantNumber |
integer | yes | Int32 field of ChooseExtraGoldVariantMessage. |
Client message ChooseInitialExperienceLevelMessage (subject 81), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
initialExperienceLevel |
string | yes | String field of ChooseInitialExperienceLevelMessage. |
Client message ChooseMastermindVariantMessage (subject 74), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
variant |
enum | yes | MastermindVariant field of ChooseMastermindVariantMessage. One of: None, LockIn, Greed, Redraw, Yolo, Chaos, Hybrid, Fiesta, CashOut, Castle, Cartel, Champion, Kingsguard, Scrapper, Megamind, Saboteur, Stash, Miner, Aristocrat, Moneylender, Shepherd, Evolution, Swarm, Ace. |
unitTypes |
list | no | String[] field of ChooseMastermindVariantMessage. |
Client message ChooseMissionMessage (subject 53), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
missionId |
string | yes | String field of ChooseMissionMessage. |
hardMode |
bool | yes | Boolean field of ChooseMissionMessage. |
starNumber |
integer | yes | Int32 field of ChooseMissionMessage. |
Client message ChoosePowerupMessage (subject 9), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
powerupType |
string | yes | String field of ChoosePowerupMessage. |
isSubpowerup |
bool | yes | Boolean field of ChoosePowerupMessage. |
Client message ClaimQuestMessage (subject 109), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
claimQuestIndex |
integer | yes | Int32 field of ClaimQuestMessage. |
Client message ClientConnectedToLoginMessage (subject 8), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
connectionId |
integer | yes | UInt16 field of ClientConnectedToLoginMessage. |
Client message ClientLoginHandshakeMessage (subject 9), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of ClientLoginHandshakeMessage. |
Client message ClientTimeSyncedGameLoadMessage (subject 114), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
currentTime |
integer | yes | Int64 field of ClientTimeSyncedGameLoadMessage. |
Client message ClientToServerKeepAliveMessage (subject 95), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of ClientToServerKeepAliveMessage. |
Client message CollectMasteryRewardMessage (subject 100), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
unitType |
string | yes | String field of CollectMasteryRewardMessage. |
Client message CollectPiggybankMessage (subject 120), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
expectedGold |
integer | yes | Int32 field of CollectPiggybankMessage. |
Client message ConsumeItemMessage (subject 52), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
itemInstanceId |
string | yes | String field of ConsumeItemMessage. |
Client message ConvertItemToEssenceMessage (subject 75), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
itemType |
string | yes | String field of ConvertItemToEssenceMessage. |
Client message DoneLoadingGameMessage (subject 14), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playerName |
string | yes | String field of DoneLoadingGameMessage. |
Client message EquipItemViaPassMessage (subject 122), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions; cosmetic (local servers only).
| Field | Type | Editable | Notes |
|---|---|---|---|
itemId |
string | yes | String field of EquipItemViaPassMessage. |
itemClass |
string | yes | String field of EquipItemViaPassMessage. |
currentSkin |
string | yes | String field of EquipItemViaPassMessage. |
Client message FinishedLoadingScreenMessage (subject 13), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
hash64 |
string | yes | String field of FinishedLoadingScreenMessage. |
Client message ForceRefreshAnotherPlayerInbox (subject 117), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
targetPlayFabId |
string | yes | String field of ForceRefreshAnotherPlayerInbox. |
Client message ForwardedCreatePartyMessage (subject 62), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
leaderPlayFabId |
string | yes | String field of ForwardedCreatePartyMessage. |
partyPlayFabIds |
list | no | List of String field of ForwardedCreatePartyMessage. |
Client message ForwardedEnteredOrLeftMatchmakingV2Message (subject 67), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of ForwardedEnteredOrLeftMatchmakingV2Message. |
entering |
bool | yes | Boolean field of ForwardedEnteredOrLeftMatchmakingV2Message. |
Client message ForwardedJoinPartyMessage (subject 60), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
inviteePlayFabId |
string | yes | String field of ForwardedJoinPartyMessage. |
autoJoin |
bool | yes | Boolean field of ForwardedJoinPartyMessage. |
Client message ForwardedLeavePartyMessage (subject 61), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
leaverPlayFabId |
string | yes | String field of ForwardedLeavePartyMessage. |
partyMembers |
list | no | List of String field of ForwardedLeavePartyMessage. |
flags |
enum | yes | PartyUpdateOptions field of ForwardedLeavePartyMessage. One of: None, DontSync, DontFormRemainderParty, DontFormSoloParty, VoluntaryLeave, AutoJoin. |
Client message GameServerWelcomeMessage (subject 1), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
connectionId |
integer | yes | UInt16 field of GameServerWelcomeMessage. |
matchInfo |
object | no | Match field of GameServerWelcomeMessage. |
LeftTeamEffectiveRating |
float | yes | Single field of GameServerWelcomeMessage. |
RightTeamEffectiveRating |
float | yes | Single field of GameServerWelcomeMessage. |
LeftTeamWinDelta |
float | yes | Single field of GameServerWelcomeMessage. |
RightTeamWinDelta |
float | yes | Single field of GameServerWelcomeMessage. |
GameStartTime |
integer | yes | Int64 field of GameServerWelcomeMessage. |
GameVersionString |
string | yes | String field of GameServerWelcomeMessage. |
hostname |
string | yes | String field of GameServerWelcomeMessage. |
tcpPort |
integer | yes | UInt32 field of GameServerWelcomeMessage. |
udpPort |
integer | yes | UInt32 field of GameServerWelcomeMessage. |
slotIds |
list | no | String[] field of GameServerWelcomeMessage. |
displayNames |
list | no | String[] field of GameServerWelcomeMessage. |
totalXps |
list | no | Int32[] field of GameServerWelcomeMessage. |
ratings |
list | no | Single[] field of GameServerWelcomeMessage. |
avatars |
list | no | String[] field of GameServerWelcomeMessage. Cosmetic. |
profileModifiers |
list | no | LoadingScreenProfileModifier[] field of GameServerWelcomeMessage. Cosmetic. |
isReconnect |
bool | yes | Boolean field of GameServerWelcomeMessage. |
isSpectate |
bool | yes | Boolean field of GameServerWelcomeMessage. |
hexGameId |
string | yes | String field of GameServerWelcomeMessage. |
debugInfo |
string | yes | String field of GameServerWelcomeMessage. |
buildId |
string | yes | String field of GameServerWelcomeMessage. |
serverId |
string | yes | String field of GameServerWelcomeMessage. |
startedTicks |
integer | yes | Int64 field of GameServerWelcomeMessage. |
missionId |
string | yes | String field of GameServerWelcomeMessage. |
missionHardMode |
bool | yes | Boolean field of GameServerWelcomeMessage. |
missionStarNumber |
integer | yes | Int32 field of GameServerWelcomeMessage. |
incomeBonuses |
list | no | Int32[] field of GameServerWelcomeMessage. |
earthKingUnitTypeOverride |
string | yes | String field of GameServerWelcomeMessage. |
skyKingUnitTypeOverride |
string | yes | String field of GameServerWelcomeMessage. |
Client message GiftAFriendMessage (subject 91), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
friendPlayFabId |
string | yes | String field of GiftAFriendMessage. |
friendDisplayName |
string | yes | String field of GiftAFriendMessage. |
Client message GiftPEMessage (subject 107), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
gifteePlayFabId |
string | yes | String field of GiftPEMessage. |
gifteeMessage |
string | yes | String field of GiftPEMessage. |
itemInstanceId |
string | yes | String field of GiftPEMessage. |
Client message GuildClientActionMessage (subject 80), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
guildClientAction |
enum | yes | GuildClientActionType field of GuildClientActionMessage. One of: CreateGuild. |
Client message HireMessage (subject 2), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of HireMessage. |
builder |
integer | yes | Int16 field of HireMessage. |
unitType |
string | yes | String field of HireMessage. |
sentFromQueue |
bool | yes | Boolean field of HireMessage. |
Client message InQueueRequestMessage (subject 116), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
requestedQueueType |
enum | yes | QueueType field of InQueueRequestMessage. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
partyMembers |
list | no | List of String field of InQueueRequestMessage. |
autoQueueIfClear |
bool | yes | Boolean field of InQueueRequestMessage. |
Client message InitMessage (subject 0), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
gameId |
string | yes | String field of InitMessage. |
connectionId |
integer | yes | UInt16 field of InitMessage. |
titleId |
string | yes | String field of InitMessage. |
Client message KickFromPartyMessage (subject 42), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
targetPlayFabId |
string | yes | String field of KickFromPartyMessage. |
Client message LeavePartyMessage (subject 41), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of LeavePartyMessage. |
Client message LendMoneyMessage (subject 126), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
expectedGold |
integer | yes | Int32 field of LendMoneyMessage. |
Client message LoadSavedTowerBuildMessage (subject 64), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
serializedBuild |
string | yes | String field of LoadSavedTowerBuildMessage. |
Client message LobbyReadyMessage (subject 5), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
connectionId |
integer | yes | UInt16 field of LobbyReadyMessage. |
ip |
string | yes | String field of LobbyReadyMessage. |
tcpPort |
integer | yes | Int32 field of LobbyReadyMessage. |
udpPort |
integer | yes | Int32 field of LobbyReadyMessage. |
serverId |
string | yes | String field of LobbyReadyMessage. |
Client message LogToServerMessage (subject 93), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
message |
string | yes | String field of LogToServerMessage. |
customTag |
string | yes | String field of LogToServerMessage. |
Client message MatchFoundActionPropagationMessage (subject 113), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
action |
enum | yes | MatchFoundAction field of MatchFoundActionPropagationMessage. One of: None, Accepted, Declined. |
Client message OkLetsDualBuildMessage (subject 97), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of OkLetsDualBuildMessage. |
crossPartner |
integer | yes | UInt16 field of OkLetsDualBuildMessage. |
Client message PartyMemberMatchFoundMessage (subject 71), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of PartyMemberMatchFoundMessage. |
matchId |
string | yes | String field of PartyMemberMatchFoundMessage. |
queueName |
string | yes | String field of PartyMemberMatchFoundMessage. |
Client message PowerSendMessage (subject 115), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of PowerSendMessage. |
Client message QueueActionMessage (subject 99), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
sourceUnit |
integer | yes | Int16 field of QueueActionMessage. |
queueActionType |
enum | yes | QueueActionType field of QueueActionMessage. One of: QueueMercenary, QueueWorker, QueueKingUpgrade. |
id |
string | yes | String field of QueueActionMessage. |
isCancel |
bool | yes | Boolean field of QueueActionMessage. |
forceSendMercenariesImmediately |
bool | yes | Boolean field of QueueActionMessage. |
Client message ReadyForQuickMatchMessage (subject 69), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of ReadyForQuickMatchMessage. |
partyOwnerPlayFabId |
string | yes | String field of ReadyForQuickMatchMessage. |
difficulty |
enum | yes | BotDifficulty field of ReadyForQuickMatchMessage. One of: SuperEasy, Easy, Medium, Hard. |
Client message RefreshAreaOfInterestMessage (subject 7), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
area |
object | no | Rectangle field of RefreshAreaOfInterestMessage. |
cameraHeight |
float | yes | Single field of RefreshAreaOfInterestMessage. |
Client message RefreshAutosendEnabledMessage (subject 86), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
enabled |
bool | yes | Boolean field of RefreshAutosendEnabledMessage. |
decision |
enum | yes | SendDecision field of RefreshAutosendEnabledMessage. One of: None, Save, Income, Power. |
Client message RefreshBuildCursorMessage (subject 101), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
shortUnitType |
integer | yes | UInt16 field of RefreshBuildCursorMessage. |
point |
object | no | Point field of RefreshBuildCursorMessage. |
tick |
integer | yes | Int32 field of RefreshBuildCursorMessage. |
messageNumber |
integer | yes | Int32 field of RefreshBuildCursorMessage. |
Client message RejectInviteToPartyMessage (subject 40), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
displayName |
string | yes | String field of RejectInviteToPartyMessage. |
Client message RequestAcceptPartyInviteMessage (subject 70), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
targetPlayFabId |
string | yes | String field of RequestAcceptPartyInviteMessage. |
Client message RequestAutomaticItemUnlockMessage (subject 94), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
sourceItemType |
string | yes | String field of RequestAutomaticItemUnlockMessage. |
Client message RequestAvatarMessage (subject 46), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions; cosmetic (local servers only).
| Field | Type | Editable | Notes |
|---|---|---|---|
avatarImage |
string | yes | String field of RequestAvatarMessage. |
friendsToUpdate |
list | no | List of String field of RequestAvatarMessage. |
Client message RequestBackendDataMessage (subject 57), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
callbackNumber |
integer | yes | Int32 field of RequestBackendDataMessage. |
keys |
list | no | List of String field of RequestBackendDataMessage. |
requestType |
enum | yes | BackendRequestType field of RequestBackendDataMessage. One of: FullPlayerProfile, MiniPlayerProfile. |
Client message RequestChatRoomSubscribersMessage (subject 59), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
channelName |
string | yes | String field of RequestChatRoomSubscribersMessage. |
playFabIds |
list | no | List of String field of RequestChatRoomSubscribersMessage. |
includeGrayNames |
bool | yes | Boolean field of RequestChatRoomSubscribersMessage. |
Client message RequestClassicInHouseGameServerMessage (subject 84), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
partyMemberPlayFabIds |
list | no | List of String field of RequestClassicInHouseGameServerMessage. |
queueType |
enum | yes | QueueType field of RequestClassicInHouseGameServerMessage. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
Client message RequestCustomGameRoomMessage (subject 22), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of RequestCustomGameRoomMessage. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
Client message RequestCustomGameServerMessage (subject 23), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of RequestCustomGameServerMessage. |
Client message RequestDiscordChatHistory (subject 73), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of RequestDiscordChatHistory. |
Client message RequestDisplayNameMessage (subject 21), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
displayName |
string | yes | String field of RequestDisplayNameMessage. |
isConfirmed |
bool | yes | Boolean field of RequestDisplayNameMessage. |
Client message RequestGameServerWelcomeMessage (subject 7), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of RequestGameServerWelcomeMessage. |
Client message RequestGuildUpdateMessage (subject 77), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
updateType |
enum | yes | GuildUpdateType field of RequestGuildUpdateMessage. One of: SetAbbreviation, SetName, SetTagline, SetNotice, LeaveGuild, DisbandGuild, KickMember, InviteMember, RevokeInvitation, RejectInvitation, AcceptApplication, RejectApplication, SubmitApplication, ChangeRole, SetTitle, DonateCard, SetAvatar, SetEmblem, SetDiscord. |
value |
string | yes | String field of RequestGuildUpdateMessage. |
arg1 |
string | yes | String field of RequestGuildUpdateMessage. |
senderDisplayName |
string | yes | String field of RequestGuildUpdateMessage. |
targetDisplayName |
string | yes | String field of RequestGuildUpdateMessage. |
debugSenderPlayFabId |
string | yes | String field of RequestGuildUpdateMessage. |
silent |
bool | yes | Boolean field of RequestGuildUpdateMessage. |
cards |
list | no | List of String field of RequestGuildUpdateMessage. |
Client message RequestLinkedAccountsMessage (subject 108), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of RequestLinkedAccountsMessage. |
addAsFriend |
bool | yes | Boolean field of RequestLinkedAccountsMessage. |
sendInboxMessage |
bool | yes | Boolean field of RequestLinkedAccountsMessage. |
Client message RequestLiveGamesMessage (subject 127), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions.
Client message RequestLoadingProgressesMessage (subject 55), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of RequestLoadingProgressesMessage. |
Client message RequestLobbyCallbackMessage (subject 44), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
callbackId |
string | yes | String field of RequestLobbyCallbackMessage. |
functionType |
enum | yes | LobbyFunctionTypes field of RequestLobbyCallbackMessage. One of: RequestPlayerProfile. |
dataJSON |
string | yes | String field of RequestLobbyCallbackMessage. |
Client message RequestMapFileMessage (subject 12), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
mapName |
string | yes | String field of RequestMapFileMessage. |
Client message RequestMatchmadeGameServerMessage (subject 24), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of RequestMatchmadeGameServerMessage. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
Client message RequestMatchmakingRadarUpdateMessage (subject 119), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
radar |
object | no | MatchmakingRadarProperties field of RequestMatchmakingRadarUpdateMessage. |
Client message RequestMatchmakingTweakMessage (subject 26), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
hurryUp |
bool | yes | Boolean field of RequestMatchmakingTweakMessage. |
Client message RequestMatchmakingV2Message (subject 66), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of RequestMatchmakingV2Message. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
partyMembers |
list | no | List of String field of RequestMatchmakingV2Message. |
Client message RequestOpeningsLeaderboardMessage (subject 87), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of RequestOpeningsLeaderboardMessage. |
Client message RequestOpeningsMatchHistoryMessage (subject 88), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
unitType |
string | yes | String field of RequestOpeningsMatchHistoryMessage. |
Client message RequestPlayVsAIGameServerMessage (subject 65), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
partyMemberPlayFabIds |
list | no | List of String field of RequestPlayVsAIGameServerMessage. |
queueType |
enum | yes | QueueType field of RequestPlayVsAIGameServerMessage. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
Client message RequestRefreshGameCoachTipMessage (subject 83), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of RequestRefreshGameCoachTipMessage. |
Client message RequestReportPlayerMessage (subject 49), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
targetPlayFabId |
string | yes | String field of RequestReportPlayerMessage. |
comment |
string | yes | String field of RequestReportPlayerMessage. |
category |
enum | yes | ReportPlayerCategory field of RequestReportPlayerMessage. One of: Griefing, VerbalAbuse, OffensiveName, Leaving, Other. |
toxicityInfo |
object | no | FairPlayToxicityInfo field of RequestReportPlayerMessage. |
Client message RequestSteamIdMessage (subject 50), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of RequestSteamIdMessage. |
displayName |
string | yes | String field of RequestSteamIdMessage. |
pchDialog |
string | yes | String field of RequestSteamIdMessage. |
Client message RequestSyncUnitMessage (subject 10), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
unit |
integer | yes | Int16 field of RequestSyncUnitMessage. |
Client message RequestTaglineMessage (subject 45), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tagline |
string | yes | String field of RequestTaglineMessage. |
friendsToUpdate |
list | no | List of String field of RequestTaglineMessage. |
Client message RequestTwitchMessage (subject 47), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of RequestTwitchMessage. |
Client message RerollQuestMessage (subject 110), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions.
Client message ResearchMessage (subject 6), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of ResearchMessage. |
researchType |
string | yes | String field of ResearchMessage. |
level |
integer | yes | Int32 field of ResearchMessage. |
Client message SelectMessage (subject 5), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
unit |
integer | yes | Int16 field of SelectMessage. |
tick |
integer | yes | Int64 field of SelectMessage. |
Client message SelfMatchFoundActionMessage (subject 112), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
action |
enum | yes | MatchFoundAction field of SelfMatchFoundActionMessage. One of: None, Accepted, Declined. |
Client message SendBotCommandMessage (subject 54), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
commandType |
enum | yes | BotCommandType field of SendBotCommandMessage. One of: HireMercenary, TrainWorker, DeployFighter. |
args |
list | no | String[] field of SendBotCommandMessage. |
Client message SendChatRoomChatMessage (subject 20), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
message |
string | yes | String field of SendChatRoomChatMessage. |
Client message SendDiscordChatMessage (subject 104), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
message |
string | yes | String field of SendDiscordChatMessage. |
senderName |
string | yes | String field of SendDiscordChatMessage. |
avatar |
string | yes | String field of SendDiscordChatMessage. Cosmetic. |
discordMessageType |
enum | yes | DiscordMessageType field of SendDiscordChatMessage. One of: Rooms, LobbyRestarts, ServerBugs, Tournament, LiskDebug, GuildMonitoring, ShopMonitoring, VipRoom, TheLounge, ClientBugs, GlobalChatTest, MatchmakingDebug, GeneralChat, PressMonitoring, FraudMonitoring, BotCommands, Engineering, NameReports. |
Client message SendEmoteMessage (subject 106), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
emoteIndex |
integer | yes | Int32 field of SendEmoteMessage. Cosmetic. |
animationType |
string | yes | String field of SendEmoteMessage. Cosmetic. |
point |
object | no | Point field of SendEmoteMessage. |
Client message SendEnableDoubleDownMessage (subject 124), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
enableDoubleDown |
bool | yes | Boolean field of SendEnableDoubleDownMessage. |
Client message SendGameChatMessage (subject 11), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
allChat |
bool | yes | Boolean field of SendGameChatMessage. |
messageType |
enum | yes | ChatMessageType field of SendGameChatMessage. One of: Standard, Affirmative, Unsure, Alert, StandardLong, Party, Whisper, System, Discord, Guild, GuildNotice, ExpectingSend, ThinkingAboutSending. |
message |
string | yes | String field of SendGameChatMessage. |
Client message SendInviteToCustomGameRoomMessage (subject 27), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
displayName |
string | yes | String field of SendInviteToCustomGameRoomMessage. |
playFabId |
string | yes | String field of SendInviteToCustomGameRoomMessage. |
Client message SendInviteToPartyMessage (subject 38), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of SendInviteToPartyMessage. |
displayName |
string | yes | String field of SendInviteToPartyMessage. |
Client message SendLaneSkinMessage (subject 125), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions; cosmetic (local servers only).
| Field | Type | Editable | Notes |
|---|---|---|---|
modId |
string | yes | String field of SendLaneSkinMessage. |
Client message SendMapPingMessage (subject 16), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
pingType |
enum | yes | PingType field of SendMapPingMessage. One of: None, Regular, OnMyWay, Target, Warning, Question, Help, RegularGround, Checkmark, ReachedKing, LeakedThem. |
point |
object | no | Point field of SendMapPingMessage. |
Client message SendModeVotingVoteMessage (subject 103), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
ready |
bool | yes | Boolean field of SendModeVotingVoteMessage. |
vote1 |
integer | yes | Int32 field of SendModeVotingVoteMessage. |
vote2 |
integer | yes | Int32 field of SendModeVotingVoteMessage. |
Client message SendRefreshLoadingProgressMessage (subject 51), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
progress |
float | yes | Single field of SendRefreshLoadingProgressMessage. |
Client message SetAfkStatusMessage (subject 18), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
afk |
bool | yes | Boolean field of SetAfkStatusMessage. |
longAfk |
bool | yes | Boolean field of SetAfkStatusMessage. |
Client message SetCustomGamePlayerSettingMessage (subject 56), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
key |
string | yes | String field of SetCustomGamePlayerSettingMessage. |
player |
integer | yes | UInt16 field of SetCustomGamePlayerSettingMessage. |
value |
string | yes | String field of SetCustomGamePlayerSettingMessage. |
Client message SetCustomGameSettingMessage (subject 37), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
key |
string | yes | String field of SetCustomGameSettingMessage. |
value |
string | yes | String field of SetCustomGameSettingMessage. |
Client message SetCustomGameSharedSettingMessage (subject 58), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
key |
string | yes | String field of SetCustomGameSharedSettingMessage. |
value |
bool | yes | Boolean field of SetCustomGameSharedSettingMessage. |
Client message SkipTutorialMessage (subject 85), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of SkipTutorialMessage. |
Client message StartCustomClassicGameMessage (subject 90), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of StartCustomClassicGameMessage. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
tick |
integer | yes | Int64 field of StartCustomClassicGameMessage. |
Client message StayAsTeamMessage (subject 43), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
gameId |
string | yes | String field of StayAsTeamMessage. |
isWestTeam |
bool | yes | Boolean field of StayAsTeamMessage. |
Client message SubmitSpecialCouponMessage (subject 118), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
couponCode |
string | yes | String field of SubmitSpecialCouponMessage. |
Client message TellPartyMyCampaignDlcOwnershipMessage (subject 98), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
campaignDlcsOwned |
list | no | List of String field of TellPartyMyCampaignDlcOwnershipMessage. |
Client message TrainMessage (subject 3), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of TrainMessage. |
builder |
integer | yes | Int16 field of TrainMessage. |
unitType |
string | yes | String field of TrainMessage. |
Client message TryCancelAutopauseMessage (subject 92), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of TryCancelAutopauseMessage. |
Client message TryCloseSlotMessage (subject 30), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
slot |
integer | yes | UInt16 field of TryCloseSlotMessage. |
Client message TryJoinChatRoomMessage (subject 35), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
chatRoomType |
enum | yes | ChatRoomType field of TryJoinChatRoomMessage. One of: Standard, Guild, PostGame, CustomGameRoom, InGame, Party. |
chatRoomName |
string | yes | String field of TryJoinChatRoomMessage. |
Client message TryJoinCustomGameRoomMessage (subject 28), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
ownerPlayFabId |
string | yes | String field of TryJoinCustomGameRoomMessage. |
Client message TryLeaveCustomGameRoomMessage (subject 33), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of TryLeaveCustomGameRoomMessage. |
Client message TryMoveSlotMessage (subject 32), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
toSlot |
integer | yes | UInt16 field of TryMoveSlotMessage. |
Client message TryOpenSlotMessage (subject 29), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
slot |
integer | yes | UInt16 field of TryOpenSlotMessage. |
Client message TryPauseGameMessage (subject 82), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
attemptNumber |
integer | yes | Int32 field of TryPauseGameMessage. |
Client message TryQueueUpAsPartyMessage (subject 63), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
ticketId |
string | yes | String field of TryQueueUpAsPartyMessage. |
party |
object | no | Party field of TryQueueUpAsPartyMessage. |
queueType |
enum | yes | QueueType field of TryQueueUpAsPartyMessage. One of: Normal, Casual, Practice, Custom, Sandbox, CasualNoob, Classic, ClassicNoob, ClassicSortaNoob, Arcade, BeginnerBots, VeryEasyBots, EasyBots, MediumBots, HardBots, InsaneBots, ExpertBots, MasterBots, SeniorMasterBots, GrandmasterBots, QuickMatch, Challenge, None, Pve. |
Client message TryRefreshCustomGameRoomsMessage (subject 34), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of TryRefreshCustomGameRoomsMessage. |
Client message TryRerollCardTraderMessage (subject 105), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
myRerollsRemaining |
integer | yes | Int32 field of TryRerollCardTraderMessage. |
Client message TrySetBotSlotMessage (subject 31), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
slot |
integer | yes | UInt16 field of TrySetBotSlotMessage. |
Client message UnequipItemViaPassMessage (subject 123), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions; cosmetic (local servers only).
| Field | Type | Editable | Notes |
|---|---|---|---|
itemId |
string | yes | String field of UnequipItemViaPassMessage. |
itemClass |
string | yes | String field of UnequipItemViaPassMessage. |
Client message UpdateLastActivityMessage (subject 72), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
reason |
string | yes | String field of UpdateLastActivityMessage. |
time |
float | yes | Double field of UpdateLastActivityMessage. |
Client message UpdateLoginQueuePositionMessage (subject 6), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
position |
integer | yes | Int32 field of UpdateLoginQueuePositionMessage. |
Client message UpdateOwnedDLCMessage (subject 48), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
dlcString |
string | yes | String field of UpdateOwnedDLCMessage. |
isFreeAccount |
bool | yes | Boolean field of UpdateOwnedDLCMessage. |
Client message UpgradeBatchMessage (subject 8), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpgradeBatchMessage. |
unitType |
string | yes | String field of UpgradeBatchMessage. |
units |
list | no | Int16[] field of UpgradeBatchMessage. |
Client message ViewCameraBookmarkMessage (subject 17), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of ViewCameraBookmarkMessage. |
Client message VoluntarilyQuitMessage (subject 19), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of VoluntarilyQuitMessage. |
Client message WantsToDualBuildMessage (subject 96), before it is sent. Cancel to drop it.
Before and after the game acts (pre=True for before); cancelling needs actions; edits need actions.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of WantsToDualBuildMessage. |
crossPartner |
integer | yes | UInt16 field of WantsToDualBuildMessage. |
Using ProLeak
Features
Tutorial
- Your first plugin
- Plugin basics
- Handling events
- Plugin settings
- User interface
- Players, units and game data
- Purchases, signals and pings
- Chat, camera, input and more
- Cosmetics
- Game modes
- Game updates
- Publishing plugins
Reference