w3gs

package

Go to main page

Versions in this module

v1

v1.7.1

Mar 13, 2022

v1.7.0

Jan 23, 2022

v1.6.0

Apr 11, 2020

Changes in this version

+ const PidPlayerExtra

type GameFlags

+ const GameFlagLadder1v1

+ const GameFlagLadder2v2

+ const GameFlagLadder3v3

+ const GameFlagLadder4v4

type GameSettingFlags

+ const SettingObsEnabled

+ type PlayerData5 struct

+ PlayerID uint32

+ Unknown1 uint32

+ type PlayerDataProfile struct

+ BattleTag string

+ Clan string

+ PlayerID uint32

+ Portrait string

+ Realm ProfileRealm

+ Unknown1 string

+ type PlayerDataSkin struct

+ Collection string

+ Skin uint64

+ Unit uint64

+ type PlayerDataSkins struct

+ PlayerID uint32

+ Skins []PlayerDataSkin

+ type PlayerExtra struct

+ Profiles []PlayerDataProfile

+ Skins []PlayerDataSkins

+ Type PlayerExtraType

+ Unknown5 []PlayerData5

+ func (pkt *PlayerExtra) Deserialize(buf *protocol.Buffer, enc *Encoding) error

+ func (pkt *PlayerExtra) DeserializeContent(buf *protocol.Buffer, enc *Encoding) error

+ func (pkt *PlayerExtra) Serialize(buf *protocol.Buffer, enc *Encoding) error

+ func (pkt *PlayerExtra) SerializeContent(buf *protocol.Buffer, enc *Encoding) error

+ type PlayerExtraType uint8

+ const PlayerExtra2

+ const PlayerExtra5

+ const PlayerProfile

+ const PlayerSkins

+ func (t PlayerExtraType) String() string

+ type ProfileRealm uint32

+ const RealmAmericas

+ const RealmAsia

+ const RealmEurope

+ const RealmOffline

+ func (r ProfileRealm) String() string

v1.5.0

Apr 23, 2019

Changes in this version

+ var DefaultFactory = MapFactory

+ var ErrNoFactory = errors.New("w3gs: Invalid w3gs packet (empty factory)")

+ func Serialize(p Packet, e Encoding) ([]byte, error)

+ func Write(w io.Writer, p Packet, e Encoding) (int, error)

+ type CacheFactory struct

+ func (f CacheFactory) NewPacket(pid uint8, enc *Encoding) Packet

+ type Decoder struct

+ func NewDecoder(e Encoding, f PacketFactory) *Decoder

+ func (dec *Decoder) Deserialize(b []byte) (Packet, int, error)

+ func (dec *Decoder) Read(r io.Reader) (Packet, int, error)

+ func (dec *Decoder) ReadRaw(r io.Reader) ([]byte, int, error)

type Desync

+ Unknown1 uint32

+ func (pkt *Desync) DeserializeContent(buf *protocol.Buffer, enc *Encoding) error

+ func (pkt *Desync) SerializeContent(buf *protocol.Buffer, enc *Encoding)

+ type Encoder struct

+ func NewEncoder(e Encoding) *Encoder

+ func (enc *Encoder) Serialize(p Packet) ([]byte, error)

+ func (enc *Encoder) Write(w io.Writer, p Packet) (int, error)

+ type Encoding struct

+ GameVersion uint32

+ type FactoryFunc func(enc *Encoding) Packet

type GameFlags

+ const GameFlagSignedMap

type GameSettings

+ func (gs *GameSettings) DeserializeContent(buf *protocol.Buffer, enc *Encoding) error

+ func (gs *GameSettings) SerializeContent(buf *protocol.Buffer, enc *Encoding)

type GameVersion

+ func (gv *GameVersion) DeserializeContent(buf *protocol.Buffer, enc *Encoding)

+ func (gv *GameVersion) SerializeContent(buf *protocol.Buffer, enc *Encoding)

type LagPlayer

+ func (lp *LagPlayer) DeserializeContent(buf *protocol.Buffer, enc *Encoding)

+ func (lp *LagPlayer) SerializeContent(buf *protocol.Buffer, enc *Encoding)

+ type MapFactory map[uint8]FactoryFunc

+ func (f MapFactory) NewPacket(pid uint8, enc *Encoding) Packet

type Message

+ Scope MessageScope

+ type MessageScope uint32

+ const ScopeAll

+ const ScopeAllies

+ const ScopeDirected

+ const ScopeObservers

+ func (s MessageScope) String() string

type Packet

