Name GetPluginTimerInfo
Type Method
Summary Gets details about a named timer for a specified plugin
Prototype VARIANT GetPluginTimerInfo(BSTR PluginID, BSTR TimerName, short InfoType);
Description Gets details about the specified timer for the specified plugin.

You can obtain various "types" of information about the timer by specifying an "InfoType". The possible InfoTypes are described under GetTimerInfo.

If the named timer does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the InfoType given is out of range, NULL is returned. If the 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 timer in the current plugin, use "GetTimerInfo".

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

world.Note world.GetPlugintimerInfo ("", "my_timer", 1)

Note: Available in MUSHclient version 3.23 onwards.
VBscript example 
world.note world.GetPluginTimerInfo ("c8efc9f9e1edd118c6f2dbf5", "my_timer", 2)
Jscript example 
world.note(world.GetPluginTimerInfo   ("c8efc9f9e1edd118c6f2dbf5", "my_timer", 2));
PerlScript example 
$world->note ($world->GetPluginTimerInfo   ("c8efc9f9e1edd118c6f2dbf5", "my_timer", 2));
Returns The specified information about the timer, as described above.
An EMPTY variant, if the timer does not exist.
A NULL variant if the timer name is invalid.
A NULL variant if the InfoType is not a valid type.
A NULL variant if the plugin is not installed.

See also ...