Repository navigation
Events Incoming network messages
One event per message the server sends; names follow the game's message classes.
Generated from catalog/events.json by tools/gen_events_doc.py.
Contents (244 sections)
- net.in.AbilityMissileBatchMessage
- net.in.AckAckServerTimeMessage
- net.in.AddMatchModifierMessage
- net.in.AttachSpecialEffectToUnitMessage
- net.in.AuthenticateAsGameServerMessage
- net.in.AuthenticateSessionTicketMessage
- net.in.AuthenticatedMessage
- net.in.AuthenticatedWithLobbyMessage
- net.in.AutoAttackMissileBatchMessage
- net.in.BeatMissionMessage
- net.in.BootedFromCustomGameRoomMessage
- net.in.BrowseGuildsSearchByAbbreviationResultMessage
- net.in.CardTraderRerollResultMessage
- net.in.CastInboxVoteResultMessage
- net.in.ChangeChannelMessage
- net.in.ChatRoomChatMessage
- net.in.ClaimQuestResultMessage
- net.in.ClientConnectedToLoginMessage
- net.in.ClientLoginHandshakeMessage
- net.in.CollectMasteryRewardResultMessage
- net.in.ConfirmGiftAFriendMessage
- net.in.ConfirmInitialExperienceLevelMessage
- net.in.ConfirmMoneyLendMessage
- net.in.ConfirmSkipTutorialMessage
- net.in.ConfirmUnitHiredMessage
- net.in.ConfirmUnitTrainedMessage
- net.in.ConsoleLogMessage
- net.in.ConsumeItemResultMessage
- net.in.ConvertItemToEssenceResultMessage
- net.in.CreateFloatingTextMessage
- net.in.CreateTutorialArrowTextMessage
- net.in.CustomEventMessage
- net.in.CustomGameRoomDisbandedMessage
- net.in.CustomGameRoomListingResultMessage
- net.in.CustomLogMessage
- net.in.DiscordChatMessage
- net.in.DisplayGameTextMessage
- net.in.DisplayPickedModeMessage
- net.in.DisplayPlayerClearedTextMessage
- net.in.DisplayPlayerLeakedTextMessage
- net.in.EarnIngameAchievementMessage
- net.in.ErrorStartingGame
- net.in.ForceHideUnitMessage
- net.in.ForceMaintenancePopupMessage
- net.in.ForcePickLegionMessage
- net.in.ForceRefreshCurrencyMessage
- net.in.ForceRefreshInboxMessage
- net.in.ForceSelectUnitMessage
- net.in.ForceSetPlayerIdMessage
- net.in.ForceSyncPlayerMessage
- net.in.ForceSyncUnitBatchMessage
- net.in.ForwardedOkLetsDualBuildMessage
- net.in.ForwardedPartyMemberMatchFoundActionMessage
- net.in.ForwardedPartyMemberMatchFoundMessage
- net.in.ForwardedTellPartyCampaignDlcOwnershipMessage
- net.in.ForwardedTryJoinCustomGameRoomMessage
- net.in.ForwardedWantsToDualBuildMessage
- net.in.GameAlreadyStartedMessage
- net.in.GameNoLongerExistsMessage
- net.in.GameServerReadyMessage
- net.in.GameServerWelcomeMessage
- net.in.GameStartedMessage
- net.in.GenericGameServerRequestedMessage
- net.in.HighRankCalloutMessage
- net.in.InQueueResultMessage
- net.in.InitMessage
- net.in.InvitedToCustomGameRoomMessage
- net.in.InvitedToGuildMessage
- net.in.InvitedToPartyMessage
- net.in.JoinCustomGameRoomMessage
- net.in.JoinSoloPartyMessage
- net.in.KickedFromGuildMessage
- net.in.KickedFromPartyMessage
- net.in.LeaveQueueToFormQuickMatchMessage
- net.in.LiveGamesResultMessage
- net.in.LoadClientNotificationMessage
- net.in.LoadOkPopupMessage
- net.in.LoadPopupMessage
- net.in.LoadUnclickablePopupMessage
- net.in.LoadViewMessage
- net.in.LobbyCallbackMessage
- net.in.LobbyReadyMessage
- net.in.LoudAnnouncementMessage
- net.in.MakeSquaresBuildableMessage
- net.in.MapMessage
- net.in.MapPingMessage
- net.in.MaphackEnabledMessage
- net.in.MatchFoundCanceledMessage
- net.in.MatchFoundMessage
- net.in.MatchmadeGameServerRequestedMessage
- net.in.MatchmakingForbiddenMessage
- net.in.MatchmakingPlayerAllReadyMessage
- net.in.MatchmakingPlayerReadyFailedMessage
- net.in.MatchmakingPlayerReadyMessage
- net.in.MatchmakingRequestCanceledMessage
- net.in.MatchmakingV1RequestFailedMessage
- net.in.NetworkErrorMessage
- net.in.PartyIsAvailableForQuickMatchMessage
- net.in.PartyMembersChangedMessage
- net.in.PartyRecoveryFailedMessage
- net.in.PlayGlobalSoundMessage
- net.in.PlayGlobalWhatSoundMessage
- net.in.PlaySoundAtPointMessage
- net.in.PlaySoundFromUnitMessage
- net.in.PlaySpecialThemeMessage
- net.in.PostGameStatsMessage
- net.in.PromptLockInMessage
- net.in.ReadyForMatchmakingV2Message
- net.in.ReceiveEmoteMessage
- net.in.ReceiveMysteriousCardMessage
- net.in.ReceiveMysteriousMultiCardsMessage
- net.in.RefreshAutoSendMercsMessage
- net.in.RefreshAutosendStatusMessage
- net.in.RefreshBuilderInfoMessage
- net.in.RefreshChatRoomHistoryMessage
- net.in.RefreshChatRoomSubscribersMessage
- net.in.RefreshClassicModeEnabledMessage
- net.in.RefreshCustomGameRoomsMessage
- net.in.RefreshCustomGameSettingsMessage
- net.in.RefreshDataReportsMessage
- net.in.RefreshDeltaMultiplierMessage
- net.in.RefreshDeployStacksMessage
- net.in.RefreshExtraGoldCountersMessage
- net.in.RefreshGoldBountyRemainingMessage
- net.in.RefreshInGameCoachMessage
- net.in.RefreshLeakRatioMessage
- net.in.RefreshLoadingProgressMessage
- net.in.RefreshLoadingStickerExtrasMessage
- net.in.RefreshLoadingStickerSuffixMessage
- net.in.RefreshMegamindEnabledMessage
- net.in.RefreshMercenariesReceivedMessage
- net.in.RefreshMonumentsMessage
- net.in.RefreshObjectivesMessage
- net.in.RefreshPartyMembersMessage
- net.in.RefreshPiggybankGoldMessage
- net.in.RefreshPlaybackRateMessage
- net.in.RefreshPlayerDamageTrackerMessage
- net.in.RefreshPlayerOpeningsMessage
- net.in.RefreshPlayerRerollsMessage
- net.in.RefreshPlayerStackrankMessage
- net.in.RefreshSpectatorWinProbabilitiesMessage
- net.in.RefreshSuddenDeathCountMessage
- net.in.RequestAvatarResultMessage
- net.in.RequestBackendDataResultMessage
- net.in.RequestCustomGameListingMessage
- net.in.RequestGameServerWelcomeMessage
- net.in.RequestGuildUpdateResultMessage
- net.in.RequestLinkedAccountsResultMessage
- net.in.RequestOpeningsLeaderboardResultMessage
- net.in.RequestOpeningsMatchHistoryResultMessage
- net.in.RequestReportPlayerResultMessage
- net.in.RequestSteamIdResultMessage
- net.in.RequestTaglineResultMessage
- net.in.RequestTryJoinCustomGameRoomMessage
- net.in.RequestTwitchResultMessage
- net.in.RerollQuestResultMessage
- net.in.SavedTowerBuildMessage
- net.in.SendServerTimeMessage
- net.in.ServerToClientKeepAliveMessage
- net.in.SetBarracksEnabledMessage
- net.in.SetCameraPositionMessage
- net.in.SetChatRoomPropertiesMessage
- net.in.SetDisplayNameResultMessage
- net.in.SetEastEnemiesRemainingTextMessage
- net.in.SetHudEnabledMessage
- net.in.SetHudInfoMessage
- net.in.SetHudSourceMessage
- net.in.SetMatchModifiersMessage
- net.in.SetMinimapImageMessage
- net.in.SetObjectFailedMessage
- net.in.SetPickedMastermind
- net.in.SetRegionHiddenMessage
- net.in.SetRegionVisibleMessage
- net.in.SetResearchLevelsMessage
- net.in.SetSpectatorHudMessage
- net.in.SetWaveNumberMessage
- net.in.SetWaveTimeMessage
- net.in.SetWaveTimerPausedMessage
- net.in.SetWestEnemiesRemainingTextMessage
- net.in.ShowChallengeVictoryWindowMessage
- net.in.ShowExtraGoldVariantMenuMessage
- net.in.ShowLockInRaffleMessage
- net.in.ShowMastermindVariantWindowMessage
- net.in.ShowModeVotingMenuMessage
- net.in.ShowPowerupsWindowMessage
- net.in.ShowRerollWindowMessage
- net.in.ShowStrategistRaffleMessage
- net.in.ShowVersusOverlayMessage
- net.in.SpecialCouponResultMessage
- net.in.SpecialEffectBatchMessage
- net.in.SyncGuildEmblemMessage
- net.in.SyncMoneyLendMessage
- net.in.SyncPlayerControllerMessage
- net.in.SyncQueueStateMessage
- net.in.SyncTimeHeartbeatMessage
- net.in.SyncUnitGarrisonMessage
- net.in.TitleDataChangedMessage
- net.in.TryJoinGuildResultMessage
- net.in.UnitKeyframesBatchMessage
- net.in.UnitKilledEventMessage
- net.in.UnitSpecialEffectBatchMessage
- net.in.UpdateAutopauseTimerMessage
- net.in.UpdateBuildCursorMessage
- net.in.UpdateChatTimelineMessage
- net.in.UpdateCustomGameRoomSlotMessage
- net.in.UpdateKingStacksMessage
- net.in.UpdateLoginQueuePositionMessage
- net.in.UpdateModeVotingPlayersMessage
- net.in.UpdatePlayerAfkStatusTimelineMessage
- net.in.UpdatePlayerAttackerPlayerTimelineMessage
- net.in.UpdatePlayerConnectedTimelineMessage
- net.in.UpdatePlayerControllerTimelineMessage
- net.in.UpdatePlayerDefenderPlayerTimelineMessage
- net.in.UpdatePlayerDualBuildingMessage
- net.in.UpdatePlayerExtraRecommendedValueMessage
- net.in.UpdatePlayerFoodCapTimelineMessage
- net.in.UpdatePlayerFoodUsedTimelineMessage
- net.in.UpdatePlayerGoldTimelineMessage
- net.in.UpdatePlayerImageTimelineMessage
- net.in.UpdatePlayerIncomeTimelineMessage
- net.in.UpdatePlayerLaneSkinMessage
- net.in.UpdatePlayerLeakedPercentOnWaveMessage
- net.in.UpdatePlayerLegionUnitTypeMessage
- net.in.UpdatePlayerMythiumGatherRateMessage
- net.in.UpdatePlayerMythiumTimelineMessage
- net.in.UpdatePlayerNameTimelineMessage
- net.in.UpdatePlayerPartyMembersTimelineMessage
- net.in.UpdatePlayerPowerupChoicesTimelineMessage
- net.in.UpdatePlayerPowerupSelectedTimelineMessage
- net.in.UpdatePlayerRollsTimelineMessage
- net.in.UpdatePlayerTotalEnemyTeamGoldFromYourLeaksMessage
- net.in.UpdatePlayerTotalGoldFromCatchingLeaksMessage
- net.in.UpdatePlayerTotalGoldFromEnemyLeaksMessage
- net.in.UpdatePlayerTotalGoldFromIncomeMessage
- net.in.UpdatePlayerTotalGoldLostToLeaksMessage
- net.in.UpdatePlayerTotalMythiumTimelineMessage
- net.in.UpdatePlayerValueTimelineMessage
- net.in.UpdatePlayerWorkersTimelineMessage
- net.in.UpdateReadyPlayersMessage
- net.in.UpdateResearchLevelMessage
- net.in.UpdateSquareOccupyTimelineMessage
- net.in.UpdateTowerScoreboardMessage
- net.in.UpdatedPlayerMutedTimelineMessage
- net.in.UsedQueuedKingUpgradeMessage
Server message AbilityMissileBatchMessage (subject 2), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
keyframes |
object | no | BlockingQueue of AbilityMissileMessage field of AbilityMissileBatchMessage. |
keyframesList |
list | no | IList of AbilityMissileMessage field of AbilityMissileBatchMessage. |
Server message AckAckServerTimeMessage (subject 77), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
currentTime |
integer | yes | Int64 field of AckAckServerTimeMessage. |
rtt |
integer | yes | Int64 field of AckAckServerTimeMessage. |
isReconnect |
bool | yes | Boolean field of AckAckServerTimeMessage. |
Server message AddMatchModifierMessage (subject 118), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
matchModifier |
object | no | MatchModifier field of AddMatchModifierMessage. |
Server message AttachSpecialEffectToUnitMessage (subject 73), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
unit |
integer | yes | Int16 field of AttachSpecialEffectToUnitMessage. |
effectType |
string | yes | String field of AttachSpecialEffectToUnitMessage. |
Server message AuthenticateAsGameServerMessage (subject 4), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
secretKey |
string | yes | String field of AuthenticateAsGameServerMessage. |
gameId |
string | yes | String field of AuthenticateAsGameServerMessage. |
Server message AuthenticateSessionTicketMessage (subject 3), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| 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. |
Server message AuthenticatedMessage (subject 80), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
authenticated |
bool | yes | Boolean field of AuthenticatedMessage. |
Server message AuthenticatedWithLobbyMessage (subject 81), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
authenticated |
bool | yes | Boolean field of AuthenticatedWithLobbyMessage. |
resetUsername |
bool | yes | Boolean field of AuthenticatedWithLobbyMessage. |
geoCountryCode |
string | yes | String field of AuthenticatedWithLobbyMessage. |
totalValueToDateInUsdCents |
integer | yes | Int64 field of AuthenticatedWithLobbyMessage. |
Server message AutoAttackMissileBatchMessage (subject 1), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
keyframes |
object | no | BlockingQueue of AutoAttackMissileMessage field of AutoAttackMissileBatchMessage. |
keyframesList |
list | no | IList of AutoAttackMissileMessage field of AutoAttackMissileBatchMessage. |
Server message BeatMissionMessage (subject 121), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
missionId |
string | yes | String field of BeatMissionMessage. |
starsEarned |
list | no | List of Int32 field of BeatMissionMessage. |
Server message BootedFromCustomGameRoomMessage (subject 84), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of BootedFromCustomGameRoomMessage. |
Server message BrowseGuildsSearchByAbbreviationResultMessage (subject 178), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
guildAbbreviation |
string | yes | String field of BrowseGuildsSearchByAbbreviationResultMessage. |
guildId |
string | yes | String field of BrowseGuildsSearchByAbbreviationResultMessage. |
Server message CardTraderRerollResultMessage (subject 214), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
remainingRerolls |
integer | yes | Int32 field of CardTraderRerollResultMessage. |
itemIds |
list | no | List of String field of CardTraderRerollResultMessage. |
somethingWentWrong |
bool | yes | Boolean field of CardTraderRerollResultMessage. |
Server message CastInboxVoteResultMessage (subject 209), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
id |
string | yes | String field of CastInboxVoteResultMessage. |
Server message ChangeChannelMessage (subject 151), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
serverHostname |
string | yes | String field of ChangeChannelMessage. |
tcpPort |
integer | yes | Int32 field of ChangeChannelMessage. |
udpPort |
integer | yes | Int32 field of ChangeChannelMessage. |
changeChannelTag |
string | yes | String field of ChangeChannelMessage. |
Server message ChatRoomChatMessage (subject 92), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
timestamp |
integer | yes | Int64 field of ChatRoomChatMessage. |
playFabId |
string | yes | String field of ChatRoomChatMessage. |
displayName |
string | yes | String field of ChatRoomChatMessage. |
message |
string | yes | String field of ChatRoomChatMessage. |
type |
enum | yes | ChatMessageType field of ChatRoomChatMessage. One of: Standard, Affirmative, Unsure, Alert, StandardLong, Party, Whisper, System, Discord, Guild, GuildNotice, ExpectingSend, ThinkingAboutSending. |
Server message ClaimQuestResultMessage (subject 218), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
success |
bool | yes | Boolean field of ClaimQuestResultMessage. |
nextClaimQuestIndex |
integer | yes | Int32 field of ClaimQuestResultMessage. |
Server message ClientConnectedToLoginMessage (subject 8), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
connectionId |
integer | yes | UInt16 field of ClientConnectedToLoginMessage. |
Server message ClientLoginHandshakeMessage (subject 9), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of ClientLoginHandshakeMessage. |
Server message CollectMasteryRewardResultMessage (subject 206), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
unitTypes |
list | no | List of String field of CollectMasteryRewardResultMessage. |
masteryLevelsUnlocked |
list | no | List of Int32 field of CollectMasteryRewardResultMessage. |
totalEssenceReward |
integer | yes | Int32 field of CollectMasteryRewardResultMessage. |
Server message ConfirmGiftAFriendMessage (subject 192), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
friendPlayFabId |
string | yes | String field of ConfirmGiftAFriendMessage. |
friendDisplayName |
string | yes | String field of ConfirmGiftAFriendMessage. |
errorMessage |
string | yes | String field of ConfirmGiftAFriendMessage. |
Server message ConfirmInitialExperienceLevelMessage (subject 180), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
initialExperienceLevel |
string | yes | String field of ConfirmInitialExperienceLevelMessage. |
Server message ConfirmMoneyLendMessage (subject 236), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
lendedGold |
integer | yes | Int32 field of ConfirmMoneyLendMessage. |
penalty |
integer | yes | Int32 field of ConfirmMoneyLendMessage. |
Server message ConfirmSkipTutorialMessage (subject 185), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of ConfirmSkipTutorialMessage. |
Server message ConfirmUnitHiredMessage (subject 65), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of ConfirmUnitHiredMessage. |
unit |
integer | yes | Int16 field of ConfirmUnitHiredMessage. |
unitType |
string | yes | String field of ConfirmUnitHiredMessage. |
fromQueue |
bool | yes | Boolean field of ConfirmUnitHiredMessage. |
Server message ConfirmUnitTrainedMessage (subject 132), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of ConfirmUnitTrainedMessage. |
unit |
integer | yes | Int16 field of ConfirmUnitTrainedMessage. |
unitType |
string | yes | String field of ConfirmUnitTrainedMessage. |
canceled |
bool | yes | Boolean field of ConfirmUnitTrainedMessage. |
Server message ConsoleLogMessage (subject 42), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
output |
string | yes | String field of ConsoleLogMessage. |
Server message ConsumeItemResultMessage (subject 120), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
itemInstanceId |
string | yes | String field of ConsumeItemResultMessage. |
itemType |
string | yes | String field of ConsumeItemResultMessage. |
hidePopups |
bool | yes | Boolean field of ConsumeItemResultMessage. |
Server message ConvertItemToEssenceResultMessage (subject 166), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
itemInstanceId |
string | yes | String field of ConvertItemToEssenceResultMessage. |
itemType |
string | yes | String field of ConvertItemToEssenceResultMessage. |
newEssence |
integer | yes | Int32 field of ConvertItemToEssenceResultMessage. |
Server message CreateFloatingTextMessage (subject 40), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
point |
object | no | Point field of CreateFloatingTextMessage. |
sourcePoint |
object | no | Point field of CreateFloatingTextMessage. |
message |
string | yes | String field of CreateFloatingTextMessage. |
presetStyle |
enum | yes | FloatingTextStyle field of CreateFloatingTextMessage. One of: BountyText, HealText, MythiumText, IncomeText, UnitStatsText, DamageText, SpellText, EnemyDamageText, DodgedText, ManaText, BuffText, NonCombatText, SpecialMythiumText. |
Server message CreateTutorialArrowTextMessage (subject 125), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
id |
string | yes | String field of CreateTutorialArrowTextMessage. |
uiKey |
string | yes | String field of CreateTutorialArrowTextMessage. |
point |
object | no | Point field of CreateTutorialArrowTextMessage. |
unit |
integer | yes | Int16 field of CreateTutorialArrowTextMessage. |
message |
string | yes | String field of CreateTutorialArrowTextMessage. |
successTrigger |
enum | yes | TutorialEvents field of CreateTutorialArrowTextMessage. One of: None, SucceedImmediately, LegionSelected, BuildAimerActivated, BuildAimerCanceled, ConstructionStarted, ContinueButtonPressed, AnyUnitSelected, SpecificUnitSelected, UnitDeselected, UnitUpgraded, UnitHired, UnitTrained, WindshieldOpened, WindshieldClosed, LowGold, ZeroGold, Over40Mythium, WaveTimerClicked. |
idIfSuccess |
string | yes | String field of CreateTutorialArrowTextMessage. |
failTrigger |
enum | yes | TutorialEvents field of CreateTutorialArrowTextMessage. One of: None, SucceedImmediately, LegionSelected, BuildAimerActivated, BuildAimerCanceled, ConstructionStarted, ContinueButtonPressed, AnyUnitSelected, SpecificUnitSelected, UnitDeselected, UnitUpgraded, UnitHired, UnitTrained, WindshieldOpened, WindshieldClosed, LowGold, ZeroGold, Over40Mythium, WaveTimerClicked. |
idIfFail |
string | yes | String field of CreateTutorialArrowTextMessage. |
flags |
enum | yes | ArrowTextFlags field of CreateTutorialArrowTextMessage. One of: None, ShowImmediately, ShowContinueButton, PassThrough, DontHidePrevious, DontShowArrow, Mirror, PanCameraToTarget, DontShowSquare, LockCameraOnTarget, ForceExitCinematicMode, ForceAllowActionsWithContinue. |
arg1 |
string | yes | String field of CreateTutorialArrowTextMessage. |
parsedDescriptionId |
string | yes | String field of CreateTutorialArrowTextMessage. |
parsedDescriptionStringOverrides |
list | no | List of String field of CreateTutorialArrowTextMessage. |
Server message CustomEventMessage (subject 41), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of CustomEventMessage. |
eventIndex |
integer | yes | Int32 field of CustomEventMessage. |
Server message CustomGameRoomDisbandedMessage (subject 85), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of CustomGameRoomDisbandedMessage. |
Server message CustomGameRoomListingResultMessage (subject 153), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
lobbyBuildId |
string | yes | String field of CustomGameRoomListingResultMessage. |
rooms |
list | no | List of CustomGameRoomProperties field of CustomGameRoomListingResultMessage. |
Server message CustomLogMessage (subject 116), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
output |
string | yes | String field of CustomLogMessage. |
Server message DiscordChatMessage (subject 163), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
Id |
integer | yes | UInt64 field of DiscordChatMessage. |
Timestamp |
integer | yes | Int64 field of DiscordChatMessage. |
DisplayName |
string | yes | String field of DiscordChatMessage. |
Message |
string | yes | String field of DiscordChatMessage. |
ChannelId |
integer | yes | UInt64 field of DiscordChatMessage. |
IsWebhook |
bool | yes | Boolean field of DiscordChatMessage. |
IsStaff |
bool | yes | Boolean field of DiscordChatMessage. |
IsMod |
bool | yes | Boolean field of DiscordChatMessage. |
IsHelper |
bool | yes | Boolean field of DiscordChatMessage. |
Server message DisplayGameTextMessage (subject 53), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
header |
string | yes | String field of DisplayGameTextMessage. |
content |
string | yes | String field of DisplayGameTextMessage. |
duration |
float | yes | Single field of DisplayGameTextMessage. |
image |
string | yes | String field of DisplayGameTextMessage. |
Server message DisplayPickedModeMessage (subject 212), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
mode1Picked |
bool | yes | Boolean field of DisplayPickedModeMessage. |
mode2Picked |
bool | yes | Boolean field of DisplayPickedModeMessage. |
mode1Yes |
integer | yes | Int32 field of DisplayPickedModeMessage. |
mode1No |
integer | yes | Int32 field of DisplayPickedModeMessage. |
mode2Yes |
integer | yes | Int32 field of DisplayPickedModeMessage. |
mode2No |
integer | yes | Int32 field of DisplayPickedModeMessage. |
hotMode |
integer | yes | Int32 field of DisplayPickedModeMessage. |
Server message DisplayPlayerClearedTextMessage (subject 177), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
header |
string | yes | String field of DisplayPlayerClearedTextMessage. |
content |
string | yes | String field of DisplayPlayerClearedTextMessage. |
duration |
float | yes | Single field of DisplayPlayerClearedTextMessage. |
image |
string | yes | String field of DisplayPlayerClearedTextMessage. |
clearTime |
float | yes | Single field of DisplayPlayerClearedTextMessage. |
Server message DisplayPlayerLeakedTextMessage (subject 176), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
header |
string | yes | String field of DisplayPlayerLeakedTextMessage. |
content |
string | yes | String field of DisplayPlayerLeakedTextMessage. |
duration |
float | yes | Single field of DisplayPlayerLeakedTextMessage. |
image |
string | yes | String field of DisplayPlayerLeakedTextMessage. |
leakTime |
float | yes | Single field of DisplayPlayerLeakedTextMessage. |
mercenariesReceived |
list | no | String[] field of DisplayPlayerLeakedTextMessage. |
mercenariesReceivedDead |
list | no | Boolean[] field of DisplayPlayerLeakedTextMessage. |
shutdownGold |
integer | yes | Int32 field of DisplayPlayerLeakedTextMessage. |
Server message EarnIngameAchievementMessage (subject 187), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
achievementKey |
string | yes | String field of EarnIngameAchievementMessage. |
Server message ErrorStartingGame (subject 90), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
message |
string | yes | String field of ErrorStartingGame. |
Server message ForceHideUnitMessage (subject 68), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of ForceHideUnitMessage. |
unit |
integer | yes | Int16 field of ForceHideUnitMessage. |
Server message ForceMaintenancePopupMessage (subject 183), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
debugReason |
string | yes | String field of ForceMaintenancePopupMessage. |
Server message ForcePickLegionMessage (subject 122), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
legionType |
integer | yes | Int32 field of ForcePickLegionMessage. |
Server message ForceRefreshCurrencyMessage (subject 228), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
textColor |
string | yes | String field of ForceRefreshCurrencyMessage. |
notificationMessage |
string | yes | String field of ForceRefreshCurrencyMessage. |
notificationMessageApexId |
string | yes | String field of ForceRefreshCurrencyMessage. |
notificationMessageApexCustomValues |
list | no | List of String field of ForceRefreshCurrencyMessage. |
premiumEssenceReward |
integer | yes | Int32 field of ForceRefreshCurrencyMessage. |
Server message ForceRefreshInboxMessage (subject 172), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
notificationMessage |
string | yes | String field of ForceRefreshInboxMessage. |
Server message ForceSelectUnitMessage (subject 134), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
unit |
integer | yes | Int16 field of ForceSelectUnitMessage. |
expectCurrentSelectedUnit |
integer | yes | Int16 field of ForceSelectUnitMessage. |
Server message ForceSetPlayerIdMessage (subject 71), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of ForceSetPlayerIdMessage. |
Server message ForceSyncPlayerMessage (subject 69), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of ForceSyncPlayerMessage. |
player |
integer | yes | UInt16 field of ForceSyncPlayerMessage. |
name |
string | yes | String field of ForceSyncPlayerMessage. |
controller |
string | yes | String field of ForceSyncPlayerMessage. |
image |
string | yes | String field of ForceSyncPlayerMessage. |
gold |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
mythium |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
foodUsed |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
foodCap |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
income |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
workers |
float | yes | Single field of ForceSyncPlayerMessage. |
value |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
isConnected |
bool | yes | Boolean field of ForceSyncPlayerMessage. |
defenderPlayer |
integer | yes | UInt16 field of ForceSyncPlayerMessage. |
attackerPlayer |
integer | yes | UInt16 field of ForceSyncPlayerMessage. |
powerupChoices |
list | no | List of String field of ForceSyncPlayerMessage. |
powerupSelected |
string | yes | String field of ForceSyncPlayerMessage. |
totalGoldFromIncome |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
totalGoldFromEnemyLeaks |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
totalGoldLostToLeaks |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
totalEnemyTeamGoldFromYourLeaks |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
mythiumGatherRate |
float | yes | Single field of ForceSyncPlayerMessage. |
totalGoldFromCatchingLeaks |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
rolls |
list | no | List of String field of ForceSyncPlayerMessage. |
totalMythium |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
isDualBuilding |
bool | yes | Boolean field of ForceSyncPlayerMessage. |
extraRecommendedValue |
integer | yes | Int32 field of ForceSyncPlayerMessage. |
legionUnitType |
string | yes | String field of ForceSyncPlayerMessage. |
partyMembers |
list | no | List of String field of ForceSyncPlayerMessage. |
megamind |
bool | yes | Boolean field of ForceSyncPlayerMessage. |
disableBarracksText |
string | yes | String field of ForceSyncPlayerMessage. |
disableKingUpgradesText |
string | yes | String field of ForceSyncPlayerMessage. |
doubleDownActive |
bool | yes | Boolean field of ForceSyncPlayerMessage. |
Server message ForceSyncUnitBatchMessage (subject 5), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
currentTick |
integer | yes | Int64 field of ForceSyncUnitBatchMessage. |
keyframes |
object | no | BlockingQueue of ForceSyncUnitMessage field of ForceSyncUnitBatchMessage. |
keyframesList |
list | no | IList of ForceSyncUnitMessage field of ForceSyncUnitBatchMessage. |
Server message ForwardedOkLetsDualBuildMessage (subject 201), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
fromPlayer |
integer | yes | UInt16 field of ForwardedOkLetsDualBuildMessage. |
Server message ForwardedPartyMemberMatchFoundActionMessage (subject 220), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
action |
enum | yes | MatchFoundAction field of ForwardedPartyMemberMatchFoundActionMessage. One of: None, Accepted, Declined. |
playFabId |
string | yes | String field of ForwardedPartyMemberMatchFoundActionMessage. |
Server message ForwardedPartyMemberMatchFoundMessage (subject 161), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of ForwardedPartyMemberMatchFoundMessage. |
matchId |
string | yes | String field of ForwardedPartyMemberMatchFoundMessage. |
queueName |
string | yes | String field of ForwardedPartyMemberMatchFoundMessage. |
Server message ForwardedTellPartyCampaignDlcOwnershipMessage (subject 203), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
campaignDlcsOwned |
list | no | List of String field of ForwardedTellPartyCampaignDlcOwnershipMessage. |
Server message ForwardedTryJoinCustomGameRoomMessage (subject 150), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
ownerPlayFabId |
string | yes | String field of ForwardedTryJoinCustomGameRoomMessage. |
joinerPlayFabId |
string | yes | String field of ForwardedTryJoinCustomGameRoomMessage. |
Server message ForwardedWantsToDualBuildMessage (subject 200), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
fromPlayer |
integer | yes | UInt16 field of ForwardedWantsToDualBuildMessage. |
Server message GameAlreadyStartedMessage (subject 89), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of GameAlreadyStartedMessage. |
Server message GameNoLongerExistsMessage (subject 88), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of GameNoLongerExistsMessage. |
Server message GameServerReadyMessage (subject 98), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
hostname |
string | yes | String field of GameServerReadyMessage. |
tcpPort |
integer | yes | UInt32 field of GameServerReadyMessage. |
udpPort |
integer | yes | UInt32 field of GameServerReadyMessage. |
websocket |
integer | yes | UInt32 field of GameServerReadyMessage. |
slotIds |
list | no | String[] field of GameServerReadyMessage. |
displayNames |
list | no | String[] field of GameServerReadyMessage. |
totalXps |
list | no | Int32[] field of GameServerReadyMessage. |
ratings |
list | no | Single[] field of GameServerReadyMessage. |
avatars |
list | no | String[] field of GameServerReadyMessage. Cosmetic. |
isReconnect |
bool | yes | Boolean field of GameServerReadyMessage. |
isSpectate |
bool | yes | Boolean field of GameServerReadyMessage. |
hexGameId |
string | yes | String field of GameServerReadyMessage. |
debugInfo |
string | yes | String field of GameServerReadyMessage. |
serverId |
string | yes | String field of GameServerReadyMessage. |
buildId |
string | yes | String field of GameServerReadyMessage. |
startedTicks |
integer | yes | Int64 field of GameServerReadyMessage. |
Server message GameServerWelcomeMessage (subject 1), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| 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. |
Server message GameStartedMessage (subject 72), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of GameStartedMessage. |
showPregame |
bool | yes | Boolean field of GameStartedMessage. |
missionId |
string | yes | String field of GameStartedMessage. |
settings |
object | no | CustomGameSettingsProperties field of GameStartedMessage. |
Server message GenericGameServerRequestedMessage (subject 158), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of GenericGameServerRequestedMessage. |
Server message HighRankCalloutMessage (subject 232), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
message |
string | yes | String field of HighRankCalloutMessage. |
isClassic |
bool | yes | Boolean field of HighRankCalloutMessage. |
Server message InQueueResultMessage (subject 226), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
requestedQueueType |
enum | yes | QueueType field of InQueueResultMessage. 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 InQueueResultMessage. |
result |
list | no | List of PlayerInQueueInfo field of InQueueResultMessage. |
autoQueueIfClear |
bool | yes | Boolean field of InQueueResultMessage. |
Server message InitMessage (subject 0), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| 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. |
Server message InvitedToCustomGameRoomMessage (subject 86), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
ownerPlayFabId |
string | yes | String field of InvitedToCustomGameRoomMessage. |
Server message InvitedToGuildMessage (subject 170), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
inviterPlayFabId |
string | yes | String field of InvitedToGuildMessage. |
inviterDisplayName |
string | yes | String field of InvitedToGuildMessage. |
props |
object | no | GuildEntityObjectProperties field of InvitedToGuildMessage. |
Server message InvitedToPartyMessage (subject 106), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
ownerPlayFabId |
string | yes | String field of InvitedToPartyMessage. |
inviterPlayFabId |
string | yes | String field of InvitedToPartyMessage. |
Server message JoinCustomGameRoomMessage (subject 82), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
owner |
string | yes | String field of JoinCustomGameRoomMessage. |
occupants |
list | no | String[] field of JoinCustomGameRoomMessage. |
Server message JoinSoloPartyMessage (subject 138), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
Server message KickedFromGuildMessage (subject 173), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
sourcePlayFabId |
string | yes | String field of KickedFromGuildMessage. |
Server message KickedFromPartyMessage (subject 108), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of KickedFromPartyMessage. |
Server message LeaveQueueToFormQuickMatchMessage (subject 157), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
partyOwnerPlayFabId |
string | yes | String field of LeaveQueueToFormQuickMatchMessage. |
difficulty |
enum | yes | BotDifficulty field of LeaveQueueToFormQuickMatchMessage. One of: SuperEasy, Easy, Medium, Hard. |
Server message LiveGamesResultMessage (subject 238), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
games |
list | no | List of LiveGameInfo field of LiveGamesResultMessage. |
Server message LoadClientNotificationMessage (subject 58), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
header |
string | yes | String field of LoadClientNotificationMessage. |
message |
string | yes | String field of LoadClientNotificationMessage. |
duration |
float | yes | Single field of LoadClientNotificationMessage. |
notificationType |
enum | yes | NotificationType field of LoadClientNotificationMessage. One of: Normal, Warning. |
Server message LoadOkPopupMessage (subject 56), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
header |
string | yes | String field of LoadOkPopupMessage. |
message |
string | yes | String field of LoadOkPopupMessage. |
Server message LoadPopupMessage (subject 55), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
popupName |
string | yes | String field of LoadPopupMessage. |
Server message LoadUnclickablePopupMessage (subject 57), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
header |
string | yes | String field of LoadUnclickablePopupMessage. |
message |
string | yes | String field of LoadUnclickablePopupMessage. |
Server message LoadViewMessage (subject 54), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
viewName |
string | yes | String field of LoadViewMessage. |
forced |
bool | yes | Boolean field of LoadViewMessage. |
freeze |
bool | yes | Boolean field of LoadViewMessage. |
Server message LobbyCallbackMessage (subject 105), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
callbackId |
string | yes | String field of LobbyCallbackMessage. |
dataJSON |
string | yes | String field of LobbyCallbackMessage. |
Server message LobbyReadyMessage (subject 5), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| 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. |
Server message LoudAnnouncementMessage (subject 229), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
serializedMessage |
string | yes | String field of LoudAnnouncementMessage. |
tag |
string | yes | String field of LoudAnnouncementMessage. |
Server message MakeSquaresBuildableMessage (subject 35), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
points |
list | no | List of Point field of MakeSquaresBuildableMessage. |
buildable |
bool | yes | Boolean field of MakeSquaresBuildableMessage. |
enableGrid |
bool | yes | Boolean field of MakeSquaresBuildableMessage. |
Server message MapMessage (subject 74), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
mapName |
string | yes | String field of MapMessage. |
hash64 |
string | yes | String field of MapMessage. |
player |
integer | yes | UInt16 field of MapMessage. |
Server message MapPingMessage (subject 59), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of MapPingMessage. |
pingType |
enum | yes | PingType field of MapPingMessage. One of: None, Regular, OnMyWay, Target, Warning, Question, Help, RegularGround, Checkmark, ReachedKing, LeakedThem. |
point |
object | no | Point field of MapPingMessage. |
Server message MaphackEnabledMessage (subject 202), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of MaphackEnabledMessage. |
Server message MatchFoundCanceledMessage (subject 97), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of MatchFoundCanceledMessage. |
Server message MatchFoundMessage (subject 96), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
match |
object | no | Match field of MatchFoundMessage. |
Server message MatchmadeGameServerRequestedMessage (subject 101), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of MatchmadeGameServerRequestedMessage. 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. |
estimatedTime |
float | yes | Single field of MatchmadeGameServerRequestedMessage. |
fromPlayFabId |
string | yes | String field of MatchmadeGameServerRequestedMessage. |
ticketId |
string | yes | String field of MatchmadeGameServerRequestedMessage. |
messageNumber |
integer | yes | Int32 field of MatchmadeGameServerRequestedMessage. |
timestamp |
integer | yes | Int64 field of MatchmadeGameServerRequestedMessage. |
Server message MatchmakingForbiddenMessage (subject 99), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of MatchmakingForbiddenMessage. |
suspendedUntilTicks |
integer | yes | Int64 field of MatchmakingForbiddenMessage. |
gameStartedTicks |
integer | yes | Int64 field of MatchmakingForbiddenMessage. |
gameId |
string | yes | String field of MatchmakingForbiddenMessage. |
recentlyDodged |
bool | yes | Boolean field of MatchmakingForbiddenMessage. |
Server message MatchmakingPlayerAllReadyMessage (subject 144), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
expectedPlayers |
integer | yes | Int32 field of MatchmakingPlayerAllReadyMessage. |
Server message MatchmakingPlayerReadyFailedMessage (subject 143), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of MatchmakingPlayerReadyFailedMessage. 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. |
Server message MatchmakingPlayerReadyMessage (subject 142), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
readyPlayers |
integer | yes | Int32 field of MatchmakingPlayerReadyMessage. |
expectedPlayers |
integer | yes | Int32 field of MatchmakingPlayerReadyMessage. |
Server message MatchmakingRequestCanceledMessage (subject 100), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
sourcePlayFabId |
string | yes | String field of MatchmakingRequestCanceledMessage. |
cancellationReason |
enum | yes | MatchmakingCancellationReason field of MatchmakingRequestCanceledMessage. One of: Voluntary, LeaveForQuickMatch, MatchmakingError, QuitApplication, FailedValidationOnLobby, FailedValidationOnClient, ClientInternalOrTimeoutError, ClientUnknownApiError, PartyMemberLeftOrDisconnected, PartyMemberJoined. |
Server message MatchmakingV1RequestFailedMessage (subject 184), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
debugReason |
string | yes | String field of MatchmakingV1RequestFailedMessage. |
Server message NetworkErrorMessage (subject 78), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
message |
string | yes | String field of NetworkErrorMessage. |
Server message PartyIsAvailableForQuickMatchMessage (subject 181), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
sourcePlayFabId |
string | yes | String field of PartyIsAvailableForQuickMatchMessage. |
estimatedQueueTime |
integer | yes | Int32 field of PartyIsAvailableForQuickMatchMessage. |
Server message PartyMembersChangedMessage (subject 128), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
owner |
string | yes | String field of PartyMembersChangedMessage. |
timestamp |
float | yes | Double field of PartyMembersChangedMessage. |
Server message PartyRecoveryFailedMessage (subject 160), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of PartyRecoveryFailedMessage. 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. |
Server message PlayGlobalSoundMessage (subject 38), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
sfxPath |
string | yes | String field of PlayGlobalSoundMessage. |
announcer |
bool | yes | Boolean field of PlayGlobalSoundMessage. |
ui |
bool | yes | Boolean field of PlayGlobalSoundMessage. |
Server message PlayGlobalWhatSoundMessage (subject 205), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
unitType |
string | yes | String field of PlayGlobalWhatSoundMessage. |
Server message PlaySoundAtPointMessage (subject 36), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
sfxPath |
string | yes | String field of PlaySoundAtPointMessage. |
point |
object | no | Point field of PlaySoundAtPointMessage. |
Server message PlaySoundFromUnitMessage (subject 37), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
unit |
integer | yes | Int16 field of PlaySoundFromUnitMessage. |
soundType |
enum | yes | UnitSoundTypes field of PlaySoundFromUnitMessage. One of: What, Death. |
Server message PlaySpecialThemeMessage (subject 148), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
sfxPath |
string | yes | String field of PlaySpecialThemeMessage. |
Server message PostGameStatsMessage (subject 109), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
localPlayer |
integer | yes | UInt16 field of PostGameStatsMessage. |
queueType |
enum | yes | QueueType field of PostGameStatsMessage. 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. |
postGameResult |
enum | yes | PostGameResult field of PostGameStatsMessage. One of: LeftTeamWon, RightTeamWon, Tie, MissionComplete, MissionIncomplete. |
gameResult |
enum | yes | GameResult field of PostGameStatsMessage. One of: Won, Lost, Tied. |
wave |
integer | yes | Int32 field of PostGameStatsMessage. |
gameTimeSeconds |
integer | yes | Int32 field of PostGameStatsMessage. |
currentRating |
integer | yes | Int32 field of PostGameStatsMessage. |
xpGained |
integer | yes | Int32 field of PostGameStatsMessage. |
currencyEarned |
integer | yes | Int32 field of PostGameStatsMessage. |
eloDelta |
integer | yes | Int32 field of PostGameStatsMessage. |
guildXpGained |
integer | yes | Int32 field of PostGameStatsMessage. |
guildVpGained |
integer | yes | Int32 field of PostGameStatsMessage. |
eventPoints |
integer | yes | Int32 field of PostGameStatsMessage. |
eventPointsGained |
integer | yes | Int32 field of PostGameStatsMessage. |
lp |
integer | yes | Int32 field of PostGameStatsMessage. |
lpGained |
integer | yes | Int32 field of PostGameStatsMessage. |
lpGamesThisWeek |
integer | yes | Int32 field of PostGameStatsMessage. |
mp |
integer | yes | Int32 field of PostGameStatsMessage. |
mpGained |
integer | yes | Int32 field of PostGameStatsMessage. |
openingUnitType |
string | yes | String field of PostGameStatsMessage. |
ratingModifierTexts |
list | no | List of String field of PostGameStatsMessage. |
currencyModifierTexts |
list | no | List of String field of PostGameStatsMessage. |
guildXpModifierTexts |
list | no | List of String field of PostGameStatsMessage. |
mpModifierTexts |
list | no | List of String field of PostGameStatsMessage. |
causedMatchCanceled |
bool | yes | Boolean field of PostGameStatsMessage. |
dateTimeUtcTicks |
integer | yes | Int64 field of PostGameStatsMessage. |
gameId |
string | yes | String field of PostGameStatsMessage. |
gameCoachMistake |
object | no | GameCoachMistake field of PostGameStatsMessage. |
leftTeamRows |
list | no | List of PostGameStatsRowProperties field of PostGameStatsMessage. |
rightTeamRows |
list | no | List of PostGameStatsRowProperties field of PostGameStatsMessage. |
waveDatas |
list | no | List of PostGameWaveData field of PostGameStatsMessage. |
buildData |
object | no | PostGameBuildData field of PostGameStatsMessage. |
graphData |
object | no | PostGameGraphsProperties field of PostGameStatsMessage. |
suspiciousPlayerNames |
list | no | List of String field of PostGameStatsMessage. |
fairPlayToxicityInfo |
object | no | FairPlayToxicityInfo field of PostGameStatsMessage. |
starsEarned |
list | no | List of Int32 field of PostGameStatsMessage. |
missionId |
string | yes | String field of PostGameStatsMessage. |
missionHardMode |
bool | yes | Boolean field of PostGameStatsMessage. |
missionStarNumber |
integer | yes | Int32 field of PostGameStatsMessage. |
achievementsEarned |
list | no | List of String field of PostGameStatsMessage. |
goalsEarned |
list | no | List of Int32 field of PostGameStatsMessage. |
itemsEarned |
list | no | List of String field of PostGameStatsMessage. |
usedDoubleDown |
bool | yes | Boolean field of PostGameStatsMessage. |
peGained |
integer | yes | Int32 field of PostGameStatsMessage. |
Server message PromptLockInMessage (subject 213), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
isReconnect |
bool | yes | Boolean field of PromptLockInMessage. |
numChoices |
integer | yes | Int32 field of PromptLockInMessage. |
Server message ReadyForMatchmakingV2Message (subject 154), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of ReadyForMatchmakingV2Message. 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. |
Server message ReceiveEmoteMessage (subject 215), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
emoteIndex |
integer | yes | Int32 field of ReceiveEmoteMessage. Cosmetic. |
player |
integer | yes | UInt16 field of ReceiveEmoteMessage. |
animationType |
string | yes | String field of ReceiveEmoteMessage. Cosmetic. |
point |
object | no | Point field of ReceiveEmoteMessage. |
Server message ReceiveMysteriousCardMessage (subject 140), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
itemType |
string | yes | String field of ReceiveMysteriousCardMessage. |
triggerItemType |
string | yes | String field of ReceiveMysteriousCardMessage. |
Server message ReceiveMysteriousMultiCardsMessage (subject 141), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
itemType |
string | yes | String field of ReceiveMysteriousMultiCardsMessage. |
cards |
list | no | String[] field of ReceiveMysteriousMultiCardsMessage. |
Server message RefreshAutoSendMercsMessage (subject 235), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshAutoSendMercsMessage. |
sendDecision |
integer | yes | Int32 field of RefreshAutoSendMercsMessage. |
sendPreview |
list | no | String[] field of RefreshAutoSendMercsMessage. |
Server message RefreshAutosendStatusMessage (subject 194), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
enabled |
bool | yes | Boolean field of RefreshAutosendStatusMessage. |
player |
integer | yes | UInt16 field of RefreshAutosendStatusMessage. |
decision |
enum | yes | SendDecision field of RefreshAutosendStatusMessage. One of: None, Save, Income, Power. |
Server message RefreshBuilderInfoMessage (subject 233), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
masterminds |
list | no | Int32[] field of RefreshBuilderInfoMessage. |
legions |
list | no | Int32[] field of RefreshBuilderInfoMessage. |
builderChoosen |
list | no | Boolean[] field of RefreshBuilderInfoMessage. |
Server message RefreshChatRoomHistoryMessage (subject 95), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
messages |
list | no | List of DiscordChatMessage field of RefreshChatRoomHistoryMessage. |
Server message RefreshChatRoomSubscribersMessage (subject 94), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
channelName |
string | yes | String field of RefreshChatRoomSubscribersMessage. |
subscribers |
list | no | IList of String field of RefreshChatRoomSubscribersMessage. |
subscribersDisplayNames |
list | no | IList of String field of RefreshChatRoomSubscribersMessage. |
avatars |
list | no | IList of String field of RefreshChatRoomSubscribersMessage. |
ingame |
list | no | IList of Boolean field of RefreshChatRoomSubscribersMessage. |
isCachedResult |
bool | yes | Boolean field of RefreshChatRoomSubscribersMessage. |
Server message RefreshClassicModeEnabledMessage (subject 222), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
incomeAndChillEnabled |
bool | yes | Boolean field of RefreshClassicModeEnabledMessage. |
modeIndex |
integer | yes | Int32 field of RefreshClassicModeEnabledMessage. |
Server message RefreshCustomGameRoomsMessage (subject 87), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
rooms |
list | no | List of CustomGameRoomProperties field of RefreshCustomGameRoomsMessage. |
Server message RefreshCustomGameSettingsMessage (subject 91), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
settings |
object | no | CustomGameSettingsProperties field of RefreshCustomGameSettingsMessage. |
Server message RefreshDataReportsMessage (subject 44), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
dailyActiveUsers |
string | yes | String field of RefreshDataReportsMessage. |
currentPlayerCount |
integer | yes | Int32 field of RefreshDataReportsMessage. |
totalAccounts |
integer | yes | Int32 field of RefreshDataReportsMessage. |
matchmakingRatingCap |
integer | yes | Int32 field of RefreshDataReportsMessage. |
smurfRatingCap |
integer | yes | Int32 field of RefreshDataReportsMessage. |
Server message RefreshDeltaMultiplierMessage (subject 104), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
deltaMultiplier |
float | yes | Single field of RefreshDeltaMultiplierMessage. |
deltaBonus |
integer | yes | Int32 field of RefreshDeltaMultiplierMessage. |
player |
integer | yes | UInt16 field of RefreshDeltaMultiplierMessage. |
Server message RefreshDeployStacksMessage (subject 167), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
StacksTable |
list | no | Dictionary of String and Int32 field of RefreshDeployStacksMessage. |
Server message RefreshExtraGoldCountersMessage (subject 198), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshExtraGoldCountersMessage. |
fiestaGold |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
dwarfBankerGold |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
chloropixieMythium |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
redrawGold |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
vaultGold |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
vaultUsedOnWave |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
executionerGold |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
hybridGold |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
riftTraderGold |
integer | yes | Int32 field of RefreshExtraGoldCountersMessage. |
Server message RefreshGoldBountyRemainingMessage (subject 179), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
goldBountyRemaining |
integer | yes | Int32 field of RefreshGoldBountyRemainingMessage. |
leakGoldRemaining |
integer | yes | Int32 field of RefreshGoldBountyRemainingMessage. |
cartelGold |
integer | yes | Int32 field of RefreshGoldBountyRemainingMessage. |
castleGold |
integer | yes | Int32 field of RefreshGoldBountyRemainingMessage. |
Server message RefreshInGameCoachMessage (subject 182), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tipType |
string | yes | String field of RefreshInGameCoachMessage. |
message |
string | yes | String field of RefreshInGameCoachMessage. |
flags |
enum | yes | InGameCoachMessageType field of RefreshInGameCoachMessage. One of: None, Autoshow, Autohide, AutohideAfterShortDelay, AutohideAfterLongDelay. |
Server message RefreshLeakRatioMessage (subject 146), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshLeakRatioMessage. |
leakRatioFirstNumber |
integer | yes | Int32 field of RefreshLeakRatioMessage. |
leakRatioSecondNumber |
integer | yes | Int32 field of RefreshLeakRatioMessage. |
Server message RefreshLoadingProgressMessage (subject 103), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshLoadingProgressMessage. |
progress |
float | yes | Single field of RefreshLoadingProgressMessage. |
Server message RefreshLoadingStickerExtrasMessage (subject 165), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
avatarStacks |
list | no | Int32[] field of RefreshLoadingStickerExtrasMessage. Cosmetic. |
guildAvatars |
list | no | String[] field of RefreshLoadingStickerExtrasMessage. Cosmetic. |
guildAvatarStacks |
list | no | Int32[] field of RefreshLoadingStickerExtrasMessage. Cosmetic. |
guildWarActive |
bool | yes | Boolean field of RefreshLoadingStickerExtrasMessage. |
classicElosToUse |
list | no | Int32[] field of RefreshLoadingStickerExtrasMessage. |
isClassic |
bool | yes | Boolean field of RefreshLoadingStickerExtrasMessage. |
countries |
list | no | String[] field of RefreshLoadingStickerExtrasMessage. |
hasBigWigPass |
list | no | Boolean[] field of RefreshLoadingStickerExtrasMessage. Cosmetic. |
Server message RefreshLoadingStickerSuffixMessage (subject 139), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable; cosmetic (local servers only).
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshLoadingStickerSuffixMessage. |
suffix |
string | yes | String field of RefreshLoadingStickerSuffixMessage. |
Server message RefreshMegamindEnabledMessage (subject 224), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshMegamindEnabledMessage. |
enabled |
bool | yes | Boolean field of RefreshMegamindEnabledMessage. |
Server message RefreshMercenariesReceivedMessage (subject 64), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
mythiumReceived |
list | no | List of Int32 field of RefreshMercenariesReceivedMessage. |
mythiumSent |
list | no | List of Int32 field of RefreshMercenariesReceivedMessage. |
mercenariesReceived |
list | no | List of List of UInt16 field of RefreshMercenariesReceivedMessage. |
hideNotifications |
bool | yes | Boolean field of RefreshMercenariesReceivedMessage. |
kingUpgrades |
list | no | List of List of UInt16 field of RefreshMercenariesReceivedMessage. |
opponentKingUpgrades |
list | no | List of List of UInt16 field of RefreshMercenariesReceivedMessage. |
opponentKingUpgradesValue |
list | no | List of Int32 field of RefreshMercenariesReceivedMessage. |
opponentExtraIcons |
list | no | List of List of String field of RefreshMercenariesReceivedMessage. |
Server message RefreshMonumentsMessage (subject 186), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable; cosmetic (local servers only).
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshMonumentsMessage. |
monuments |
list | no | List of MonumentInfo field of RefreshMonumentsMessage. |
Server message RefreshObjectivesMessage (subject 126), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
objectives |
list | no | List of CampaignObjectiveProperties field of RefreshObjectivesMessage. |
Server message RefreshPartyMembersMessage (subject 107), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabIds |
list | no | String[] field of RefreshPartyMembersMessage. |
ownerPlayFabId |
string | yes | String field of RefreshPartyMembersMessage. |
messageNumber |
integer | yes | Int32 field of RefreshPartyMembersMessage. |
operationType |
enum | yes | PartyOperationType field of RefreshPartyMembersMessage. One of: Overwrite, Leave, Join, SyncToClientOnly. |
autoJoin |
bool | yes | Boolean field of RefreshPartyMembersMessage. |
Server message RefreshPiggybankGoldMessage (subject 230), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
piggybankGold |
integer | yes | Int32 field of RefreshPiggybankGoldMessage. |
piggybankGoldNextWave |
integer | yes | Int32 field of RefreshPiggybankGoldMessage. |
piggybankGoldNextWaveIfLeaked |
integer | yes | Int32 field of RefreshPiggybankGoldMessage. |
piggybankGoldCollected |
integer | yes | Int32 field of RefreshPiggybankGoldMessage. |
Server message RefreshPlaybackRateMessage (subject 130), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
playbackRate |
float | yes | Single field of RefreshPlaybackRateMessage. |
Server message RefreshPlayerDamageTrackerMessage (subject 191), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tracker |
object | no | PlayerDamageTracker field of RefreshPlayerDamageTrackerMessage. |
Server message RefreshPlayerOpeningsMessage (subject 195), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshPlayerOpeningsMessage. |
unitTypes |
list | no | List of String field of RefreshPlayerOpeningsMessage. |
Server message RefreshPlayerRerollsMessage (subject 197), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of RefreshPlayerRerollsMessage. |
rerollsRemaining |
integer | yes | Int32 field of RefreshPlayerRerollsMessage. |
rerollsMax |
integer | yes | Int32 field of RefreshPlayerRerollsMessage. |
Server message RefreshPlayerStackrankMessage (subject 133), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
stackrankProperties |
list | no | List of PlayerStackrankProperties field of RefreshPlayerStackrankMessage. |
Server message RefreshSpectatorWinProbabilitiesMessage (subject 196), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
westWinProbability |
integer | yes | Int32 field of RefreshSpectatorWinProbabilitiesMessage. |
eastWinProbability |
integer | yes | Int32 field of RefreshSpectatorWinProbabilitiesMessage. |
Server message RefreshSuddenDeathCountMessage (subject 221), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
suddenDeathCount |
integer | yes | Int32 field of RefreshSuddenDeathCountMessage. |
Server message RequestAvatarResultMessage (subject 114), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable; cosmetic (local servers only).
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of RequestAvatarResultMessage. |
steamId |
integer | yes | UInt64 field of RequestAvatarResultMessage. |
avatarImage |
string | yes | String field of RequestAvatarResultMessage. |
avatarStacks |
integer | yes | Int32 field of RequestAvatarResultMessage. |
Server message RequestBackendDataResultMessage (subject 131), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
callbackNumber |
integer | yes | Int32 field of RequestBackendDataResultMessage. |
requestType |
enum | yes | BackendRequestType field of RequestBackendDataResultMessage. One of: FullPlayerProfile, MiniPlayerProfile. |
rawResults |
list | no | List of String field of RequestBackendDataResultMessage. |
Server message RequestCustomGameListingMessage (subject 152), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
channelLobbyId |
string | yes | String field of RequestCustomGameListingMessage. |
lobbyBuildId |
string | yes | String field of RequestCustomGameListingMessage. |
Server message RequestGameServerWelcomeMessage (subject 7), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of RequestGameServerWelcomeMessage. |
Server message RequestGuildUpdateResultMessage (subject 169), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
updateType |
enum | yes | GuildUpdateType field of RequestGuildUpdateResultMessage. 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 RequestGuildUpdateResultMessage. |
result |
enum | yes | GuildUpdateResultType field of RequestGuildUpdateResultMessage. One of: Success, AlreadyTaken, WrongLength, UnknownError, MissingItem, WrongPermissions, FailedSanitizationCheck, InvalidCharacters, AlreadyInGuild, InvalidRole, AlreadyInvited, TargetNotEnoughCurrency, GuildIsFull, FailedLevelRequirement, NoLongerInGuild. |
errorDebugMessage |
string | yes | String field of RequestGuildUpdateResultMessage. |
customReturnValue1 |
string | yes | String field of RequestGuildUpdateResultMessage. |
customReturnValue2 |
string | yes | String field of RequestGuildUpdateResultMessage. |
cards |
list | no | List of String field of RequestGuildUpdateResultMessage. |
Server message RequestLinkedAccountsResultMessage (subject 217), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
epicId |
string | yes | String field of RequestLinkedAccountsResultMessage. |
steamId |
string | yes | String field of RequestLinkedAccountsResultMessage. |
displayName |
string | yes | String field of RequestLinkedAccountsResultMessage. |
playFabId |
string | yes | String field of RequestLinkedAccountsResultMessage. |
addAsFriend |
bool | yes | Boolean field of RequestLinkedAccountsResultMessage. |
sendInboxMessage |
bool | yes | Boolean field of RequestLinkedAccountsResultMessage. |
Server message RequestOpeningsLeaderboardResultMessage (subject 188), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
leaderboard |
object | no | OpeningsLeaderboard field of RequestOpeningsLeaderboardResultMessage. |
Server message RequestOpeningsMatchHistoryResultMessage (subject 189), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
m |
object | no | PostGameStatsMessage field of RequestOpeningsMatchHistoryResultMessage. |
Server message RequestReportPlayerResultMessage (subject 111), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
targetPlayFabId |
string | yes | String field of RequestReportPlayerResultMessage. |
errorMessage |
string | yes | String field of RequestReportPlayerResultMessage. |
category |
enum | yes | ReportPlayerCategory field of RequestReportPlayerResultMessage. One of: Griefing, VerbalAbuse, OffensiveName, Leaving, Other. |
comment |
string | yes | String field of RequestReportPlayerResultMessage. |
Server message RequestSteamIdResultMessage (subject 110), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
steamId |
integer | yes | UInt64 field of RequestSteamIdResultMessage. |
pchDialog |
string | yes | String field of RequestSteamIdResultMessage. |
displayName |
string | yes | String field of RequestSteamIdResultMessage. |
playFabId |
string | yes | String field of RequestSteamIdResultMessage. |
Server message RequestTaglineResultMessage (subject 113), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
playFabId |
string | yes | String field of RequestTaglineResultMessage. |
steamId |
integer | yes | UInt64 field of RequestTaglineResultMessage. |
tagline |
string | yes | String field of RequestTaglineResultMessage. |
Server message RequestTryJoinCustomGameRoomMessage (subject 159), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
ownerPlayFabId |
string | yes | String field of RequestTryJoinCustomGameRoomMessage. |
joinerPlayFabId |
string | yes | String field of RequestTryJoinCustomGameRoomMessage. |
Server message RequestTwitchResultMessage (subject 115), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
payload |
string | yes | String field of RequestTwitchResultMessage. |
Server message RerollQuestResultMessage (subject 219), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
success |
bool | yes | Boolean field of RerollQuestResultMessage. |
remainingRerolls |
integer | yes | Int32 field of RerollQuestResultMessage. |
quests |
list | no | List of QuestId field of RerollQuestResultMessage. |
Server message SavedTowerBuildMessage (subject 145), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
serializedBuild |
string | yes | String field of SavedTowerBuildMessage. |
Server message SendServerTimeMessage (subject 76), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
currentTime |
integer | yes | Int64 field of SendServerTimeMessage. |
Server message ServerToClientKeepAliveMessage (subject 199), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of ServerToClientKeepAliveMessage. |
Server message SetBarracksEnabledMessage (subject 137), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
barracksEnabled |
bool | yes | Boolean field of SetBarracksEnabledMessage. |
kingUpgradesEnabled |
bool | yes | Boolean field of SetBarracksEnabledMessage. |
barracksDisabledDescription |
string | yes | String field of SetBarracksEnabledMessage. |
kingUpgradesDisabledDescription |
string | yes | String field of SetBarracksEnabledMessage. |
Server message SetCameraPositionMessage (subject 60), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
point |
object | no | Point field of SetCameraPositionMessage. |
unit |
integer | yes | Int16 field of SetCameraPositionMessage. |
locked |
bool | yes | Boolean field of SetCameraPositionMessage. |
instant |
bool | yes | Boolean field of SetCameraPositionMessage. |
Server message SetChatRoomPropertiesMessage (subject 93), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
chatRoomType |
enum | yes | ChatRoomType field of SetChatRoomPropertiesMessage. One of: Standard, Guild, PostGame, CustomGameRoom, InGame, Party. |
chatRoomName |
string | yes | String field of SetChatRoomPropertiesMessage. |
Server message SetDisplayNameResultMessage (subject 112), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
success |
bool | yes | Boolean field of SetDisplayNameResultMessage. |
isConfirmed |
bool | yes | Boolean field of SetDisplayNameResultMessage. |
displayName |
string | yes | String field of SetDisplayNameResultMessage. |
Server message SetEastEnemiesRemainingTextMessage (subject 52), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
amount |
integer | yes | Int32 field of SetEastEnemiesRemainingTextMessage. |
messageNumber |
integer | yes | Int32 field of SetEastEnemiesRemainingTextMessage. |
Server message SetHudEnabledMessage (subject 123), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
enabled |
bool | yes | Boolean field of SetHudEnabledMessage. |
Server message SetHudInfoMessage (subject 47), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
hudTheme |
string | yes | String field of SetHudInfoMessage. |
Server message SetHudSourceMessage (subject 45), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of SetHudSourceMessage. |
section |
enum | yes | HudSection field of SetHudSourceMessage. One of: None, Dashboard, Windshield, Glovebox, LeftKing, RightKing, Target, Scoreboard, Console, Leftbox. |
unit |
integer | yes | Int16 field of SetHudSourceMessage. |
Server message SetMatchModifiersMessage (subject 119), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
matchModifiers |
list | no | List of MatchModifier field of SetMatchModifiersMessage. |
Server message SetMinimapImageMessage (subject 46), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
minimapPath |
string | yes | String field of SetMinimapImageMessage. |
Server message SetObjectFailedMessage (subject 155), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
queueType |
enum | yes | QueueType field of SetObjectFailedMessage. 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. |
Server message SetPickedMastermind (subject 231), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
variant |
enum | yes | MastermindVariant field of SetPickedMastermind. 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. |
Server message SetRegionHiddenMessage (subject 67), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of SetRegionHiddenMessage. |
player |
integer | yes | UInt16 field of SetRegionHiddenMessage. |
shape |
object | no | VisibilityShape field of SetRegionHiddenMessage. |
Server message SetRegionVisibleMessage (subject 66), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of SetRegionVisibleMessage. |
player |
integer | yes | UInt16 field of SetRegionVisibleMessage. |
shape |
object | no | VisibilityShape field of SetRegionVisibleMessage. |
Server message SetResearchLevelsMessage (subject 63), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
researchTypes |
list | no | List of String field of SetResearchLevelsMessage. |
levels |
list | no | List of Int32 field of SetResearchLevelsMessage. |
Server message SetSpectatorHudMessage (subject 117), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of SetSpectatorHudMessage. |
Server message SetWaveNumberMessage (subject 48), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
waveNumber |
integer | yes | Int32 field of SetWaveNumberMessage. |
Server message SetWaveTimeMessage (subject 49), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
endTick |
integer | yes | Int64 field of SetWaveTimeMessage. |
isPaused |
bool | yes | Boolean field of SetWaveTimeMessage. |
Server message SetWaveTimerPausedMessage (subject 50), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
paused |
bool | yes | Boolean field of SetWaveTimerPausedMessage. |
Server message SetWestEnemiesRemainingTextMessage (subject 51), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
amount |
integer | yes | Int32 field of SetWestEnemiesRemainingTextMessage. |
messageNumber |
integer | yes | Int32 field of SetWestEnemiesRemainingTextMessage. |
Server message ShowChallengeVictoryWindowMessage (subject 168), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
challengeBuild |
object | no | WeeklyChallengeBuild field of ShowChallengeVictoryWindowMessage. |
myBuild |
object | no | SavedTowerBuild field of ShowChallengeVictoryWindowMessage. |
challengeScore |
float | yes | Single field of ShowChallengeVictoryWindowMessage. |
myLeakPercent |
float | yes | Single field of ShowChallengeVictoryWindowMessage. |
myGold |
integer | yes | Int32 field of ShowChallengeVictoryWindowMessage. |
myScore |
integer | yes | Int32 field of ShowChallengeVictoryWindowMessage. |
myRating |
integer | yes | Int32 field of ShowChallengeVictoryWindowMessage. |
firstTimeBeatingGoal |
bool | yes | Boolean field of ShowChallengeVictoryWindowMessage. |
message |
string | yes | String field of ShowChallengeVictoryWindowMessage. |
playSound |
bool | yes | Boolean field of ShowChallengeVictoryWindowMessage. |
Server message ShowExtraGoldVariantMenuMessage (subject 190), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of ShowExtraGoldVariantMenuMessage. |
Server message ShowLockInRaffleMessage (subject 225), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
unitType |
string | yes | String field of ShowLockInRaffleMessage. |
Server message ShowMastermindVariantWindowMessage (subject 164), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
mastermindPlaystyleStatuses |
list | no | List of MastermindPlaystyleStatus field of ShowMastermindVariantWindowMessage. |
classicSpecialModeIndex |
integer | yes | Int32 field of ShowMastermindVariantWindowMessage. |
Server message ShowModeVotingMenuMessage (subject 210), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
specialModeIndex |
integer | yes | Int32 field of ShowModeVotingMenuMessage. |
Server message ShowPowerupsWindowMessage (subject 62), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
powerupTypes |
list | no | List of String field of ShowPowerupsWindowMessage. |
forced |
bool | yes | Boolean field of ShowPowerupsWindowMessage. |
Server message ShowRerollWindowMessage (subject 61), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
unitTypes |
list | no | List of String field of ShowRerollWindowMessage. |
guaranteedUnitTypes |
list | no | List of String field of ShowRerollWindowMessage. |
mulligansRemaining |
integer | yes | Int32 field of ShowRerollWindowMessage. |
enableAutopick |
bool | yes | Boolean field of ShowRerollWindowMessage. |
isAristocrat |
bool | yes | Boolean field of ShowRerollWindowMessage. |
isLockIn |
bool | yes | Boolean field of ShowRerollWindowMessage. |
isSwarm |
bool | yes | Boolean field of ShowRerollWindowMessage. |
Server message ShowStrategistRaffleMessage (subject 223), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
chosenVariant |
enum | yes | MastermindVariant field of ShowStrategistRaffleMessage. 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. |
Server message ShowVersusOverlayMessage (subject 207), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
versusInfos |
list | no | List of PlayerVersusInfo field of ShowVersusOverlayMessage. |
Server message SpecialCouponResultMessage (subject 227), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
couponCode |
string | yes | String field of SpecialCouponResultMessage. |
itemTypeToGrant |
string | yes | String field of SpecialCouponResultMessage. |
error |
string | yes | String field of SpecialCouponResultMessage. |
Server message SpecialEffectBatchMessage (subject 3), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
keyframes |
object | no | BlockingQueue of SpecialEffectMessage field of SpecialEffectBatchMessage. |
keyframesList |
list | no | IList of SpecialEffectMessage field of SpecialEffectBatchMessage. |
Server message SyncGuildEmblemMessage (subject 174), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of SyncGuildEmblemMessage. |
chunkNumber |
integer | yes | Int32 field of SyncGuildEmblemMessage. |
totalChunks |
integer | yes | Int32 field of SyncGuildEmblemMessage. |
guildEmblemChunk |
string | yes | String field of SyncGuildEmblemMessage. |
Server message SyncMoneyLendMessage (subject 237), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
enabled |
bool | yes | Boolean field of SyncMoneyLendMessage. |
Server message SyncPlayerControllerMessage (subject 70), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of SyncPlayerControllerMessage. |
player |
integer | yes | UInt16 field of SyncPlayerControllerMessage. |
controller |
string | yes | String field of SyncPlayerControllerMessage. |
name |
string | yes | String field of SyncPlayerControllerMessage. |
muted |
bool | yes | Boolean field of SyncPlayerControllerMessage. |
customizationIds |
list | no | List of UInt16 field of SyncPlayerControllerMessage. Cosmetic. |
Server message SyncQueueStateMessage (subject 204), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of SyncQueueStateMessage. |
sourceUnit |
integer | yes | Int16 field of SyncQueueStateMessage. |
queueActionType |
enum | yes | QueueActionType field of SyncQueueStateMessage. One of: QueueMercenary, QueueWorker, QueueKingUpgrade. |
ids |
list | no | String[] field of SyncQueueStateMessage. |
queueAmounts |
list | no | Int32[] field of SyncQueueStateMessage. |
messageNumber |
integer | yes | Int32 field of SyncQueueStateMessage. |
Server message SyncTimeHeartbeatMessage (subject 79), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
currentTime |
integer | yes | Int64 field of SyncTimeHeartbeatMessage. |
forced |
bool | yes | Boolean field of SyncTimeHeartbeatMessage. |
Server message SyncUnitGarrisonMessage (subject 175), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
unit |
integer | yes | Int16 field of SyncUnitGarrisonMessage. |
supplierTypes |
list | no | IList of String field of SyncUnitGarrisonMessage. |
supplierCounts |
list | no | IList of Int32 field of SyncUnitGarrisonMessage. |
supplierProgresses |
list | no | IList of Single field of SyncUnitGarrisonMessage. |
Server message TitleDataChangedMessage (subject 43), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of TitleDataChangedMessage. |
Server message TryJoinGuildResultMessage (subject 171), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
success |
bool | yes | Boolean field of TryJoinGuildResultMessage. |
props |
object | no | GuildEntityObjectProperties field of TryJoinGuildResultMessage. |
oldEssenceBalance |
integer | yes | Int32 field of TryJoinGuildResultMessage. |
newEssenceBalance |
integer | yes | Int32 field of TryJoinGuildResultMessage. |
senderDisplayName |
string | yes | String field of TryJoinGuildResultMessage. |
alreadyHasGroup |
bool | yes | Boolean field of TryJoinGuildResultMessage. |
showWelcomePopup |
bool | yes | Boolean field of TryJoinGuildResultMessage. |
Server message UnitKeyframesBatchMessage (subject 0), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
keyframes |
object | no | BlockingQueue of UnitKeyframeMessage field of UnitKeyframesBatchMessage. |
keyframesList |
list | no | IList of UnitKeyframeMessage field of UnitKeyframesBatchMessage. |
batchNumber |
integer | yes | Int32 field of UnitKeyframesBatchMessage. |
Server message UnitKilledEventMessage (subject 39), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UnitKilledEventMessage. |
unit |
integer | yes | Int16 field of UnitKilledEventMessage. |
killer |
integer | yes | Int16 field of UnitKilledEventMessage. |
bounty |
integer | yes | Int32 field of UnitKilledEventMessage. |
bountyReceiver |
integer | yes | UInt16 field of UnitKilledEventMessage. |
Server message UnitSpecialEffectBatchMessage (subject 4), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
keyframes |
object | no | BlockingQueue of UnitSpecialEffectMessage field of UnitSpecialEffectBatchMessage. |
keyframesList |
list | no | IList of UnitSpecialEffectMessage field of UnitSpecialEffectBatchMessage. |
Server message UpdateAutopauseTimerMessage (subject 193), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
disconnectedPlayers |
list | no | List of UInt16 field of UpdateAutopauseTimerMessage. |
secondsRemaining |
integer | yes | Int32 field of UpdateAutopauseTimerMessage. |
canSkip |
bool | yes | Boolean field of UpdateAutopauseTimerMessage. |
Server message UpdateBuildCursorMessage (subject 208), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
sourcePlayer |
integer | yes | UInt16 field of UpdateBuildCursorMessage. |
shortUnitType |
integer | yes | UInt16 field of UpdateBuildCursorMessage. |
point |
object | no | Point field of UpdateBuildCursorMessage. |
Server message UpdateChatTimelineMessage (subject 32), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
timestamp |
integer | yes | Int64 field of UpdateChatTimelineMessage. |
player |
integer | yes | UInt16 field of UpdateChatTimelineMessage. |
message |
string | yes | String field of UpdateChatTimelineMessage. |
allChat |
bool | yes | Boolean field of UpdateChatTimelineMessage. |
messageType |
enum | yes | ChatMessageType field of UpdateChatTimelineMessage. One of: Standard, Affirmative, Unsure, Alert, StandardLong, Party, Whisper, System, Discord, Guild, GuildNotice, ExpectingSend, ThinkingAboutSending. |
Server message UpdateCustomGameRoomSlotMessage (subject 83), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
slot |
integer | yes | UInt16 field of UpdateCustomGameRoomSlotMessage. |
controller |
string | yes | String field of UpdateCustomGameRoomSlotMessage. |
Server message UpdateKingStacksMessage (subject 162), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
triggeringPlayer |
integer | yes | UInt16 field of UpdateKingStacksMessage. |
Server message UpdateLoginQueuePositionMessage (subject 6), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
position |
integer | yes | Int32 field of UpdateLoginQueuePositionMessage. |
Server message UpdateModeVotingPlayersMessage (subject 211), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
readyPlayers |
list | no | List of UInt16 field of UpdateModeVotingPlayersMessage. |
Server message UpdatePlayerAfkStatusTimelineMessage (subject 19), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerAfkStatusTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerAfkStatusTimelineMessage. |
value |
bool | yes | Boolean field of UpdatePlayerAfkStatusTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerAfkStatusTimelineMessage. |
Server message UpdatePlayerAttackerPlayerTimelineMessage (subject 18), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerAttackerPlayerTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerAttackerPlayerTimelineMessage. |
value |
integer | yes | UInt16 field of UpdatePlayerAttackerPlayerTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerAttackerPlayerTimelineMessage. |
Server message UpdatePlayerConnectedTimelineMessage (subject 16), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerConnectedTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerConnectedTimelineMessage. |
value |
bool | yes | Boolean field of UpdatePlayerConnectedTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerConnectedTimelineMessage. |
Server message UpdatePlayerControllerTimelineMessage (subject 8), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerControllerTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerControllerTimelineMessage. |
value |
string | yes | String field of UpdatePlayerControllerTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerControllerTimelineMessage. |
Server message UpdatePlayerDefenderPlayerTimelineMessage (subject 17), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerDefenderPlayerTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerDefenderPlayerTimelineMessage. |
value |
integer | yes | UInt16 field of UpdatePlayerDefenderPlayerTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerDefenderPlayerTimelineMessage. |
Server message UpdatePlayerDualBuildingMessage (subject 129), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerDualBuildingMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerDualBuildingMessage. |
value |
bool | yes | Boolean field of UpdatePlayerDualBuildingMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerDualBuildingMessage. |
Server message UpdatePlayerExtraRecommendedValueMessage (subject 135), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerExtraRecommendedValueMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerExtraRecommendedValueMessage. |
value |
integer | yes | Int32 field of UpdatePlayerExtraRecommendedValueMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerExtraRecommendedValueMessage. |
Server message UpdatePlayerFoodCapTimelineMessage (subject 12), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerFoodCapTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerFoodCapTimelineMessage. |
value |
integer | yes | Int32 field of UpdatePlayerFoodCapTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerFoodCapTimelineMessage. |
Server message UpdatePlayerFoodUsedTimelineMessage (subject 11), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerFoodUsedTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerFoodUsedTimelineMessage. |
value |
integer | yes | Int32 field of UpdatePlayerFoodUsedTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerFoodUsedTimelineMessage. |
Server message UpdatePlayerGoldTimelineMessage (subject 9), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerGoldTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerGoldTimelineMessage. |
value |
integer | yes | Int32 field of UpdatePlayerGoldTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerGoldTimelineMessage. |
Server message UpdatePlayerImageTimelineMessage (subject 7), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerImageTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerImageTimelineMessage. |
value |
string | yes | String field of UpdatePlayerImageTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerImageTimelineMessage. |
Server message UpdatePlayerIncomeTimelineMessage (subject 13), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerIncomeTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerIncomeTimelineMessage. |
value |
integer | yes | Int32 field of UpdatePlayerIncomeTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerIncomeTimelineMessage. |
Server message UpdatePlayerLaneSkinMessage (subject 234), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable; cosmetic (local servers only).
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of UpdatePlayerLaneSkinMessage. |
modId |
string | yes | String field of UpdatePlayerLaneSkinMessage. |
Server message UpdatePlayerLeakedPercentOnWaveMessage (subject 31), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
player |
integer | yes | UInt16 field of UpdatePlayerLeakedPercentOnWaveMessage. |
waveNumber |
integer | yes | Int32 field of UpdatePlayerLeakedPercentOnWaveMessage. |
percent |
float | yes | Single field of UpdatePlayerLeakedPercentOnWaveMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerLeakedPercentOnWaveMessage. |
Server message UpdatePlayerLegionUnitTypeMessage (subject 147), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerLegionUnitTypeMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerLegionUnitTypeMessage. |
value |
string | yes | String field of UpdatePlayerLegionUnitTypeMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerLegionUnitTypeMessage. |
Server message UpdatePlayerMythiumGatherRateMessage (subject 28), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerMythiumGatherRateMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerMythiumGatherRateMessage. |
value |
float | yes | Single field of UpdatePlayerMythiumGatherRateMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerMythiumGatherRateMessage. |
Server message UpdatePlayerMythiumTimelineMessage (subject 10), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerMythiumTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerMythiumTimelineMessage. |
value |
integer | yes | Int32 field of UpdatePlayerMythiumTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerMythiumTimelineMessage. |
Server message UpdatePlayerNameTimelineMessage (subject 6), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerNameTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerNameTimelineMessage. |
value |
string | yes | String field of UpdatePlayerNameTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerNameTimelineMessage. |
Server message UpdatePlayerPartyMembersTimelineMessage (subject 156), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerPartyMembersTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerPartyMembersTimelineMessage. |
value |
list | no | List of String field of UpdatePlayerPartyMembersTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerPartyMembersTimelineMessage. |
Server message UpdatePlayerPowerupChoicesTimelineMessage (subject 20), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerPowerupChoicesTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerPowerupChoicesTimelineMessage. |
value |
list | no | List of String field of UpdatePlayerPowerupChoicesTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerPowerupChoicesTimelineMessage. |
Server message UpdatePlayerPowerupSelectedTimelineMessage (subject 21), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerPowerupSelectedTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerPowerupSelectedTimelineMessage. |
value |
string | yes | String field of UpdatePlayerPowerupSelectedTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerPowerupSelectedTimelineMessage. |
Server message UpdatePlayerRollsTimelineMessage (subject 29), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerRollsTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerRollsTimelineMessage. |
value |
list | no | List of String field of UpdatePlayerRollsTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerRollsTimelineMessage. |
Server message UpdatePlayerTotalEnemyTeamGoldFromYourLeaksMessage (subject 26), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerTotalEnemyTeamGoldFromYourLeaksMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerTotalEnemyTeamGoldFromYourLeaksMessage. |
value |
integer | yes | Int32 field of UpdatePlayerTotalEnemyTeamGoldFromYourLeaksMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerTotalEnemyTeamGoldFromYourLeaksMessage. |
Server message UpdatePlayerTotalGoldFromCatchingLeaksMessage (subject 27), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerTotalGoldFromCatchingLeaksMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerTotalGoldFromCatchingLeaksMessage. |
value |
integer | yes | Int32 field of UpdatePlayerTotalGoldFromCatchingLeaksMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerTotalGoldFromCatchingLeaksMessage. |
Server message UpdatePlayerTotalGoldFromEnemyLeaksMessage (subject 24), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerTotalGoldFromEnemyLeaksMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerTotalGoldFromEnemyLeaksMessage. |
value |
integer | yes | Int32 field of UpdatePlayerTotalGoldFromEnemyLeaksMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerTotalGoldFromEnemyLeaksMessage. |
Server message UpdatePlayerTotalGoldFromIncomeMessage (subject 23), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerTotalGoldFromIncomeMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerTotalGoldFromIncomeMessage. |
value |
integer | yes | Int32 field of UpdatePlayerTotalGoldFromIncomeMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerTotalGoldFromIncomeMessage. |
Server message UpdatePlayerTotalGoldLostToLeaksMessage (subject 25), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerTotalGoldLostToLeaksMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerTotalGoldLostToLeaksMessage. |
value |
integer | yes | Int32 field of UpdatePlayerTotalGoldLostToLeaksMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerTotalGoldLostToLeaksMessage. |
Server message UpdatePlayerTotalMythiumTimelineMessage (subject 30), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerTotalMythiumTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerTotalMythiumTimelineMessage. |
value |
integer | yes | Int32 field of UpdatePlayerTotalMythiumTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerTotalMythiumTimelineMessage. |
Server message UpdatePlayerValueTimelineMessage (subject 14), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerValueTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerValueTimelineMessage. |
value |
integer | yes | Int32 field of UpdatePlayerValueTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerValueTimelineMessage. |
Server message UpdatePlayerWorkersTimelineMessage (subject 15), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatePlayerWorkersTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatePlayerWorkersTimelineMessage. |
value |
float | yes | Single field of UpdatePlayerWorkersTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatePlayerWorkersTimelineMessage. |
Server message UpdateReadyPlayersMessage (subject 149), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
active |
bool | yes | Boolean field of UpdateReadyPlayersMessage. |
message |
string | yes | String field of UpdateReadyPlayersMessage. |
readyPlayers |
integer | yes | Int32 field of UpdateReadyPlayersMessage. |
totalPlayers |
integer | yes | Int32 field of UpdateReadyPlayersMessage. |
Server message UpdateResearchLevelMessage (subject 34), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
researchType |
string | yes | String field of UpdateResearchLevelMessage. |
level |
integer | yes | Int32 field of UpdateResearchLevelMessage. |
Server message UpdateSquareOccupyTimelineMessage (subject 33), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdateSquareOccupyTimelineMessage. |
player |
integer | yes | UInt16 field of UpdateSquareOccupyTimelineMessage. |
constructionInfo |
object | no | ConstructionInfo field of UpdateSquareOccupyTimelineMessage. |
Server message UpdateTowerScoreboardMessage (subject 136), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdateTowerScoreboardMessage. |
player |
integer | yes | UInt16 field of UpdateTowerScoreboardMessage. |
constructionInfos |
list | no | ConstructionInfo[] field of UpdateTowerScoreboardMessage. |
Server message UpdatedPlayerMutedTimelineMessage (subject 22), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
tick |
integer | yes | Int64 field of UpdatedPlayerMutedTimelineMessage. |
player |
integer | yes | UInt16 field of UpdatedPlayerMutedTimelineMessage. |
value |
bool | yes | Boolean field of UpdatedPlayerMutedTimelineMessage. |
messageNumber |
integer | yes | Int32 field of UpdatedPlayerMutedTimelineMessage. |
Server message UsedQueuedKingUpgradeMessage (subject 216), after decoding and before the game handles it. Cancel to hide it from the client.
Before and after the game acts (pre=True for before); cancellable.
| Field | Type | Editable | Notes |
|---|---|---|---|
wave |
integer | yes | Int32 field of UsedQueuedKingUpgradeMessage. |
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