+ func Deserialize(b []byte, e Encoding) (Packet, int, error)

+ func Read(r io.Reader, e Encoding) (Packet, int, error)

+ type PacketFactory interface

+ NewPacket func(pid uint8, enc *Encoding) Packet

+ func NewFactoryCache(factory PacketFactory) PacketFactory

type SlotInfo

+ func (pkt *SlotInfo) DeserializeContent(buf *protocol.Buffer, enc *Encoding) error

+ func (pkt *SlotInfo) SerializeContent(buf *protocol.Buffer, enc *Encoding)

type SlotLayout

+ const LayoutLadder

v1.4.0

Mar 25, 2019

v1.3.0

Mar 17, 2019

v1.2.1

Jan 6, 2019

v1.2.0

Dec 21, 2018

v1.1.0

Jul 19, 2018

Changes in this version

+ const CurrentGameVersion

v1.0.0

Jul 10, 2018

Changes in this version

+ const PidChatFromHost

+ const PidChatFromOthers

+ const PidChatToHost

+ const PidClientInfo

+ const PidCountDownEnd

+ const PidCountDownStart

+ const PidCreateGame

+ const PidDecreateGame

+ const PidDesync

+ const PidDropReq

+ const PidGameInfo

+ const PidGameLoadedSelf

+ const PidGameOver

+ const PidIncomingAction

+ const PidIncomingAction2

+ const PidLeaveAck

+ const PidLeaveReq

+ const PidMapCheck

+ const PidMapPart

+ const PidMapPartError

+ const PidMapPartOK

+ const PidMapSize

+ const PidOutgoingAction

+ const PidOutgoingKeepAlive

+ const PidPeerSet

+ const PidPingFromHost

+ const PidPingFromOthers

+ const PidPlayerInfo

+ const PidPlayerKicked

+ const PidPlayerLeft

+ const PidPlayerLoaded

+ const PidPongToHost

+ const PidPongToOthers

+ const PidRefreshGame

+ const PidRejectJoin

+ const PidReqJoin

+ const PidSearchGame

+ const PidSlotInfo

+ const PidSlotInfoJoin

+ const PidStartDownload

+ const PidStartLag

+ const PidStopLag

+ const ProtocolSig

+ var ErrBufferTooSmall = errors.New("w3gs: Packet exceeds buffer size")

+ var ErrInvalidChecksum = errors.New("w3gs: Checksum invalid")

+ var ErrInvalidPacketSize = errors.New("w3gs: Invalid packet size")

+ var ErrNoProtocolSig = errors.New("w3gs: Invalid w3gs packet (no signature found)")

+ var ErrUnexpectedConst = errors.New("w3gs: Unexpected constant value")

+ var ProductDemo = protocol.DString("W3DM")

+ var ProductROC = protocol.DString("WAR3")

+ var ProductTFT = protocol.DString("W3XP")

+ func ReadPacket(r io.Reader, b *DeserializationBuffer) ([]byte, int, error)

+ func ReadPacketWithBuffer(r io.Reader, b *DeserializationBuffer) ([]byte, int, error)

+ func SerializePacket(w io.Writer, p Packet) (int, error)

+ func SerializePacketWithBuffer(w io.Writer, b *SerializationBuffer, p Packet) (int, error)

+ type AI uint8

+ const ComputerEasy

+ const ComputerInsane

+ const ComputerNormal

+ func (a AI) String() string

+ type CountDownEnd struct

+ func (pkt *CountDownEnd) Deserialize(buf *protocol.Buffer) error

+ func (pkt *CountDownEnd) Serialize(buf *protocol.Buffer) error

+ type CountDownStart struct

+ func (pkt *CountDownStart) Deserialize(buf *protocol.Buffer) error

+ func (pkt *CountDownStart) Serialize(buf *protocol.Buffer) error

+ type CreateGame struct

+ HostCounter uint32

+ func (pkt *CreateGame) Deserialize(buf *protocol.Buffer) error

+ func (pkt *CreateGame) Serialize(buf *protocol.Buffer) error

+ type DecreateGame struct

+ HostCounter uint32

+ func (pkt *DecreateGame) Deserialize(buf *protocol.Buffer) error

+ func (pkt *DecreateGame) Serialize(buf *protocol.Buffer) error

+ type DeserializationBuffer struct

+ Buffer [2048]byte

+ type Desync struct

+ Checksum uint32

+ PlayersInState []uint8

+ func (pkt *Desync) Deserialize(buf *protocol.Buffer) error

+ func (pkt *Desync) Serialize(buf *protocol.Buffer) error

