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

MUSHclient scripting

Description of MUSHclient world function: world.GetPluginTimerInfo


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

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)


Note: Available in 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));
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".
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.
Introduced in version 3.23

See also ...

Function Description
AddTimer Adds a timer
DeleteTimer Deletes a timer
GetPluginTimerList Gets the list of timers in a specified plugin
GetTimerInfo Gets details about a timer
GetTimerList Gets the list of timers

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

[Back]

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.

[Home]


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]