world.Pause

MUSHclient script function (Method)

Turns pause mode on or off

Prototype

void Pause(BOOL Flag);

Data type meanings

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.

Return value

Nothing