Pause
Script function

world.Pause

DOC_scripting Read about scripting

Type

Method

Summary

Turns pause mode on or off

Prototype

void Pause(BOOL Flag);

DOC_data_types View list of 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



(Help topic: function=Pause)

DOC_contents Documentation contents page