world.GetSentBytes

MUSHclient script function (Method)

Returns the number of bytes sent to the world

Prototype

long GetSentBytes();

Data type meanings

Description

Returns a count of the number of bytes actually sent to the world. (This will exclude commands that are queued up that haven't yet been sent).

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 sent the number will "wrap around" and become negative for a while.

VBscript example

world.note world.GetSentBytes

Jscript example

world.note(world.GetSentBytes());

PerlScript example

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

Python example

world.note(world.GetSentBytes)

Lua example

Note(GetSentBytes())

Lua notes

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

Return value

The number of bytes sent to the MUD.

Related topic

Information

See also