Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.Pause


Name Pause
Type Method
Summary Turns pause mode on or off
Prototype void Pause(BOOL Flag);
Description

Turns on or off the "paused" flag for all output windows in this world.

VBscript example
world.Pause vbTrue  ' pause the world
world.Pause vbFalse ' unpause the world
Jscript example
world.Pause (true);  // pause the world
world.Pause (false); // unpause the world
PerlScript example
$world->pause(true);  # pause the world
$world->pause(false); # unpause the world
Python example
world.Pause (True)  # pause the world
world.Pause (False) # unpause the world
Lua example
Pause (true)  -- pause the world
Pause (false) -- unpause the world
Lua notes
The argument is optional, and defaults to true.
Returns Nothing

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.