SDK 6.3/PAWN/Network

From WowWiki
Revision as of 09:45, 26 July 2026 by WowBot (talk | contribs) (Mark PAWN API as legacy (supported, not developed) (WowBot))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Official WOWCube SDK documentation. SDK 6.3, PAWN API. Generated from the canonical SDK headers — do not edit by hand; regenerate from source.
Legacy track. The PAWN API is supported but no longer actively developed — the last PAWN additions shipped in SDK 6.2. New development uses the C++ (WebAssembly) API.

SDK 6.3 · PAWN API: Core · Graphics · Topology · Sound · Motion Sensor · Leaderboard · Splash Screen · Physics · Network · Save · Scramble · Logging
C++: Native API · Application · GFX Engine  ·  Rust: Rust API (experimental)  ·  Changelog

SDK 6.3 · PAWN / Network

Pawn works with cells which has a size of 4 bytes. Native interfaces handling generic data like network messages have size limits for that data. If application does not need to work with a large numbers, several values can be packed into a single cell. This library provides some convenient functions to pack and unpack such values from array of cells which can be broadcasted over network by core functions.

Functions

NetWorkReset

Syntax:

NetWorkReset()

Description:

Reset state before storing new data to pack.

NetWorkWriteValue

Syntax:

NetWorkWriteValue(value, bits)

Description:

Store specified number of bits from some unsigned value.

Arguments:

value
a value to store data from
bits
a number of bits to store

NetWorkWriteSignedValue

Syntax:

NetWorkWriteSignedValue(value, bits)

Description:

Store specified number of bits from some signed value.

Arguments:

value
a value to store data from
bits
a number of bits to store

NetWorkReadValue

Syntax:

NetWorkReadValue(bits)

Description:

Read specified number of bits of packed unsigned value.

Arguments:

bits
a number of bits to get

Return values:

Unpacked unsigned value.

NetWorkReadSignedValue

Syntax:

NetWorkReadSignedValue(bits)

Description:

Read specified number of bits of packed signed value.

Arguments:

bits
a number of bits to get

Return values:

Unpacked signed value.

NetWorkSetData

Syntax:

NetWorkSetData(const pkt[], size)

Description:

Populate state with a new data to unpack.

Arguments:

pkt
packet data to unpack

See also: ON_Packet()

NetWorkGetData

Syntax:

NetWorkGetData()

Description:

Get packed data to broadcast.

Return values:

Packed data to broadcast.

See also: broadcastPacket()

NetWorkGetDataSize

Syntax:

NetWorkGetDataSize()

Description:

Get packed data to broadcast.

Return values:

Packed size to broadcast.

See also: broadcastPacket()