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

MUSHclient scripting

Description of MUSHclient world function: world.GetPluginTimerOption


Name GetPluginTimerOption
Type Method
Summary Gets the value of a named timer option for a specified plugin
Prototype VARIANT GetPluginTimerOption(BSTR PluginID, BSTR TimerName, BSTR OptionName);

View list of data type meanings

Description

Gets the current value of a timer option for the specified plugin.

You must specify a plugin ID, the name of an existing timer, and a timer option from the list given under the description for GetTimerOption. These are the same names as used in the XML world files for timer options.

If you want to find the value of an timer option in the current plugin, use "GetTimerOption".

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

world.Note world.GetPluginTimerOption ("", "my_timer", "enabled")


If the option name is not known, or is not allowed to be retrieved, a NULL variant is returned.

If the named timer does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the option name is not known, EMPTY is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities).

See GetTimerOption for a list of option names and values.


Note: Available in version 4.21 onwards.


VBscript example
Note GetPluginTimerOption("c8efc9f9e1edd118c6f2dbf5", "my_timer", "enabled")
Jscript example
Note (GetPluginTimerOption ("c8efc9f9e1edd118c6f2dbf5", "my_timer", "enabled"));
PerlScript example
/$world->Note ($world->GetPluginTimerOption ("c8efc9f9e1edd118c6f2dbf5", "my_timer", "enabled"));
Python example
world.Note(world.GetPluginTimerOption ("c8efc9f9e1edd118c6f2dbf5", "my_timer", "enabled"))
Lua example
Note (GetPluginTimerOption ("c8efc9f9e1edd118c6f2dbf5", "my_timer", "enabled"))
Lua notes
Lua returns nil where applicable instead of an "empty variant" or "null variant".
Returns As described above.
Introduced in version 4.21

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
GetTimerOption Gets the value of a named timer option

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]