+ type DropLaggers struct

+ func (pkt *DropLaggers) Deserialize(buf *protocol.Buffer) error

+ func (pkt *DropLaggers) Serialize(buf *protocol.Buffer) error

+ type GameAction struct

+ Data []byte

+ func (pkt *GameAction) Deserialize(buf *protocol.Buffer) error

+ func (pkt *GameAction) Serialize(buf *protocol.Buffer) error

+ type GameFlags uint32

+ const GameFlagCreatorBlizzard

+ const GameFlagCreatorMask

+ const GameFlagCreatorUser

+ const GameFlagCustomGame

+ const GameFlagFilterMask

+ const GameFlagMapTypeMask

+ const GameFlagMapTypeMelee

+ const GameFlagMapTypeScenario

+ const GameFlagObsFull

+ const GameFlagObsMask

+ const GameFlagObsNone

+ const GameFlagObsOnDefeat

+ const GameFlagOfficialGame

+ const GameFlagPrivateGame

+ const GameFlagSavedGame

+ const GameFlagSinglePlayer

+ const GameFlagSizeLarge

+ const GameFlagSizeMask

+ const GameFlagSizeMedium

+ const GameFlagSizeSmall

+ const GameFlagTeamLadder

+ const GameFlagTypeMask

+ func (f GameFlags) String() string

+ type GameInfo struct

+ EntryKey uint32

+ GameFlags GameFlags

+ GameName string

+ GamePort uint16

+ GameSettings GameSettings

+ HostCounter uint32

+ SlotsAvailable uint32

+ SlotsTotal uint32

+ SlotsUsed uint32

+ UptimeSec uint32

+ func (pkt *GameInfo) Deserialize(buf *protocol.Buffer) error

+ func (pkt *GameInfo) Serialize(buf *protocol.Buffer) error

+ type GameLoaded struct

+ func (pkt *GameLoaded) Deserialize(buf *protocol.Buffer) error

+ func (pkt *GameLoaded) Serialize(buf *protocol.Buffer) error

+ type GameOver struct

+ PlayerID uint8

+ func (pkt *GameOver) Deserialize(buf *protocol.Buffer) error

+ func (pkt *GameOver) Serialize(buf *protocol.Buffer) error

+ type GameSettingFlags uint32

+ const SettingObsFull

+ const SettingObsMask

+ const SettingObsNone

+ const SettingObsOnDefeat

+ const SettingObsReferees

+ const SettingRandomHero

+ const SettingRandomRace

+ const SettingSharedControl

+ const SettingSpeedFast

+ const SettingSpeedMask

+ const SettingSpeedNormal

+ const SettingSpeedSlow

+ const SettingTeamsFixed

+ const SettingTeamsTogether

+ const SettingTerrainDefault

+ const SettingTerrainExplored

+ const SettingTerrainHidden

+ const SettingTerrainMask

+ const SettingTerrainVisible

+ func (f GameSettingFlags) String() string

+ type GameSettings struct

+ GameSettingFlags GameSettingFlags

+ HostName string

+ MapHeight uint16

+ MapPath string

+ MapSha1 [20]byte

+ MapWidth uint16

+ MapXoro uint32

+ func (gs *GameSettings) Deserialize(buf *protocol.Buffer) error

+ func (gs *GameSettings) Serialize(buf *protocol.Buffer)

+ func (gs *GameSettings) Size() int

+ type GameVersion struct

+ Product protocol.DWordString

+ Version uint32

+ func (gv *GameVersion) Deserialize(buf *protocol.Buffer)

+ func (gv *GameVersion) Serialize(buf *protocol.Buffer)

+ type Join struct

+ EntryKey uint32

+ HostCounter uint32

+ InternalAddr protocol.SockAddr

+ JoinCounter uint32

+ ListenPort uint16

+ PlayerName string

+ func (pkt *Join) Deserialize(buf *protocol.Buffer) error

+ func (pkt *Join) Serialize(buf *protocol.Buffer) error

+ type LagPlayer struct

+ LagDurationMS uint32

+ PlayerID uint8

+ type Leave struct

+ Reason LeaveReason

+ func (pkt *Leave) Deserialize(buf *protocol.Buffer) error

+ func (pkt *Leave) Serialize(buf *protocol.Buffer) error

+ type LeaveAck struct

+ func (pkt *LeaveAck) Deserialize(buf *protocol.Buffer) error

+ func (pkt *LeaveAck) Serialize(buf *protocol.Buffer) error

+ type LeaveReason uint32

