Name GetPluginVariable
Type Method
Summary Gets the contents of a variable belonging to a plugin
Prototype VARIANT GetPluginVariable(BSTR PluginID, BSTR VariableName);
Description Gets the contents of the named variable for the nominated plugin. Each plugin has a unique ID - specify that ID to identify the plugin in question.

If the named variable does not exist, EMPTY is returned.

If the name given is invalid, NULL is returned.

If the nominated plugin does not exist, NULL is returned.

(Use "IsEmpty" and "IsNull" to test for these possibilities).

If you want to find the value of a variable in the current plugin, use "GetVariable".

If you are writing a plugin and want to find a "global" MUSHclient variable value, use an empty plugin ID, eg.

world.Note world.GetPluginVariable ("", "target")

Note: Available in MUSHclient version 3.23 onwards.
VBscript example 
dim MyName

MyName = world.GetPluginVariable ("a42fbf74f394d8129df956ae", "MyName")

if isempty (MyName) then
  world.note "My name is not defined"
end if

if isnull (MyName) then
  world.note "Invalid variable name"
end if

world.note MyName
Jscript example 
var MyName;

MyName = world.GetPluginVariable ("a42fbf74f394d8129df956ae", "MyName");

if (MyName == null)
  world.note("MyName is not defined");
else
  world.note(MyName);
PerlScript example 
$MyName = $world->GetPluginVariable ("a42fbf74f394d8129df956ae", "MyName");

if (!defined ($MyName)) 
  {
  $world->note ("MyName is not defined");
  }
else 
  {
  $world->note ($MyName);
  }
Returns The contents of the specified variable for the specified plugin.
An EMPTY variant, if the variable does not exist.
A NULL variant if the variable name is invalid, or the plugin is not installed.

See also ...