GetPluginTimerInfo
Script function

world.GetPluginTimerInfo

DOC_scripting Read about scripting

Type

Method

Summary

Gets details about a named timer for a specified plugin

Prototype

VARIANT GetPluginTimerInfo(BSTR PluginID, BSTR TimerName, short InfoType);

DOC_data_types View list of data type meanings

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)

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));


Python example

world.note(world.GetPluginTimerInfo   ("c8efc9f9e1edd118c6f2dbf5", "my_timer", 2))


Lua example

Note(GetPluginTimerInfo ("c8efc9f9e1edd118c6f2dbf5", "my_timer", 2))


Lua notes

Lua returns nil where applicable instead of an "empty variant" or "null variant".


Return value

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 ...

Topics

DOC_aliases Aliases
DOC_Arrays Arrays
DOC_plugins Plugins
DOC_scripting Scripting
DOC_timers Timers
DOC_triggers Triggers
DOC_variables Variables

Functions

FNC_AddTimer AddTimer (Adds a timer)
FNC_BroadcastPlugin BroadcastPlugin (Broadcasts a message to all installed plugins)
FNC_CallPlugin CallPlugin (Calls a routine in a plugin)
FNC_DeleteTimer DeleteTimer (Deletes a timer)
FNC_EnablePlugin EnablePlugin (Enables or disables the specified plugin)
FNC_GetPluginID GetPluginID (Returns the 24-character ID of the current plugin)
FNC_GetPluginInfo GetPluginInfo (Gets details about a specified plugin)
FNC_GetPluginList GetPluginList (Gets a list of installed plugins.)
FNC_GetPluginName GetPluginName (Returns the name of the current plugin)
FNC_GetPluginTimerList GetPluginTimerList (Gets the list of timers in a specified plugin)
FNC_GetPluginVariable GetPluginVariable (Gets the contents of a variable belonging to a plugin)
FNC_GetPluginVariableList GetPluginVariableList (Gets the list of variables in a specified plugin)
FNC_GetTimerInfo GetTimerInfo (Gets details about a timer)
FNC_GetTimerList GetTimerList (Gets the list of timers)
FNC_IsPluginInstalled IsPluginInstalled (Checks to see if a particular plugin is installed)
FNC_LoadPlugin LoadPlugin (Loads a plugin from disk)
FNC_PluginSupports PluginSupports (Checks if a plugin supports a particular routine)
FNC_ReloadPlugin ReloadPlugin (Reloads an installed plugin)
FNC_SaveState SaveState (Saves the state of the current plugin)

(Help topic: function=GetPluginTimerInfo)

DOC_contents Documentation contents page