world.GetPluginID

MUSHclient script function (Method) — introduced in version 3.23

Returns the 24-character ID of the current plugin

Prototype

BSTR GetPluginID();

Data type meanings

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.

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.

Related topic

Plugins

See also