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

MUSHclient scripting

Description of MUSHclient world function: world.GetPluginID

Name GetPluginID
Type Method
Summary Returns the 24-character ID of the current plugin
Prototype BSTR GetPluginID();

View list of data type meanings


Returns the unique ID (identifier) of the currently-executing plugin. This will let the plugin find things out about itself (using GetPluginInfo). If no plugin is executing an empty string will be returned.

To find the unique ID of your current world (rather than plugin) use GetWorldID.

Note: Available in version 3.23 onwards.

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

See also ...

Function Description
GetPluginInfo Gets details about a specified plugin
GetPluginName Returns the name of the current plugin
GetWorldID Returns the 24-character ID 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


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]