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


Script function


Read about scripting




Checks if a plugin supports a particular routine


long PluginSupports(BSTR PluginID, BSTR Routine);

View list of data type meanings


Checks to see if a specified plugin exists, and supports a specified routine.

For example:

If world.PluginSupports ("80cc18937a2aca27079567f0", "LogIt") <> eOK then
world.Note "Required 'LogIt' routine is not available"
End If

Available in MUSHclient version 3.23 onwards.

VBscript example

If world.PluginSupports ("80cc18937a2aca27079567f0", "LogIt") <> eOK then
  world.Note "Required 'LogIt' routine is not available"
End If

Jscript example

If (world.PluginSupports ("80cc18937a2aca27079567f0", "LogIt") != eOK)
  world.Note ("Required 'LogIt' routine is not available");

PerlScript example

if ($world->PluginSupports ("80cc18937a2aca27079567f0", "LogIt") != eOK)   
 $world->Note ("Required 'LogIt' routine is not available");

Python example

if world.PluginSupports ("80cc18937a2aca27079567f0", "LogIt") != 0:
  world.Note ("Required 'LogIt' routine is not available")

Lua example

if PluginSupports ("80cc18937a2aca27079567f0", "LogIt") ~= error_code.eOK then
  Note ("Required 'LogIt' routine is not available")

Return value

eNoSuchPlugin: Plugin not installed
eNoSuchRoutine: Specified routine cannot be found in that plugin
eOK: Called OK

View list of return code meanings

See Also ...




(BroadcastPlugin) Broadcasts a message to all installed plugins
(CallPlugin) Calls a routine in a plugin
(EnablePlugin) Enables or disables the specified plugin
(GetPluginID) Returns the 24-character ID of the current 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
(IsPluginInstalled) Checks to see if a particular plugin is installed
(LoadPlugin) Loads a plugin from disk
(ReloadPlugin) Reloads an installed plugin
(SaveState) Saves the state of the current plugin
(UnloadPlugin) Unloads an installed plugin

(Help topic: function=PluginSupports)

Documentation contents page

Search ...

Enter a search string to find matching documentation.

Search for:   

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]