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

MUSHclient scripting

Description of MUSHclient world function: world.GetPluginName

Name GetPluginName
Type Method
Summary Returns the name of the current plugin
Prototype BSTR GetPluginName();

View list of data type meanings


Returns the name of the currently-executing plugin. If no plugin is executing an empty string will be returned.

Note: Available in version 3.23 onwards.

VBscript example
world.Note world.GetPluginName
Jscript example
world.Note (world.GetPluginName ());
PerlScript example
$world->Note ($world->GetPluginName ());
Python example
world.Note (world.GetPluginName )
Lua example
Note (GetPluginName ())
Returns The name of the current plugin, or an empty string if no plugin is running.
Introduced in version 3.23

See also ...

Function Description
GetPluginID Returns the 24-character ID of the current plugin
GetPluginInfo Gets details about a specified plugin

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


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.


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]