Skip to content

Game Packets

krssrb edited this page Apr 19, 2020 · 12 revisions

Game packets are sent and received inside Protocol Packets, namely:

  • CallMethodMessage: Server to client comunication
  • CallServerMethodMessage: Client to server communication

The packets contain a marshalled python object: a tuple with the actual data inside that.

Packet groups by usage

Packet groups
Character Selection
Entering the world

Packet groups by origin

AuctionHouse Packets
Clan Packets
Client Packets
Communicator Packets
MapState Packets
MissionLog Packets
Party Packets
Petition Packets
PhysicalEntity Packets
Prestige Packets
Social Packets
Team Packets

Character selection

<< Back to Packet groups by usage

  • The character selection if the first step in logging in to the game, after the client authenticated itself.
Packets
BeginCharacterSelection
CharacterCreateSuccess
CharacterDeleteSuccess
CharacterInfo
CreatePhysicalEntity
DeleteCharacterFailed
GeneratedCharacterName
GeneratedFamilyName
UserCreationFailed

Entering the world

<< Back to Packet groups by usage

  • These packets are responsible to enter the selected character into the world.
Packets
PreWonkavate
SetIsGM
Wonkavate

AuctionHouse Packets

<< Back to Packet groups by origin

  • These packets are used in AuctionHouse
  • total 12 packet's
Packets
AuctionBuyoutFailed
AuctionBuyoutSuccess
AuctionCreationFailed
AuctionCreationSuccess
AuctionExpired
AuctionSold
AuctionStatusFailed
AuctionStatusSuccess
CancelAuctionFailed
CancelAuctionSuccess
QueryFailed
QuerySuccess

AuctionBuyoutFailed

AuctionBuyoutFailed is AuctionHuose Packet

  • Inform the client that auction buyout faild for some reason.
AuctionBuyoutFailed(itemId, playerMessageId)
Field name Type Description
itemId int Id of auctioned item.
playerMessageId int Id of client message.

AuctionBuyoutSuccess

AuctionBuyoutFailed is AuctionHuose Packet

  • Inform the client that auction buyout was successful.
AuctionBuyoutSuccess(itemId)
Field name Type Description
itemId int Id of auctioned item.

AuctionCreationFailed

AuctionBuyoutFailed is AuctionHuose Packet

  • Inform the client that auction creation was faild for some reason.
AuctionCreationFailed(itemId, playerMessageId)
Field name Type Description
itemId int Id of auctioned item.
playerMessageId int Id of client message.

AuctionCreationSuccess(itemId)

AuctionBuyoutFailed is AuctionHuose Packet

  • Inform the client that auction creation was successful.
AuctionCreationSuccess(itemId)
Field name Type Description
itemId int Id of auctioned item.

AuctionExpired

AuctionExpired is AuctionHuose Packet

  • Inform the client that auction expired.
AuctionExpired(itemId)
Field name Type Description
itemId int Id of auctioned item.

AuctionSold

AuctionSold is AuctionHuose Packet

  • Inform the client that auctioned item was sold.
AuctionSold(itemId, price)
Field name Type Description
itemId int Id of auctioned item.
price int Amount of money client will recive.

AuctionStatusFailed

AuctionStatusFailed is AuctionHuose Packet

  • Inform the client that auctioned item was sold.

  • note: This methos is emtpy on client side, so we dont need to use it.

AuctionStatusFailed(playerMessageId)
Field name Type Description
playerMessageId int Id of player message.

AuctionStatusSuccess

AuctionStatusSuccess is AuctionHuose Packet

  • Inform the client that item or item's was successfuly auctioneted.
AuctionStatusSuccess(itemList)
Field name Type Description
itemList ToDo Unknown.

CancelAuctionFailed

CancelAuctionFailed is AuctionHuose Packet

  • Inform the client that auction of auctioned item faild to be canceled for some reason.
CancelAuctionFailed(itemId, playerMessageId)
Field name Type Description
itemId int Id of auctioned item.
playerMessageId int Id of client message.

CancelAuctionSuccess

CancelAuctionSuccess is AuctionHuose Packet

  • Inform the client that auction of auctioned item was canceled successful.
CancelAuctionSuccess(itemId)
Field name Type Description
itemId int Id of auctioned item.

QueryFailed

QueryFailed is AuctionHuose Packet

  • Inform the client that search for auctioned items faild for some reason.
QueryFailed(playerMessageId)
Field name Type Description
playerMessageId int Id of client message.

QuerySuccess

QuerySuccess is AuctionHuose Packet

  • Inform the client that search for auctioned items was successful.
QuerySuccess(dataList)
Field name Type Description
dataList ToDo Unknown.

Clan Packets

<< Back to Packet groups by origin

  • These packets are used in clan manager.
Packets
ClanCreated
ClanDeleted
ClanDisbanded
ClanMembersRosterBegin
ClanMembersRosterEnd
DisplayClanLeaderInfo
DisplayClanMemberInfo
DisplayClanMemberInfoHeader
DisplayClanMessage
GetPvPClanStatus
InviteToClan
PlayerJoinedClan
PlayerLeftClan
SetClanData
SetClanMemberData

ClanCreated

ClanCreated is Clan Packet

  • Inform the client that new clan is created, and client set the default rank titles for a clan.
ClanCreated(clanId)
Field name Type Description
clanId int Unique id genereted by DB after new clan is inserted.

ClanDeleted

ClanDeleted is <Clan Packet

  • Inform the client that clan is disbanded and does not inform players.
ClanDeleted(clanId)
Field name Type Description
clanId int Unique id genereted by DB after new clan is inserted.

ClanDisbanded

ClanDisbanded is Clan Packet

  • Inform the client that clan is disbanded, shows a message in the players chat and updates the clan UI
ClanDisbanded(clanId)
Field name Type Description
clanId int Unique id genereted by DB after new clan is inserted.

ClanMembersRosterBegin

ClanMembersRosterBegin is Clan Packet

  • Inform the client that clan members roster started, and client wait for SetClanMemberData for every clan member. After packets are sended for every clan member we call ClanMembersRosterEnd packet
ClanMembersRosterBegin(clanId)
Field name Type Description
clanId int Unique id genereted by DB after new clan is inserted.

ClanMembersRosterEnd

ClanMembersRosterEnd is Clan Packet

  • Inform the client that SetClanMemberData is sent for every clan member and end the list.
