GetTimer
Script function

world.GetTimer

DOC_scripting Read about scripting

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

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


Return value

eInvalidObjectLabel: The timer name is not valid
eTimerNotFound: The named timer does not exist
eOK: completed OK


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_aliases Aliases
DOC_defaults Default triggers/aliases/timers/macros/colours
DOC_starting Getting started
DOC_group Groups
DOC_plugins Plugins
DOC_timers Timers
DOC_triggers Triggers

Functions

FNC_AddTimer AddTimer (Adds a timer)
FNC_DeleteTemporaryTimers DeleteTemporaryTimers (Deletes all temporary timers)
FNC_DeleteTimer DeleteTimer (Deletes a timer)
FNC_DeleteTimerGroup DeleteTimerGroup (Deletes a group of timers)
FNC_DoAfter DoAfter (Adds a one-shot, temporary timer - simplified interface)
FNC_DoAfterSpecial DoAfterSpecial (Adds a one-shot, temporary, timer to carry out some special action)
FNC_DoAfterSpeedWalk DoAfterSpeedWalk (Adds a one-shot, temporary speedwalk timer - simplified interface)
FNC_EnableTimer EnableTimer (Enables or disables an timer)
FNC_EnableTimerGroup EnableTimerGroup (Enables/disables a group of timers)
FNC_GetTimerInfo GetTimerInfo (Gets details about a timer)
FNC_GetTimerList GetTimerList (Gets the list of timers)
FNC_GetTimerOption GetTimerOption (Gets the value of a named timer option)
FNC_IsTimer IsTimer (Tests to see if a timer exists)
FNC_ResetTimer ResetTimer (Resets a named timer)
FNC_ResetTimers ResetTimers (Resets all timers)
FNC_SetTimerOption SetTimerOption (Sets the value of a named timer option)

(Help topic: function=GetTimer)

DOC_contents Documentation contents page