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

MUSHclient scripting

Description of MUSHclient world function: world.GetTimer


Name GetTimer
Type Method
Summary Gets details about a timer
Prototype long GetTimer(BSTR TimerName, VARIANT* Hour, VARIANT* Minute, VARIANT* Second, VARIANT* ResponseText, VARIANT* Flags, VARIANT* ScriptName);

View list of data type meanings

Description

Gets details about the specified timer name.

See AddTimer for a description of the meanings of the fields.

This function does not appear to work when using Jscript or PerlScript, so if you are using those languages you should see GetTimerInfo instead. See below for how it works with Lua.

VBscript example
dim timername
dim timerhour
dim timerminute
dim timersecond
dim timerresponse
dim timerflags
dim timerscriptname
dim iStatus

iStatus = world.gettimer (timername, timerhour, timerminute, _
            timersecond, timerresponse, _
            timerflags, timerscriptname)
Jscript example
// Use GetTimerInfo when using Jscript
PerlScript example
# Use GetTimerInfo when using PerlScript
Python example
# Use GetTimerInfo when using Python
Lua example
local status

local hour
local minute
local second
local response
local flags
local scriptname

status, hour, minute, second, response, flags, scriptname = 
  GetTimer ("my_timer")

print (hour, minute, second, response, flags, scriptname)
Lua notes
Lua does not let you call by reference, however it can return multiple results.

Thus GetTimer is implemented to return the various fields as a multiple-return result, 
as shown in the example above.
Returns eInvalidObjectLabel: The timer name is not valid
eTimerNotFound: The named timer does not exist
eOK: completed OK

View list of return code meanings


See also ...

Function Description
AddTimer Adds a timer
DeleteTimer Deletes a timer
EnableTimer Enables or disables an timer
GetTimerInfo Gets details about a timer
GetTimerList Gets the list of timers
IsTimer Tests to see if a timer exists
ResetTimer Resets a named timer
ResetTimers Resets all 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]