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

MUSHclient scripting

Description of MUSHclient world function: world.PluginSupports

Name PluginSupports
Type Method
Summary Checks if a plugin supports a particular routine
Prototype 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

Note: Available in 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")
Returns eNoSuchPlugin: Plugin not installed
eNoSuchRoutine: Specified routine cannot be found in that plugin
eOK: Called OK

View list of return code meanings

Introduced in version 3.23

See also ...

Function Description
CallPlugin Calls a routine in a 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.
IsPluginInstalled Checks to see if a particular plugin is installed
LoadPlugin Loads a plugin from disk

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]