+ const LeaveDisconnect

+ const LeaveDraw

+ const LeaveInvalidSaveGame

+ const LeaveLobby

+ const LeaveLost

+ const LeaveLostBuildings

+ const LeaveObserver

+ const LeaveWon

+ func (l LeaveReason) String() string

+ type MapCheck struct

+ FileCRC uint32

+ FilePath string

+ FileSize uint32

+ MapSha1 [20]byte

+ MapXoro uint32

+ func (pkt *MapCheck) Deserialize(buf *protocol.Buffer) error

+ func (pkt *MapCheck) Serialize(buf *protocol.Buffer) error

+ type MapPart struct

+ ChunkPos uint32

+ Data []byte

+ RecipientID uint8

+ SenderID uint8

+ func (pkt *MapPart) Deserialize(buf *protocol.Buffer) error

+ func (pkt *MapPart) Serialize(buf *protocol.Buffer) error

+ type MapPartError struct

+ func (pkt *MapPartError) Deserialize(buf *protocol.Buffer) error

+ func (pkt *MapPartError) Serialize(buf *protocol.Buffer) error

+ type MapPartOK struct

+ ChunkPos uint32

+ RecipientID uint8

+ SenderID uint8

+ func (pkt *MapPartOK) Deserialize(buf *protocol.Buffer) error

+ func (pkt *MapPartOK) Serialize(buf *protocol.Buffer) error

+ type MapState struct

+ FileSize uint32

+ Ready bool

+ func (pkt *MapState) Deserialize(buf *protocol.Buffer) error

+ func (pkt *MapState) Serialize(buf *protocol.Buffer) error

+ type Message struct

+ Content string

+ ExtraFlags uint32

+ NewVal uint8

+ RecipientIDs []uint8

+ SenderID uint8

+ Type MessageType

+ func (pkt *Message) Deserialize(buf *protocol.Buffer) error

+ func (pkt *Message) Serialize(buf *protocol.Buffer) error

+ type MessageRelay struct

+ func (pkt *MessageRelay) Serialize(buf *protocol.Buffer) error

+ type MessageType uint8

+ const MsgChat

+ const MsgChatExtra

+ const MsgColorChange

+ const MsgHandicapChange

+ const MsgRaceChange

+ const MsgTeamChange

+ func (m MessageType) String() string

+ type Packet interface

+ Deserialize func(buf *protocol.Buffer) error

+ Serialize func(buf *protocol.Buffer) error

+ func DeserializePacket(r io.Reader) (Packet, int, error)

+ func DeserializePacketWithBuffer(r io.Reader, b *DeserializationBuffer) (Packet, int, error)

+ type PeerConnect struct

+ EntryKey uint32

+ JoinCounter uint32

+ PeerSet protocol.BitSet32

+ PlayerID uint8

+ func (pkt *PeerConnect) Deserialize(buf *protocol.Buffer) error

+ func (pkt *PeerConnect) Serialize(buf *protocol.Buffer) error

+ type PeerMessage struct

+ func (pkt *PeerMessage) Serialize(buf *protocol.Buffer) error

+ type PeerPing struct

+ GameTicks uint32

+ Payload uint32

+ PeerSet protocol.BitSet32

+ func (pkt *PeerPing) Deserialize(buf *protocol.Buffer) error

+ func (pkt *PeerPing) Serialize(buf *protocol.Buffer) error

+ type PeerPong struct

+ func (pkt *PeerPong) Serialize(buf *protocol.Buffer) error

+ type PeerSet struct

+ PeerSet protocol.BitSet16

+ func (pkt *PeerSet) Deserialize(buf *protocol.Buffer) error

+ func (pkt *PeerSet) Serialize(buf *protocol.Buffer) error

+ type Ping struct

+ Payload uint32

+ func (pkt *Ping) Deserialize(buf *protocol.Buffer) error

+ func (pkt *Ping) Serialize(buf *protocol.Buffer) error

+ type PlayerAction struct

+ Data []byte

+ PlayerID uint8

+ type PlayerInfo struct

+ ExternalAddr protocol.SockAddr

+ InternalAddr protocol.SockAddr

+ JoinCounter uint32

+ PlayerID uint8

+ PlayerName string

+ func (pkt *PlayerInfo) Deserialize(buf *protocol.Buffer) error

+ func (pkt *PlayerInfo) Serialize(buf *protocol.Buffer) error

+ type PlayerKicked struct

+ func (pkt *PlayerKicked) Serialize(buf *protocol.Buffer) error

+ type PlayerLeft struct

