Script function

world.GetPluginID

Type

Method

Summary

Returns the 24-character ID of the current plugin

Prototype

BSTR GetPluginID();

Description

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.

Available in MUSHclient 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 ())

Return value

The 24-character plugin ID of the current plugin, or an empty string if no plugin is running.

See Also ...

Topics

Aliases
Arrays
Plugins
Scripting
Timers
Triggers
Variables

Functions

(BroadcastPlugin) Broadcasts a message to all installed plugins
(CallPlugin) Calls a routine in a plugin
(EnablePlugin) Enables or disables the specified plugin
(GetPluginInfo) Gets details about a specified plugin
(GetPluginList) Gets a list of installed plugins.
(GetPluginName) Returns the name of the current plugin
(GetPluginTimerInfo) Gets details about a named timer for a specified plugin
(GetPluginTimerList) Gets the list of timers in a specified plugin
(GetPluginVariable) Gets the contents of a variable belonging to a plugin
(GetPluginVariableList) Gets the list of variables in a specified plugin
(GetWorldID) Returns the 24-character ID of the current world
(IsPluginInstalled) Checks to see if a particular plugin is installed
(LoadPlugin) Loads a plugin from disk
(PluginSupports) Checks if a plugin supports a particular routine
(ReloadPlugin) Reloads an installed plugin
(SaveState) Saves the state of the current plugin
(UnloadPlugin) Unloads an installed plugin

(Help topic: function=GetPluginID)