world.GetReceivedBytes

MUSHclient script function (Method)

Returns the number of bytes received from the world

Prototype

long GetReceivedBytes();

Data type meanings

Description

Returns a count of the number of bytes received from the world.

The maximum number that can be returned by this function is a 31-bit number (ie. 0 to 2,147,483,647 bytes). This does not apply to Lua which returns the numbers as a "double" type (floating point).

If more bytes than that have been received the number will "wrap around" and become negative for a while.

VBscript example

world.note world.GetReceivedBytes

Jscript example

world.note(world.GetReceivedBytes());

PerlScript example

$world->note($world->GetReceivedBytes());

Python example

world.note(world.GetReceivedBytes)

Lua example

Note(GetReceivedBytes())

Lua notes

Lua will always return the correct number as the Lua data type is double, not long.

Return value

The number of bytes received from the MUD.

Related topic

Information

See also