Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.GetSentBytes


Name GetSentBytes
Type Method
Summary Returns the number of bytes sent to the world
Prototype long GetSentBytes();
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.
Returns The number of bytes sent to the MUD.

See also ...

Function Description
GetConnectDuration Returns the number of seconds this world has been connected.
GetLineCount Gets count of lines received
GetReceivedBytes Returns the number of bytes received from the world
GetScriptTime Returns the amount of time spent in script routines

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.