ClanMembersRosterEnd(clanId)
Field name Type Description
clanId int Unique id genereted by DB after new clan is inserted.

DisplayClanLeaderInfo

DisplayClanLeaderInfo is Clan Packet

  • Inform the client to set data about clan leader
DisplayClanLeaderInfo(clanName, sname, sdata)
Field name Type Description
clanName string Name of the clan
sname string Name of the clan leader
sdata structure ClanMemberData

DisplayClanMemberInfo

DisplayClanMemberInfo is Clan Packet

  • Inform the client to set data about clan member.
DisplayClanMemberInfo(clanName, sname, sdata)
Field name Type Description
clanName string Name of the clan
sname string Name of the clan leader
sdata structure ClanMemberData

DisplayClanMemberInfoHeader

DisplayClanMemberInfoHeader is Clan Packet

  • Inform the client to send chat message about user clan name and id
DisplayClanMemberInfoHeader(clanName, clanId)
Field name Type Description
clanName string Name of the clan
clanId int Unique id genereted by DB after new clan is inserted.

DisplayClanMessage

DisplayClanMessage is Clan Packet

  • Inform the client to send chat message about user clan name and id
DisplayClanMessage(DisplayClanMessage(msgId, args)
Field name Type Description
msgId int Player mesaage id
args dictionary< string, string> Dictionary of string key value pair

GetPvPClanStatus

GetPvPClanStatus is Clan Packet

  • Inform the client how much time has passed since player left last pvp clan.
GetPvPClanStatus(pvpClanName, pvpTimeoutSeconds)
Field name Type Description
pvpClanName string Clan name
pvpTimeoutSeconds int Time since player left last pvp clan till now.

InviteToClan

InviteToClan is Clan Packet

  • Inform the client that player is invited to new clan.
InviteToClan(sname, sdata)
Field name Type Description
sname string Clan name
sdata ClanInviteData ClanInviteData structure
ClanInviteData
ClanInviteData(inviterFamilyName, clanId, clanName, isPvP, invitedCharacterId)
Field name Type Description
inviterFamilyName string Family name of inviter
clanId int Unique id genereted by DB after new clan is inserted
clanName string Name of clan player is invited to.
isPvP bool PvP status of clan player is invited to.
invitedCharacterId int CharaterId of invited player.

PlayerJoinedClan

PlayerJoinedClan is Clan Packet

  • Inform the client that player joined clan.
PlayerJoinedClan(sname, sdata)
Field name Type Description
sname string Clan name
sdata ClanMemberData ClanMemberData structure

PlayerLeftClan

PlayerLeftClan is Clan Packet

  • Inform the client that player left clan or was kicked from clan.
PlayerLeftClan(characterId, firstName, lastName, clanId, wasKicked)
Field name Type Description
characterId int CharacterId of player
firstName string Player name.
lastName string Player family name.
clanId int Unique id genereted by DB after new clan is inserted.
wasKicked bool Was player kicked of he left guild.

SetClanData

SetClanData is Clan Packet

  • Inform the client about data releate to clan.
SetClanData(sname, sdata)
Field name Type Description
sname string CharacterId of player
sdata ClanData ClanData structure.
ClanData
SetClanData(clanId, clanName, isPvP, rankTitles)
Field name Type Description
clanId id Unique id genereted by DB after new clan is inserted
clanName string Clan name.
isPvP bool Is clan PvP or not.
RankTitles dictionary< int, string> Client suport 4 guild ranks. RankTitles is dictionary of key = int (0,1,2,3) and value = string (custom made string as name of rank)

SetClanMemberData

SetClanMemberData is Clan Packet

  • Inform the client about data releate to clan member.
SetClanMemberData(sname, sdata)
Field name Type Description
sname string CharacterId of player
sdata ClanMemberData ClanMemberData structure.
ClanMemberData
ClanMemberData(userId, characterId, characterName, familyName, clanId, level, contextId, rank, isOnline, isAfk, note)
Field name Type Description
userId int The account id of the user.
characterId int Is player unique id
characterName string Name of clan member
familyName string The family name that is associated with the account.
clanId int Unique id genereted by DB after new clan is inserted.
level int Current player level.
contextId int Id of map where player is at the moment.
rank int Current player rank in clan.
isOnline bool Player online status.
isAfk bool Is player actice of AFK
note string Short note about player.

Client Packets

<< Back to Packet groups by origin

  • These packets are client methods
Packets
AckPing
BeginCharacterSelection
BeginTeleport
CharacterCreateSuccess
CharacterDeleteSuccess
CharacterOptions
ChooseInstanceList
CreatePhysicalEntity
CustomizationChoices
DeleteCharacterFailed
DestroyPhysicalEntity
DevRQSWindow
DevStartMapAck
DisplayDestinationContextNotification
DisplayMapErrors
DisplayPlayerNotification
DisplayPlayerTutorialNotification
DisplaySystemMessage
EnableDevCommands
EnteredWaypoint
ExitedWaypoint
FatalError
GeneratedCharacterName
GeneratedFamilyName
GmGotoMapAck
GmGotoStartGroupAck
GmKillMapAck
GmShowUserMissionsAck
GotLoot
InventoryDisabled
LogoutTimeRemaining
NonFatalError
Notification
PlayTutorialAudio
PreWonkavate
QAGiveMissionAck
RequestMovementBlock
ReviveRequestInfo
RunCameraScript
SalaryPaid
ServerCollisionData
ServerPerformanceMetrics
SetControlledActorId
SetCurrentContextId
SetIsContextOwner
SetIsGm
SetKillStreak
StartTrackingScriptableClientEvent
StopTrackingScriptableClientEvent
UnrequestMovementBlock
UpdatePhysicalEntity
UserCreationFailed
UserOptions

AckPing

AckPing is Client Packet

  • Measures ping between client and server
AckPing(clientTime)
Field name Type Description
clientTime double Current time.

BeginCharacterSelection

BeginCharacterSelection is Client Packet and used in Character Selection

  • Transitions the client to the character selection screen after authentication.
BeginCharacterSelection(familyName, hasCharacters, userId, raceList, canSkipBootcamp)
Field name Type Description
familyName string The family name that is associated with the account.
hasCharacters bool True, if there are characters already for this account.
userId int The account id of the user.
enabledRaces list< int> The ids of the races that are enabled, so characters can be created with those races.
[setup guide](Game-DB-Tables#dev-copiable-empty-table-for-database) bool The bootcamp can be skipped.

BeginTeleport

BeginTeleport is Client Packet

  • Inform the client that character teleportation sequence is started
BeginTeleport()
BeginTeleport have 0 arguments

CharacterCreateSuccess

CharacterCreateSuccess is Client Packet and used in Character Selection

  • Confirm that character was created successfully
CharacterCreateSuccess(slotNum, familyName)
Field name Type Description
slotNum int Slot Id where character is.
familyName string The family name that is associated with the account.

CharacterDeleteSuccess

CharacterDeleteSuccess is Client Packet and used in Character Selection

  • Inform the client does account still have character's or not
CharacterDeleteSuccess(hasCharacters)
Field name Type Description
hasCharacters bool False if last charater is deleted, else true.

CharacterOptions

CharacterOptions is Client Packet

  • Inform the client about character saved options
CharacterOptions(optionsList)
Field name Type Description
optionsList list< options> List of option structure
Options
Option(optionId, unicodeValueString)
Field name Type Description
optionId int Id of option.
unicodeValueString string Option value.

ChooseInstanceList

ChooseInstanceList is Client Packet

  • Inform the client about available instances
ChooseInstanceList(instances)
Field name Type Description
instances list< int> List of instances id's.

CreatePhysicalEntity

CreatePhysicalEntity is Client Packet and used in Character Selection

  • Informs the client to create a physical entity using the given information. The entityId and classId parameters are required for the client entity manager's CreateEntity method. The entityData parameter is a list of tuples of the form (methodName, methodArgs). The methodName is transformed into Recv_ + methodName before calling it on the entity.
CreatePhysicalEntity(entityId, classId, entityData)
Field name Type Description
entityId ulong Unique Id generated by server for every entity in game.
classId int Id of entity class.
entityData list< EntityData> List of entityData structure's. These packets will be called on the newly created entity. It behaves the same as if we've sent them separately. Order matters
EntityData
EntityData(methodId, packet)
Field name Type Description
methodId int Id of method we wana call.
packet PythonPacket Precreated python packet.

CustomizationChoices

CustomizationChoices is Client Packet

  • info ToDo
CustomizationChoices(entityId, choices)
Field name Type Description
entityId ulong Unique id generated by server for every entity in game.
choices ToDo Unknown

DeleteCharacterFailed

DeleteCharacterFailed is Client Packet and used in Character Selection

  • info ToDo
DeleteCharacterFailed()
0 arguments

DestroyPhysicalEntity

DestroyPhysicalEntity is Client Packet

  • info ToDo
DestroyPhysicalEntity(entityId)
Field name Type Description
entityId ulong Unique id generated by server for every entity in game.

DevRQSWindow

DevRQSWindow is Client Packet

  • info ToDo
DevRQSWindow()
0 arguments

DevStartMapAck

DevStartMapAck is Client Packet

  • info ToDo
DevStartMapAck(contextIdList)
Field name Type Description
contextIdList list< int> List of available mapContextId's.

DisplayDestinationContextNotification

DisplayDestinationContextNotification is Client Packet

  • info ToDo
DisplayDestinationContextNotification(contextId)
Field name Type Description
contextId int Id of destination mapContext

DisplayMapErrors

DisplayMapErrors is Client Packet

  • info ToDo
DisplayMapErrors(errorList)
Field name Type Description
errorList list< string> ToDo

DisplayPlayerNotification

DisplayPlayerNotification is Client Packet

  • info ToDo
DisplayPlayerNotification(notificationTypeId, msgId, args = { })
Field name Type Description
notificationTypeId int ToDo
msgId int ToDo
args dictionary< string, string> ToDo

DisplayPlayerTutorialNotification

DisplayPlayerTutorialNotification is Client Packet

  • info ToDo
DisplayPlayerTutorialNotification(tutorialId)
Field name Type Description
tutorialId int ToDo

DisplaySystemMessage

DisplaySystemMessage is Client Packet

  • info ToDo
DisplaySystemMessage(msgId, args = { }, filterId = _clientmessagefilter.SYSTEM_GENERAL))
Field name Type Description
msgId int ToDo
args dictionary< string, string> ToDo
filterId int ToDo

EnableDevCommands

EnableDevCommands is Client Packet

  • info ToDo
EnableDevCommands()
0 arguments

EnteredWaypoint

EnteredWaypoint is Client Packet

  • info ToDo
EnteredWaypoint(currentMapId, gameContextId, mapWaypointInfoList, tempWormholes, waypointTypeId, currentWaypointId = None)
Field name Type Description
currentMapId int ToDo
gameContextId int ToDo
mapWaypointInfoList list< MapWaypointInfo> ToDo
tempWormholes list< TempWormholes> ToDo
waypointTypeId int ToDo
currentWaypointId int ToDo
MapWaypointInfo
MapWaypointInfo(gameContextId, mapInstanceList, waypoints)
Field name Type Description
gameContextId int ToDo
mapInstanceList list< int> ToDo
waypoints list< Waypoints> ToDo
TempWormholes
TempWormholes(wormholeId, pos, ownername)
Field name Type Description
wormholeId int ToDo
pos structure Pos
ownername string ToDo
Waypoints
Waypoints(waypointId, pos, contested)
Field name Type Description
waypointId int ToDo
pos structure Pos
contested unknown ToDo: it's bool probobly
Pos
Pos(x, y, z)
Field name Type Description
x float X coordination
y float Y coordination
z float Z coordination

ExitedWaypoint

ExitedWaypoint is Client Packet

  • info ToDo
ExitedWaypoint()
0 arguments.

FatalError

FatalError is Client Packet

  • info ToDo
FatalError(msgId, args = { })
Field name Type Description
msgId int ToDo
args dictionary< string, string> ToDo

GeneratedCharacterName

GeneratedCharacterName is Client Packet and used in Character Selection

  • info ToDo
GeneratedCharacterName(name)
Field name Type Description
name string ToDo

GeneratedFamilyName

GeneratedFamilyName is Client Packet and used in Character Selection

  • info ToDo
GeneratedFamilyName(name)
Field name Type Description
name string ToDo

GmGotoMapAck

GmGotoMapAck is Client Packet

  • info ToDo
GmGotoMapAck(mapList)
Field name Type Description
mapList list< int> ToDo

GmGotoStartGroupAck

GmGotoStartGroupAck is Client Packet

  • info ToDo
GmGotoStartGroupAck(startGroups)
Field name Type Description
startGroups unknown ToDo

GmKillMapAck

GmKillMapAck is Client Packet

  • info ToDo
GmKillMapAck(mapList)
Field name Type Description
mapList list< int> ToDo

GmShowUserMissionsAck

GmShowUserMissionsAck is Client Packet

  • info ToDo
GmShowUserMissionsAck(userId, displayName, missionInfo)
Field name Type Description
userId int ToDo
displayName string ToDo
missionInfo dictionary< int, structure> MissionInfo{missionid, missionInfo}

GotLoot

GotLoot is Client Packet

  • info ToDo
GotLoot(creatureEntityId, entityClassIdList, moneyAmount, creditType = _credittype.FUND)
Field name Type Description
creatureEntityId ulong ToDo
entityClassIdList unknown ToDo
moneyAmount unknown ToDo
creditType unknown ToDo

InventoryDisabled

InventoryDisabled is Client Packet

  • info ToDo
InventoryDisabled(bDisabled)
Field name Type Description
bDisabled bool ToDo

LogoutTimeRemaining

LogoutTimeRemaining is Client Packet

  • info ToDo
LogoutTimeRemaining(timeRemaining)
Field name Type Description
timeRemaining unknown ToDo

NonFatalError

NonFatalError is Client Packet

  • info ToDo
NonFatalError(msgId, args = { })
Field name Type Description
msgId int ToDo
args dictionary< string, string> ToDo

Notification

Notification is Client Packet

  • info ToDo
Notification(notificationId, notificationArgs)
Field name Type notificationId
notificationId int ToDo
notificationArgs unknown ToDO: could be dictionary< string, string>

PlayTutorialAudio

PlayTutorialAudio is Client Packet

  • info ToDo
PlayTutorialAudio(audioSetId)
Field name Type notificationId
audioSetId int ToDo

PreWonkavate

PreWonkavate is Client Packet and used in Entering the world

  • PreWonkavatePacket initialize loading screen

  • note: Client doesn't use wonkType, so we send 0 insted.

PreWonkavate(wonkType)
Field name Type Description
wonkType int Not used.

QAGiveMissionAck

QAGiveMissionAck is Client Packet

  • info ToDo
QAGiveMissionAck(missionList)
Field name Type Description
missionList list< int> Not used.

RequestMovementBlock

RequestMovementBlock is Client Packet

  • info ToDo
RequestMovementBlock()
0 arguments

ReviveRequestInfo

ReviveRequestInfo is Client Packet

  • info ToDo
ReviveRequestInfo(reviveInfoTuple)
Field name Type Description
reviveInfoTuple unknown ToDo

RunCameraScript

RunCameraScript is Client Packet

  • info ToDo
RunCameraScript(scriptId
Field name Type Description
scriptId int ToDo

SalaryPaid

SalaryPaid is Client Packet

  • info ToDo
SalaryPaid(salaryAmount)
Field name Type Description
salaryAmount int ToDo

ServerCollisionData

ServerCollisionData is Client Packet

  • info ToDo
ServerCollisionData(collisionData)
Field name Type Description
collisionData list< collisionData> ToDo
CollisionData
CollisionData(entityId, skeletonData, stateData)
Field name Type Description
entityId ulong ToDo
skeletonData unknown ToDo
stateData unknown ToDo

ServerPerformanceMetrics

ServerPerformanceMetrics is Client Packet

  • info ToDo
ServerPerformanceMetrics(avgLoopsPerSecond, peakLoopMs)
Field name Type Description
avgLoopsPerSecond unknown ToDo
peakLoopMs unknown ToDo

SetControlledActorId

SetControlledActorId is Client Packet

  • info ToDo
SetControlledActorId(actorId)
Field name Type Description
actorId ulong ToDo

SetCurrentContextId

SetCurrentContextId is Client Packet

  • info ToDo
SetCurrentContextId(contextId)
Field name Type Description
contextId int ToDo

SetIsContextOwner

SetIsContextOwner is Client Packet

  • info ToDo
SetIsContextOwner(isOwner)
Field name Type Description
isOwner int ToDo

SetIsGM

SetIsGM is Client Packet

  • info ToDo
SetIsGM(isGM)
Field name Type Description
isGM bool ??? or int ToDo

SetKillStreak

SetKillStreak is Client Packet

  • info ToDo
SetKillStreak(count)
Field name Type Description
count int ToDo

StartTrackingScriptableClientEvent

StartTrackingScriptableClientEvent is Client Packet

  • info ToDo
StartTrackingScriptableClientEvent(eventId)
Field name Type Description
eventId int ToDo

StopTrackingScriptableClientEvent

StopTrackingScriptableClientEvent is Client Packet

  • info ToDo
StopTrackingScriptableClientEvent(eventId)
Field name Type Description
eventId int ToDo

UnrequestMovementBlock

UnrequestMovementBlock is Client Packet

  • info ToDo
UnrequestMovementBlock()
0 arguments()

UpdatePhysicalEntity

UpdatePhysicalEntity is Client Packet

  • info ToDo
UpdatePhysicalEntity(entityId, entityData)
entityId ulong Unique Id generated by server for every entity in game.
entityData list< EntityData> List of entityData structure's. These packets will be called on the newly created entity. It behaves the same as if we've sent them separately. Order matters

UserCreationFailed

UserCreationFailed is Client Packet and used in Character Selection

  • info ToDo
UserCreationFailed(errorCode)
Field name Type Description
errorCode int ToDo

UserOptions

UserOptions is Client Packet

  • info ToDo
UserOptions(optionsList)
Field name Type Description
optionsList list< options> List of option structure

Communicator packets

<< Back to Packet groups by origin

  • The communicator is that part of the client in charge of the chat messages.
Packets
AddFriendAck
AddIgnoreAck
AdminMessage
ChannelChat
ChatChannelJoined
ChatChannelLeft
ClanChat
ClanLeadersChat
DisplayClientMessage
Emote
FriendList
IgnoreList
LoginOk
PartyChat
PlayerCountAck
PlayerLogin
PlayerLogout
PreviewMOTD
RadialChat
RemoveFriendAck
RemoveIgnoreAck
SendMOTD
Shout
SystemMessage
Whisper
WhisperAck
WhisperFailAck
WhisperSelf
WhoAck
WhoFailAck

AddFriendAck

AddFriendAck is Communicator Packet

  • Informs the client that new friend added successfuly or not
AddFriendAck(friendName, success)
Field name Type Description
friendName string Name of new friend
success bool Add friend true or false

AdminMessage

AdminMessage is Communicator Packet

  • Send mesage to client with "ADMIN MESSAGE" prefix.
  • Different filterId send message to different cannels and in different color's.
AdminMessage(msg, filterId)
Field name Type Description
msg string Text message from user.
filterId int Id of message filter.

ChannelChat

ChannelChat is Communicator Packet

  • ChannelChat is used for both "client to server" and "server to client" communication.
  • ChannelChat packet send message to specific channel (general, trade , LFG , etc)
ChannelChat(sender, channelInfo, msg)
Field name Type Description
sender string Player name.
channelInfo ChannelInfo ChannelInfo is structure.
filterId int Id of message filter.
ChannelInfo
ChannelInfo(channelId, mapEntityId, mapContextId)
Field name Type Description
channelId int Id of channel where message is sent
mapEntityId int Id of player who is sending message.
mapContextId int Id of map.

ChatChannelJoined

ChatChannelJoined is Communicator Packet

  • info ToDo
ChatChannelJoined(channelId, mapEntityId = None, gameContextId = None)
Field name Type Description
channelId int Id of chatChannel.
mapEntityId int Player entety id.
gameContextId int Id of message filter.

ChatChannelLeft

ChatChannelLeft is Communicator Packet

  • info ToDo

  • note: Client doesn't use mapEntityId and gameContextId, and they are set by default to none, so we can send only 1 argument.

ChatChannelLeft(channelId, mapEntityId = None, gameContextId = None)
Field name Type Description
channelId int Id of chatChannel.
mapEntityId int not used
gameContextId int not used

MapState Packets

<< Back to Packet groups by origin

Packets
MapMarkerInfo
UpdateMapMarker

MapMarkerInfo

MapMarkerInfo is MapState Packet

  • info ToDo
MapMarkerInfo(mapMarkers)
Field name Type Description
mapMarkers unknown ToDo

UpdateMapMarker

UpdateMapMarker is MapState Packet

  • info ToDo
UpdateMapMarker(channelId, mapEntityId = None, gameContextId = None)
Field name Type Description
channelId int Id of chatChannel.
mapEntityId int Player entety id.
gameContextId int Id of message filter.

MissionLog Packets

<< Back to Packet groups by origin

  • These packets are used in MissionLog
  • total 16 packet's
Packets
DispenseRadioMission
DispenseSharedMission
MissionCleared
MissionCompleteable
MissionCompleted
MissionDiscarded
MissionGained
MissionFailed
MissionRewarded
MissionStatusInfo
ObjectiveActivated
ObjectiveCompleted
ObjectiveFailed
ObjectiveRevealed
UpdateObjectiveCounter
UpdateObjectiveItemCounter

DispenseRadioMission

DispenseRadioMission(self, missionId, missionInfo, bForceDialog)
Field name Type Description
missionId int Mission Id.
missionInfo structure MissionInfo
bForceDialog int ToDo
MissionInfo
MissionInfo(missionStatus, bCompleteable, constantData, changeTime, objectiveList)
Field name Type Description
missionStatus unknown ToDo
bCompleteable bool ToDo
constantData unknown ToDo
changeTime unknown ToDo
objectiveList list< objective> ToDo
Objective
Objective(objectiveId, objectiveStatus, ordinal, timeRemaining, counterDict, itemCounters, isRequired, indicatorList)
Field name Type Description
objectiveId int ToDo
objectiveStatus unknown ToDo
ordinal unknown ToDo
timeRemaining unknown ToDo
counterDict unknown ToDo
itemCounters unknown ToDo
isRequired unknown ToDo
indicatorList unknown ToDo

DispenseSharedMission

DispenseSharedMission(self, actorId, missionId, missionInfo)
Field name Type Description
actorId ulong ToDo
missionId int Mission Id.
missionInfo structure MissionInfo

MissionCleared

MissionCleared(self, missionId)
Field name Type Description
missionId int Mission Id.

MissionCompleteable

MissionCompleteable(self, missionId, bCompleteable)
Field name Type Description
missionId int Mission Id.
bCompleteable bool ToDo

MissionCompleted

MissionCompleted(self, missionId)
Field name Type Description
missionId int Mission Id.

MissionDiscarded

MissionDiscarded(self, missionId)
Field name Type Description
missionId int Mission Id.

MissionGained

MissionGained(self, missionId, missionInfo)
Field name Type Description
missionId int Mission Id.
missionInfo structure MissionInfo

MissionFailed

MissionFailed(self, missionId)
Field name Type Description
missionId int Mission Id.

MissionRewarded

MissionRewarded(self, missionId)
Field name Type Description
missionId int Mission Id.

MissionStatusInfo

MissionStatusInfo(self, missionStatusDict)
Field name Type Description
missionId int Mission Id.
missionStatusDict unknown ToDo

ObjectiveActivated

ObjectiveActivated(self, missionId, objectiveId)
Field name Type Description
missionId int Mission Id.
objectiveId int Objective Id.

ObjectiveCompleted

ObjectiveCompleted(self, missionId, objectiveId)
Field name Type Description
missionId int Mission Id.
objectiveId int Objective Id.

ObjectiveFailed

ObjectiveFailed(self, missionId, objectiveId)
Field name Type Description
missionId int Mission Id.
objectiveId int Objective Id.

ObjectiveRevealed

ObjectiveRevealed(self, missionId, objectiveId, missionInfo)
Field name Type Description
missionId int Mission Id.
objectiveId int Objective Id.
missionInfo structure MissionInfo

UpdateObjectiveCounter

UpdateObjectiveCounter(self, missionId, objectiveId, counterId, counterVal, initialVal, targetVal)
Field name Type Description
missionId int Mission Id.
objectiveId int Objective Id.
counterid int ToDo
counterVal int ToDo
initialVal int ToDo
targetVal int ToDo

UpdateObjectiveItemCounter

UpdateObjectiveItemCounter(self, missionId, objectiveId, itemClassId, counterVal, targetVal)
Field name Type Description
missionId int Mission Id.
objectiveId int Objective Id.
itemClassId int ToDo
counterVal int ToDo
targetVal int ToDo

Party Packets

<< Back to Packet groups by origin

  • These packets are used in party manager
  • total 28 packet's
Packets
AddPartyMember
AddSquadMember
ChangePartyLootMethod
ChangePartyLootThreshold
DisplayPartyMessage
InvitedPlayerToParty
InviteSquadConfirmationRequest
InviteToParty
JoinSquadRequestReceived
JoinSquadRequestSent
PartyDisbanded
PartyMemberList
PartyMemberLoot
PartyMemberRoll
PartyMemberVoiceId
PartyMemberVoiceIds
RemovePartyMember
RemoveSquadMember
RequestToJoinLeaderConfirmationRequest
SetCurrentPartyId
SetPartyLeader
SquadMemberList
SquadRequestCanceled
SquadRequestDeclined
SquadRequestSuccess
UpdatePartyMemberInfo
VoiceChatAvailable
VoiceChatConnectInfo

AddPartyMember

AddPartyMember(userId, name, classId, level, isAfk)
Field name Type Description
userId int ToDo
name string ToDo
classId int ToDo
level int ToDo
isAfk bool ToDo

AddSquadMember

AddSquadMember(userId, entityId)
Field name Type Description
userId int ToDo
entityId ulong ToDo

ChangePartyLootMethod

  • ChangePartyLootMethod is Party Packet
  • Notify player that loot option has changed
ChangePartyLootMethod(newOption)
Field name Type Description
newOption int ToDo

ChangePartyLootThreshold

  • ChangePartyLootThreshold is Party Packet
  • Notify player that loot option has changed
ChangePartyLootThreshold(newOption)
Field name Type Description
newOption int ToDo

DisplayPartyMessage

DisplayPartyMessage(msgId, args = { })
Field name Type Description
msgId int ToDo
args dictionary< string, string> ToDo

InvitedPlayerToParty

  • InvitedPlayerToParty is Party Packet
  • Sucessfully invited a player to a party
InvitedPlayerToParty(inviteeName, isTargetAfk)
Field name Type Description
inviteeName string ToDo
isTargetAfk bool ToDo

InviteSquadConfirmationRequest

  • InviteSquadConfirmationRequest is Party Packet
  • Request confirmation for inviting a squad
InviteSquadConfirmationRequest(inviteeName)
Field name Type Description
inviteeName string ToDo

InviteToParty

InviteToParty(senderName, senderSquadInfo)
Field name Type Description
senderName string ToDo
senderSquadInfo unknown ToDo

JoinSquadRequestReceived

  • JoinSquadRequestReceived is Party Packet
  • Join squad request received from server
JoinSquadRequestReceived(senderName, senderSquadInfo, senderUserId)
Field name Type Description
senderName string ToDo
senderSquadInfo unknown ToDo
senderUserId int ToDo

JoinSquadRequestSent

  • JoinSquadRequestSent is Party Packet
  • Squad request has been sent
JoinSquadRequestSent(inviteeName, isTargetAfk)
Field name Type Description
inviteeName string ToDo
isTargetAfk bool ToDo

PartyDisbanded

PartyDisbanded()
0 arguments

PartyMemberList

PartyMemberList(partyList)
Field name Type Description
partyList list< PartyMember> ToDo
PartyMember
PartyMember(userId, name, classId, level, isAfk)
Field name Type Description
userId int ToDo
name string ToDo
classId int ToDo
level int ToDo
isAfk bool ToDo

PartyMemberLoot

o
PartyMemberLoot(userId, creatureEntityId, lootClassIds, moneyAmount)
Field name Type Description
userId int ToDo
creatureEntityId ulong ToDo
lootClassIds int ToDo
moneyAmount int ToDo

PartyMemberRoll

  • PartyMemberRoll is Party Packet
  • Receiving party member roll data from the server.
o
PartyMemberRoll(itemClassId, winnerUserId, rolls, isGreedRoll)
Field name Type Description
itemClassId int ToDo
winnerUserId int ToDo
rolls unknown ToDo
isGreedRoll bool ToDo

PartyMemberVoiceId

PartyMemberVoiceId(userId, voiceId)
Field name Type Description
userId int ToDo
voiceId int ToDo

PartyMemberVoiceIds

PartyMemberVoiceIds(PartyMemberVoiceIds)
Field name Type Description
memberList list< VoiceMember> ToDo
VoiceMember
VoiceMember(userId, voiceId)
Field name Type Description
userId int ToDo
voiceId int ToDo

RemovePartyMember

RemovePartyMember(userId, wasKicked = False)
Field name Type Description
userId int ToDo
wasKicked bool ToDo

RemoveSquadMember

RemoveSquadMember(userId, entityId)
Field name Type Description
userId int ToDo
entityId ulong ToDo

RequestToJoinLeaderConfirmationRequest

  • RequestToJoinLeaderConfirmationRequest is Party Packet
  • info ToDo
RequestToJoinLeaderConfirmationRequest(inviteeName)
Field name Type Description
inviteeName string ToDo

SetCurrentPartyId

SetCurrentPartyId(squadId, wasKicked = False)
Field name Type Description
squadId int ToDo
wasKicked bool ToDo

SetPartyLeader

SetPartyLeader(userId)
Field name Type Description
userId int ToDo

SquadMemberList

SquadMemberList(squadMembers, partyExclusiveMap)
Field name Type Description
squadMembers list< SquadMember> ToDo
partyExclusiveMap int ToDo
SquadMember
SquadMember(userId, entityId)
Field name Type Description
userId int ToDo
entityId ulong ToDo

SquadRequestCanceled

  • SquadRequestCanceled is Party Packet
  • Squad request has been canceled
SquadRequestCanceled(inviterName)
Field name Type Description
inviterName string ToDo

SquadRequestDeclined

  • SquadRequestDeclined is Party Packet
  • Squad request has been declined
SquadRequestDeclined(receiverName)
Field name Type Description
receiverName string ToDo

SquadRequestSuccess

  • SquadRequestSuccess is Party Packet
  • squad request has been successful
SquadRequestSuccess(inviteeName)
Field name Type Description
inviteeName string ToDo

UpdatePartyMemberInfo

UpdatePartyMemberInfo(userId, name, classId, level, isAfk)
Field name Type Description
userId int ToDo
name string ToDo
classId int ToDo
level int ToDo
isAfk bool ToDo

VoiceChatAvailable

  • VoiceChatAvailable is Party Packet
  • Sends the server a request to join voice channel if not already connected
VoiceChatAvailable(isAvail)
Field name Type Description
isAvail bool ToDo

VoiceChatConnectInfo

VoiceChatConnectInfo(serverAddr, groupId, playerId, token)
Field name Type Description
serverAddr string ToDo
groupId int ToDo
playerId int ToDo
token unknown ToDo

Petition Packets

<< Back to Packet groups by origin

  • These packets are used in petition manager
  • total 7 packet's
Packets
AddToPetitionAck
CancelPetitionAck
CreatePetitionAck
RetrieveKBArticleAck
RetrievePetitionAck
SearchKBAck
SearchPetitionsAck

AddToPetitionAck

  • AddToPetitionAck is Petition Packet
  • note: This methos is emtpy on client side, so we dont need to use it.
AddToPetitionAck(success, petitionId)
Field name Type Description
success bool ToDo
petitionId int ToDo

CancelPetitionAck

  • CancelPetitionAck is Petition Packet
  • note: This methos is emtpy on client side, so we dont need to use it.
CancelPetitionAck(success, petitionId)
Field name Type Description
success bool ToDo
petitionId int ToDo

CreatePetitionAck

CreatePetitionAck(success, petitionId)
Field name Type Description
success bool ToDo
petitionId int ToDo

RetrieveKBArticleAck

  • RetrieveKBArticleAck is Petition Packet
  • note: This methos is emtpy on client side, so we dont need to use it.
RetrieveKBArticleAck(success, kbArticleId, articleInfo)
Field name Type Description
success bool ToDo
kbArticleId int ToDo
articleInfo unknown ToDo

RetrievePetitionAck

  • RetrievePetitionAck is Petition Packet
  • note: This methos is emtpy on client side, so we dont need to use it.
RetrievePetitionAck(success, petitionId, petitionInfo)
Field name Type Description
success bool ToDo
petitionId int ToDo
petitionInfo unknown ToDo

SearchKBAck

  • SearchKBAck is Petition Packet
  • note: This methos is emtpy on client side, so we dont need to use it.
SearchKBAck(success, resultList)
Field name Type Description
success bool ToDo
resultList unknown ToDo

SearchPetitionsAck

  • SearchPetitionsAck is Petition Packet
  • note: This methos is emtpy on client side, so we dont need to use it.
SearchPetitionsAck(success, resultList)
Field name Type Description
success bool ToDo
resultList unknown ToDo

PhysicalEntity Packets

<< Back to Packet groups by origin

  • total 14 packet's
Packets
BodyAttributes
CallGameEffectMethod
ExamineResults
GameEffectAttached
GameEffectAttachFailed
GameEffectDetached
GameEffects
GameEffectTick
GameEffectUpdateTooltip
IsTargetable
PerformObjectAbility
ServerSkeleton
WorldLocationDescriptor
WorldPlacementDescriptor

BodyAttributes

  • BodyAttributes is PhysicalEntity Packet
  • Called by the server to set physical entity body attributes (typically used during entity construction).
BodyAttributes(self, scale, hue, ignoreABVs, ignoreWS, hue2)
Field name Type Description
scale float ToDo
hue int ToDo
ignoreABVs bool ToDo
ignoreWS bool ToDo
hue2 int ToDo

CallGameEffectMethod

CallGameEffectMethod(self, effectId, methodName, args=())
Field name Type Description
effectId int ToDo
methodName string ToDo
args tuple ToDo

ExamineResults

ExamineResults(???)
unknown args number and type

GameEffectAttached

  • GameEffectAttached is PhysicalEntity Packet
  • Notification that a game effect was attached to this entity
GameEffectAttached(self, typeId, effectId, level, sourceId, announce, tooltipDict, *args)
Field name Type Description
typeId int ToDo
effectId int ToDo
level int ToDo
sourceId int ToDo
announce bool ToDo
tooltipDict unknown ToDo
args unknown ToDo

GameEffectAttachFailed

  • GameEffectAttachFailed is PhysicalEntity Packet
  • Notification that an effect didn't attach for some reason
GameEffectAttachFailed(self, typeId, reason, sourceId, delayMs)
Field name Type Description
typeId int ToDo
reason string ToDo
sourceId int ToDo
delayMs float ToDo

GameEffectDetached

GameEffectDetached(self, effectId)
Field name Type Description
effectId int ToDo

GameEffects

  • GameEffects is PhysicalEntity Packet
  • Receive a list of game effect data that are attached to this physical.
GameEffects(self, effectDataSeq)
Field name Type Description
effectDataSeq unknown ToDo

GameEffectTick

GameEffectTick(self, effectId, *args)
Field name Type Description
effectId int ToDo
args unknown ToDo

GameEffectUpdateTooltip

  • GameEffectUpdateTooltip is PhysicalEntity Packet
  • Notification the game effect tooltip data has changed.
GameEffectUpdateTooltip(self, effectId, tooltipDict)
Field name Type Description
effectId int ToDo
tooltipDict unknown ToDo

IsTargetable

IsTargetable(self, bIsTargetable)
Field name Type Description
bIsTargetable bool ToDo

PerformObjectAbility

PerformObjectAbility(self, actionId, argId, hits, misses, *args)
Field name Type Description
actionId int ToDo
argId int ToDo
hits unknown ToDo
misses unknown ToDo
args unknown ToDo

ServerSkeleton

ServerSkeleton(???)
unknown args number and type

WorldLocationDescriptor

  • WorldLocationDescriptor is PhysicalEntity Packet
  • Called by the server to place the object in world at the specific position.
WorldLocationDescriptor(self, translate, rotate)
Field name Type Description
translate Position ToDo
rotate Rotation ToDo
Position
Position(x, y, z)
Field name Type Description
x float x coord
y float y coord
z float z coord
Rotation
Rotation(x, y, z, w)
Field name Type Description
x float x coord
y float y coord
z float z coord
w float w coord

WorldPlacementDescriptor

  • WorldPlacementDescriptor is PhysicalEntity Packet
  • Called by the server to place an object at a connection point.
WorldPlacementDescriptor(self, plugId, destEntityId, socketId)
Field name Type Description
plugId int ToDo
destEntityId ulong ToDo
socketId int ToDo

Prestige Packets

<< Back to Packet groups by origin

  • total 3 packet's
Packets
ReceivedCreatureKillPrestige
ReceivedItemLootPrestige
WageredItemOutLeveled

ReceivedCreatureKillPrestige

  • ReceivedCreatureKillPrestige is Prestige Packet
  • Notice from server that the player has received 'prestige' loot by killing a creature.
ReceivedCreatureKillPrestige(entityId, amount)
Field name Type Description
entityId ulong ToDo
amount int ToDo

ReceivedItemLootPrestige

  • ReceivedItemLootPrestige is Prestige Packet
  • Notice from server that the player has received 'prestige' by looting a rare item.
ReceivedItemLootPrestige(amount, qualityId, itemTemplateId, moduleIds)
Field name Type Description
entityId ulong The item entityId
qualityId int Quality of the item looted
itemTemplateId int Template id of the item looted
moduleIds list< int> Modules of the item looted

WageredItemOutLeveled

  • WageredItemOutLeveled is Prestige Packet
  • Notice from server that our wagered item is out leveled by the character.
WageredItemOutLeveled()
0 arguments

Social Packets

<< Back to Packet groups by origin

  • These packets are used in Social
  • total 8 packet's
Packets
FriendAdded
FriendLoggedIn
FriendLoggedOut
FriendRemoved
FriendStatusUpdate
IgnoreAdded
IgnoreRemoved
SetSocialContactList

FriendAdded

  • FriendAdded is Social Packet
  • A player has been friended, update cache and UI
FriendAdded(friendInfo)
Field name Type Description
friendInfo structure FriendInfo
FriendInfo
FriendInfo(characterId, userId, characterName, familyName, contextId, isOnline)
Field name Type Description
characterId int ToDo
userId int ToDo
characterName string ToDo
familyName int ToDo
contextId int ToDo
isOnline bool ToDo

FriendLoggedIn

  • FriendLoggedIn is Social Packet
  • A friend has come online, update cache and UI
FriendLoggedIn(friendInfo)
Field name Type Description
friendInfo structure FriendInfo

FriendLoggedOut

  • FriendLoggedOut is Social Packet
  • A friend has come offline, update cache and UI
FriendLoggedOut(userId)
Field name Type Description
userId int ToDo

FriendRemoved

  • FriendRemoved is Social Packet
  • A player has been removed from friend list, update cache and UI
FriendRemoved(userId)
Field name Type Description
userId int ToDo

FriendStatusUpdate

  • FriendStatusUpdate is Social Packet
  • A member's status has changed, update cache and UI
FriendStatusUpdate(friendInfo)
Field name Type Description
friendInfo structure FriendInfo

IgnoreAdded

  • IgnoreAdded is Social Packet
  • A player has been ignored, update cache and UI
IgnoreAdded(ignoredPlayerInfo)
Field name Type Description
ignoredPlayerInfo structure IgnoredPlayerInfo
IgnoredPlayerInfo
IgnoredPlayerInfo(characterId, userId, characterName, familyName, isOnline)
Field name Type Description
characterId int ToDo
userId int ToDo
characterName string ToDo
familyName int ToDo
isOnline bool ToDo

IgnoreRemoved

  • IgnoreRemoved is Social Packet
  • A player has been removed from ignore list, update cache and UI
IgnoreRemoved(userId)
Field name Type Description
userId int ToDo

SetSocialContactList

  • SetSocialContactList is Social Packet
  • Update friend and ignore list
SetSocialContactList(friendList, ignoreList)
Field name Type Description
friendList list< FriendInfo> List of friendInfo.
ignoreList list< IgnoredPlayerInfo> List of ignoredPlayerInfo.

Team Packets

<< Back to Packet groups by origin

  • These packets are used in Team
  • total 9 packet's
Packets
AddTeamMember
JoinedTeam
LeftTeam
RemoveTeamMember
ScoreBoardActive
ScoreBoardGameScore
ScoreBoardIndividualUpdate
ScoreBoardTrackerUpdate
SetNumberOfTeams

AddTeamMember

AddTeamMember(characterId)
Field name Type Description
characterId int ToDo

JoinedTeam

  • JoinedTeam is Team Packet
  • A character has joined your team.
JoinedTeam(teamId, members)
Field name Type Description
teamId int ToDo
members list< int> List of character id's.

LeftTeam

  • LeftTeam is Team Packet
  • A character has left your team.
LeftTeam()
0 arguments.

RemoveTeamMember

  • RemoveTeamMember is Team Packet
  • A character has joined your team.
RemoveTeamMember(characterId)
Field name Type Description
characterId int ToDo

ScoreBoardActive

  • ScoreBoardActive is Team Packet
  • Receive whether the scoreboard is currently active or not.
ScoreBoardActive(bActive)
Field name Type Description
bActive bool ToDo

ScoreBoardGameScore

  • ScoreBoardGameScore is Team Packet
  • Receive the game score for the current battleground.
ScoreBoardGameScore(remainingTime, cpData)
Field name Type Description
remainingTime int ToDo
cpData unknown ToDo

ScoreBoardIndividualUpdate

  • ScoreBoardIndividualUpdate is Team Packet
  • Update call for just one person.
ScoreBoardIndividualUpdate(entityId, individualUpdate)
Field name Type Description
entityId ulong ToDo
individualUpdate unknown ToDo

ScoreBoardTrackerUpdate

  • ScoreBoardTrackerUpdate is Team Packet
  • Not sure what data goes in the score board tracker. <= ( original description from tr dev :D )
ScoreBoardTrackerUpdate(entityId, trackerUpdate)
Field name Type Description
entityId ulong ToDo
trackerUpdate unknown ToDo

SetNumberOfTeams

  • SetNumberOfTeams is Team Packet
  • The number of teams active on this map have changed.
SetNumberOfTeams(numTeams)
Field name Type Description
numTeams int ToDo

DEV: Example empty table for copy pasting to create new packet tables

DummyExamplePacket
Field name Type Description
field1 int dummy description

Clone this wiki locally