world.IsTimer

MUSHclient script function (Method)

Tests to see if a timer exists

Prototype

long IsTimer(BSTR TimerName);

Data type meanings

Description

Used to test if a timer exists.

Note that this function returns 0 if the timer *exists*.

VBscript example

world.note world.IsTimer ("mytimer")

Jscript example

world.note(world.IsTimer("mytimer"));

PerlScript example

$world->note($world->IsTimer("mytimer"));

Python example

world.note(world.IsTimer("mytimer"))

Lua example

Note(IsTimer("mytimer"))

Return value

eInvalidObjectLabel: The timer name is not valid
eTimerNotFound: The named timer does not exist
eOK: completed OK - ie. The timer exists.

Return code meanings

Related topic

Timers

See also