+ PlayerID uint8

+ Reason LeaveReason

+ func (pkt *PlayerLeft) Deserialize(buf *protocol.Buffer) error

+ func (pkt *PlayerLeft) Serialize(buf *protocol.Buffer) error

+ type PlayerLoaded struct

+ PlayerID uint8

+ func (pkt *PlayerLoaded) Deserialize(buf *protocol.Buffer) error

+ func (pkt *PlayerLoaded) Serialize(buf *protocol.Buffer) error

+ type Pong struct

+ func (pkt *Pong) Serialize(buf *protocol.Buffer) error

+ type RacePref uint8

+ const RaceDemon

+ const RaceHuman

+ const RaceMask

+ const RaceNightElf

+ const RaceOrc

+ const RaceRandom

+ const RaceSelectable

+ const RaceUndead

+ func (r RacePref) String() string

+ type RefreshGame struct

+ HostCounter uint32

+ SlotsAvailable uint32

+ SlotsUsed uint32

+ func (pkt *RefreshGame) Deserialize(buf *protocol.Buffer) error

+ func (pkt *RefreshGame) Serialize(buf *protocol.Buffer) error

+ type RejectJoin struct

+ Reason RejectReason

+ func (pkt *RejectJoin) Deserialize(buf *protocol.Buffer) error

+ func (pkt *RejectJoin) Serialize(buf *protocol.Buffer) error

+ type RejectReason uint32

+ const RejectJoinFull

+ const RejectJoinInvalid

+ const RejectJoinStarted

+ const RejectJoinWrongKey

+ func (r RejectReason) String() string

+ type SearchGame struct

+ HostCounter uint32

+ func (pkt *SearchGame) Deserialize(buf *protocol.Buffer) error

+ func (pkt *SearchGame) Serialize(buf *protocol.Buffer) error

+ type SerializationBuffer = protocol.Buffer

+ type SlotData struct

+ Color uint8

+ Computer bool

+ ComputerType AI

+ DownloadStatus uint8

+ Handicap uint8

+ PlayerID uint8

+ Race RacePref

+ SlotStatus SlotStatus

+ Team uint8

+ type SlotInfo struct

+ NumPlayers uint8

+ RandomSeed uint32

+ SlotLayout SlotLayout

+ Slots []SlotData

+ func (pkt *SlotInfo) Deserialize(buf *protocol.Buffer) error

+ func (pkt *SlotInfo) Serialize(buf *protocol.Buffer) error

+ type SlotInfoJoin struct

+ ExternalAddr protocol.SockAddr

+ PlayerID uint8

+ func (pkt *SlotInfoJoin) Deserialize(buf *protocol.Buffer) error

+ func (pkt *SlotInfoJoin) Serialize(buf *protocol.Buffer) error

+ type SlotLayout uint8

+ const LayoutCustomForces

+ const LayoutFixedPlayerSettings

+ const LayoutMelee

+ func (s SlotLayout) String() string

+ type SlotStatus uint8

+ const SlotClosed

+ const SlotOccupied

+ const SlotOpen

+ func (s SlotStatus) String() string

+ type StartDownload struct

+ PlayerID uint8

+ func (pkt *StartDownload) Deserialize(buf *protocol.Buffer) error

+ func (pkt *StartDownload) Serialize(buf *protocol.Buffer) error

+ type StartLag struct

+ Players []LagPlayer

+ func (pkt *StartLag) Deserialize(buf *protocol.Buffer) error

+ func (pkt *StartLag) Serialize(buf *protocol.Buffer) error

+ type StopLag struct

+ func (pkt *StopLag) Deserialize(buf *protocol.Buffer) error

+ func (pkt *StopLag) Serialize(buf *protocol.Buffer) error

+ type TimeSlot struct

+ Actions []PlayerAction

+ Fragment bool

+ TimeIncrementMS uint16

+ func (pkt *TimeSlot) Deserialize(buf *protocol.Buffer) error

+ func (pkt *TimeSlot) Serialize(buf *protocol.Buffer) error

+ type TimeSlotAck struct

+ Checksum uint32

+ Unknown1 uint8

+ func (pkt *TimeSlotAck) Deserialize(buf *protocol.Buffer) error

+ func (pkt *TimeSlotAck) Serialize(buf *protocol.Buffer) error

+ type UnknownPacket struct

+ Blob []byte

+ ID byte

+ func (pkt *UnknownPacket) Deserialize(buf *protocol.Buffer) error

+ func (pkt *UnknownPacket) Serialize(buf *protocol.Buffer) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL