Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.WorldName

Name WorldName
Type Method
Summary Gets the world's name
Prototype BSTR WorldName();

View list of data type meanings
Description

This returns the name of the current world.
VBscript example 
world.note world.WorldName
Jscript example 
world.Note(world.WorldName());
PerlScript example 
$world->Note($world->WorldName());
Python example 
world.Note(world.WorldName)
Lua example 
Note(WorldName())
Returns Name of the current world.

See also ...

Function Description
WorldAddress Returns the TCP/IP address of the current world.
WorldPort Returns the port number of the current 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]

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

Home