[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.GetReceivedBytes


Name GetReceivedBytes
Type Method
Summary Returns the number of bytes received from the world
Prototype long GetReceivedBytes();

View list of 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.
Returns The number of bytes received from the MUD.

See also ...

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

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]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]