TIMER TICKER FOR JMC
For JMC version 3.26 with VBScript
(c) Rashnak 2004 (Special thanks to Björn for testing this)

VERSION HISTORY:

  2004-08-12    The script appeared to behave badly when local time changes
                from 23:59:59 to 00:00:00 at midnight. This is fixed.

  2004-08-08    "Session" timer will no longer flash in status box.

  2004-08-08    New addition contains records of dawn and dusk hours for each
                month and an improved trigger for displaying them together
                with Time timer:

                  #action {/^(.+), the (\d{1,2})(st|nd|rd|th) of (.*), Year (\d{1,4}) of the (.+) Age.$/} {#script timeAction "", "", "%1", "%2", "%3", "%4", "%5"}
                  #action {/^(\d{1,2})(am|pm) on (.+), the (\d{1,2})(st|nd|rd|th) of (.*), Year (\d{1,4}) of the (.+) Age.$/} {#script timeAction "%0", "%1", "%2", "%3", "%5", "%6", "%7"}
                  #action {/^According to the (Dúnadan|Sindarin) calendar, it is:$/} {#showme Time on Arda is $timerTime. Dawn: $timeMonthDawn Dusk: $timeMonthDusk}

                You have to check time on MUME once to capture the current
                month name, before the above action starts to work properly.

  2004-08-07    In the script the difference between two times is calculated
                by taking the 'seconds' field of two time values and
                substracting them. For example, if T1 = 18:00.9 and T2 =
                18:01.0, the script would calculate the difference as one whole
                second, when in fact it is only about 0.1 of a second.

                This and future versions contain another timer mechanism to
                measure times at resolution of 0.1 second "ticks". The actual
                length of these ticks may not be exactly 0.1 seconds, but at
                0 - 5 second range the difference should be minimal. The same
                command interface can be used for these timers, like this:

                  timer Test 1.5 - #showme Moi!

                Sets a countdown timer of 1.5 seconds (instead of 1:05 you
                must use 1.5 format). To start from zero, use 0.0.

  2004-08-07    When a countdown timer reaches zero, any commands it is set
                to execute will execute once, after which the commands are
                now cleared from the timer. Unless one of these commands was
                to delete the timer, the timer itself will continue to run on
                the negative side though. This was a quick hack to prevent
                a possible problem that sometimes made the script miss timer
                reaching zero value.

  2004-08-06    Bug in 2004-08-05 version that caused error message with the
                following command syntax was fixed:

                  timer <label> <time>

  2004-08-05    Special label "Time" that will reset to 00:00 when it reaches
                24:00. The script does not set up this timer though, so you
                have to initialize it yourself.

  2004-08-05    It is now possible to adjust a timer without resetting it.
                Examples:
                
                  timer Time +01:00
                  timer Time -00:05

  2004-08-04    First version.



DOCUMENTATION

This script can be used to set and display timers. In addition to displaying
the running timers manually, the timers will rotate in one of the status boxes
in bottom part of JMC window.

You can set each timer with unique label and running parameters, and they
are programmable to execute commands when they reach zero.

The timers are mainly designed for minute and second resolution (mm:ss). If a
value exceeds 90 minutes, the script will display hours and minutes (hh:mm)
instead.

There is also an integrated mechanism to measure times with ticks of 0.1 second
resolution.

Typically this script would be used to time zone repops or spell durations or
measure your hit speed or other short term effects.

When the script is loaded, it sets one timer labeled "Session" which will
measure your playing session. The timers do not persist over client restarts
though.

Another special label is "Time". This timer will reset to 00:00 every time
it reaches 24:00. You have to set up this timer yourself though. If you have
it running, it will display time at every full hour.

In addition to the VBScript code later in this document, you need to set
this alias:

#alias timer {#script timerSet "%0"}

Syntax:

  >timer <label> <parameters>

Below are some examples.

To set a timer to run forward from 00:00, use this syntax:

  >timer MyTimer

To delete the timer:

  >timer MyTimer delete

To delete all timers:

  >timer * delete

To set a timer to run forward from a given time:

  >timer MyTimer 5:00

Leaving the seconds part out assumes minutes, thus the following two commands
would be equal

  >timer MyTimer 5
  >timer MyTimer 5:00

If you want to count down from a given time, append a minus sign.

  >timer MyTimer 30:00 -

To run a command when timer reaches zero:

  >timer Dinner 45:00 - #showme Dinner is ready!\;#bell\;timer Dinner delete

Notice the escaped command separators. If you use different separator, you
have to change it in the settings part of the VBScript code.

To set a high resolution timer for 1.5 seconds:

  >timer HighRes 1.5 -

To display list of all active timers:

  >timer 

Time   Label
-----  -----
44:55- MyTimer (#showme Dinner is ready!)
00.20- HighRes

The script also defines and updates a JMC variable for each timer, that can be
accessed from other JMC commands. Some examples:

#action {^You start glowing.} {timer Sanctuary}
#action {^The white aura around your body fades.} {timer Sanctuary delete;#showme Sanctuary lasted $timerSanctuary}
#action {^According to the Dúnadan calendar, it is:} {#showme Time on Arda is $timerTime}

The last of the above actions only works if you have properly set up and
synchronized a timer labelled "Time".

This may help synchronizing it when looking at a clock on MUME:

#action {/^The current time is (.*) am.$/} {timer Time %0}
#action {/^The current time is (.*) pm.$/} {timer Time %0;timer Time +12:00}

However, the above does not work properly if looking at a clock between midnight
and 1am, because MUME displays it as "12:XX am" instead of "00:XX am".

If the command interface is too complicated, you can create your own aliases
to set timers, like this:

#alias {alarm %1 %2} {timer Alarm %1 - #showme %2}

  >alarm 0:10 Moi!

The following VBScript code goes into file "settings\commonlib.scr".

If you experience any compatibility problems with your existing scripts,
feel free to ask me on MUME.

Note:

In your JMC directory there is a subdirectory named "settings".

In that subdirectory, there is a plain text file named commonlib.scr.

If there is no such file, you can create it with Notepad.

Add the code below to this file.

'*******************************************************
' TIMER TICKER: VBSCRIPT CODE STARTS HERE
'*******************************************************

'*******************************************************
' TIMER TICKER: Settings
'*******************************************************

' Which status box to use(1-3):
Dim timerStatusBox
timerStatusBox = 3

' JMC timer IDs
' !!! Change these if you have the ID numbers reserved by other script
Dim timerTimerID
Dim timerTimerIDTenth
timerTimerID   = 2
timerTimerID10 = 3

' Your command separator
Dim timerCommandSeparator
timerCommandSeparator = ";"

'*******************************************************
' TIMER TICKER: Internal definitions and initialization
'*******************************************************

dim timeMonth
timeMonth = ""

Set monthNames = CreateObject("Scripting.Dictionary")
Set monthData = CreateObject("Scripting.Dictionary")

' Westron names
monthNames.add "Afteryule",   1
monthNames.add "Solmath",     2
monthNames.add "Rethe",       3
monthNames.add "Astron",      4
monthNames.add "Thrimidge",   5
monthNames.add "Forelithe",   6
monthNames.add "Afterlithe",  7
monthNames.add "Wedmath",     8
monthNames.add "Halimath",    9
monthNames.add "Winterfilth", 10
monthNames.add "Blotmath",    11
monthNames.add "Foreyule",    12

' Sindarin names
monthNames.add "Narwain",   1
monthNames.add "Nínui",     2
monthNames.add "Gwaeron",   3
monthNames.add "Gwirith",   4
monthNames.add "Lothron",   5
monthNames.add "Nórui",     6
monthNames.add "Cerveth",   7
monthNames.add "Úrui",      8
monthNames.add "Ivanneth",  9
monthNames.add "Narbeleth", 10
monthNames.add "Hithui",    11
monthNames.add "Birithron", 12

' Times of dawn: Westron
monthData.item("Afteryule.dawn")   = 8
monthData.item("Solmath.dawn")     = 9
monthData.item("Rethe.dawn")       = 8
monthData.item("Astron.dawn")      = 7
monthData.item("Thrimidge.dawn")   = 7
monthData.item("Forelithe.dawn")   = 6
monthData.item("Afterlithe.dawn")  = 5
monthData.item("Wedmath.dawn")     = 4
monthData.item("Halimath.dawn")    = 5
monthData.item("Winterfilth.dawn") = 6
monthData.item("Blotmath.dawn")    = 7
monthData.item("Foreyule.dawn")    = 7
monthData.item("Nínui.dawn")       = 9
monthData.item("Nórui.dawn")       = 6
monthData.item("Úrui.dawn")        = 4
monthData.item("Narbeleth.dawn")   = 6

' Times of dawn: Sindarin
monthData.item("Narwain.dawn")   = 8
monthData.item("Nínui.dawn")     = 9
monthData.item("Gwaeron.dawn")   = 8
monthData.item("Gwirith.dawn")   = 7
monthData.item("Lothron.dawn")   = 7
monthData.item("Nórui.dawn")     = 6
monthData.item("Cerveth.dawn")   = 5
monthData.item("Úrui.dawn")      = 4
monthData.item("Ivanneth.dawn")  = 5
monthData.item("Narbeleth.dawn") = 6
monthData.item("Hithui.dawn")    = 7
monthData.item("Birithron.dawn") = 7

' Times of dusk: Westron
monthData.item("Afteryule.dusk")   = 18
monthData.item("Solmath.dusk")     = 17
monthData.item("Rethe.dusk")       = 18
monthData.item("Astron.dusk")      = 19
monthData.item("Thrimidge.dusk")   = 20
monthData.item("Forelithe.dusk")   = 20
monthData.item("Afterlithe.dusk")  = 21
monthData.item("Wedmath.dusk")     = 22
monthData.item("Halimath.dusk")    = 21
monthData.item("Winterfilth.dusk") = 20
monthData.item("Blotmath.dusk")    = 20
monthData.item("Foreyule.dusk")    = 19
monthData.item("Nínui.dusk")       = 17
monthData.item("Nórui.dusk")       = 20
monthData.item("Úrui.dusk")        = 22
monthData.item("Narbeleth.dusk")   = 20

' Times of dusk: Sindarin
monthData.item("Narwain.dusk")   = 18
monthData.item("Nínui.dusk")     = 17
monthData.item("Gwaeron.dusk")   = 18
monthData.item("Gwirith.dusk")   = 19
monthData.item("Lothron.dusk")   = 20
monthData.item("Nórui.dusk")     = 20
monthData.item("Cerveth.dusk")   = 21
monthData.item("Úrui.dusk")      = 22
monthData.item("Ivanneth.dusk")  = 21
monthData.item("Narbeleth.dusk") = 20
monthData.item("Hithui.dusk")    = 20
monthData.item("Birithron.dusk") = 19

' Timer structures
Set timerTimers = CreateObject("Scripting.Dictionary")
Set timerData = CreateObject("Scripting.Dictionary")
dim timerTickerId
timerTickerId = 0

' High resolution timer structures
Set timerTimers10 = CreateObject("Scripting.Dictionary")
Set timerData10 = CreateObject("Scripting.Dictionary")
dim timerTicks
timerTicks = 0

' Initialize timers
timerInitialize Time

' Start timers
Jmc.SetTimer timerTimerID, 10
Jmc.SetTimer timerTimerID10, 1


'*******************************************************
' TIME: timeAction
' Receive information about time
'******************************************************
Sub timeAction (pHour, pAmPm, pWeekday, pDay, pMonth, pYear, pAge)
  dim tHour, tDawn, tDusk
  timeMonth = pMonth
  tDawn = monthData.item(timeMonth & ".dawn")
  tDusk = monthData.item(timeMonth & ".dusk")
  jmc.setvar "timeMonthDawn", tDawn
  jmc.setvar "timeMonthDusk", tDusk
  tHour = 0
  if (pHour <> "") then
    tHour = pHour
    if (tHour = 12) then tHour = 0
    if (pAmPm = "pm") then tHour = tHour + 12
  end if
End Sub

'*******************************************************
' TIMER TICKER: timerInitialize
'******************************************************
Sub timerInitialize(tSession)
  timerTicks = 0
  timerTimers.removeall
  timerData.removeall
  timerTimers.add "Session", "Session"
  timerData.add "Session.t", tSession
  timerData.add "Session.dir", +1
  timerData.add "Session.offset", 0
  timerData.add "Session.action", ""

  timerTimers10.removeall
  timerData10.removeall
End Sub


'*******************************************************
' TIMER TICKER: timerEvent10
' Event that occurs every 1/10 seconds
'******************************************************
Sub timerEvent10
  timerTicks = timerTicks + 1
  if (timerTicks > 10*60*60*24) then timerTicks = 0

  timers = timerTimers10.Keys
  timerCount = timertimers10.Count
  For i = 0 To timerCount-1
    label = timers(i)
    if (timerTimers10.item(label) = "*DELETED*") then
      timerTimers10.remove(label)
      timerData10.remove(label & ".t")
      timerData10.remove(label & ".dir")
      timerData10.remove(label & ".offset")
      timerData10.remove(label & ".action")
    else
      ticksElapsed = timerTicks - timerData10.item(label & ".t")
      if (timerData10.item(label & ".dir") = -1) then
        ticksElapsed = timerData10.item(label & ".offset") - ticksElapsed
        if (ticksElapsed <= 0) then
          action = timerData10.item(label & ".action")
          if (action <> "") then
            jmc.parse action
            timerData10.item(label & ".action") = ""
          end if
        end if
      end if
      sTime = timerEncode10(ticksElapsed)
      jmc.setvar "timer" & label, sTime
    end if
  Next
End Sub

'*******************************************************
' TIMER TICKER: timerEvent
' Event that occurs once every second
'******************************************************
Sub timerEvent
  dim statusText
  statusText = ""
  ' LOOP THE TIMER LIST
  timers = timerTimers.Keys
  timerCount = timertimers.Count
  For i = 0 To timerCount-1
    label = timers(i)
    dir = timerData.item(label & ".dir")
    secondsElapsed = datediff("s", timerData.item(label & ".t"), Time)
    bMid = 0
    if (secondsElapsed < 0) then
      ' Midnight hack:
      bMid = datediff("s", timerData.item(label & ".t"), TimeValue("23:59:59")) + 1
      timerData.item(label & ".t") = TimeValue("00:00:00")
      secondsElapsed = datediff("s", timerData.item(label & ".t"), Time)
      timerData.item(label & ".offset") = timerData.item(label & ".offset") + (dir * bMid)
    end if
    offset = timerData.item(label & ".offset")
    if (dir = -1) then
      secondsElapsed = offset - secondsElapsed
      if (secondsElapsed <= 0) then
        action = timerData.item(label & ".action")
        if (action <> "") then
          jmc.parse action
          timerData.item(label & ".action") = ""
        end if
      end if
    else
      if (offset <> 0) then
        secondsElapsed = offset + secondsElapsed
      end if
    end if
    if (label = "Time") then
      if (secondsElapsed >= 24*60) then
        timerData.item(label & ".t") = Time
        timerData.item(label & ".offset") = 0
        secondsElapsed = 0
      end if
      if (int(secondsElapsed/60) = (secondsElapsed/60)) then
        ' At full hour display time
        jmc.showme "Time on Arda is " & timerEncode(secondsElapsed)
      end if
    end if
    sTime = timerEncode(secondsElapsed)
    jmc.setvar "timer" & label, sTime
    if (i = timerTickerId) then
      if (label = "Session") then
        timerTickerId = timerTickerId + 1
        if (timerTickerId >= timerCount) then
          timerTickerId = 0
        end if
      else
        sDir = " "
        if (dir = -1) then
          sDir = "-"
        end if
        jmc.SetStatus timerStatusBox, sTime & sDir & " " & label
      end if
    end if
  Next
  timerTickerId = timerTickerId + 1
  if (timerTickerId >= timerCount) then
    timerTickerId = 0
  end if
End Sub

'*******************************************************
' TIMER TICKER: timerEncode
' Formats seconds to mm:ss
'******************************************************
Function timerEncode(secs)
  dim mins
  s = abs(secs)
  mins = fix(s / 60)
  s = s - (60 * mins)
  if (mins < 10 and mins >= 0) then
    mins = "0" & mins
  end if
  if (s < 10) then
    s = "0" & s
  end if
  ret = mins & ":" & s

  if (mins > 90) then
    ' use hh:mm instead
    hours = fix(mins / 60)
    mins = mins - (60 * hours)
    if (mins < 10 and mins >= 0) then
      mins = "0" & mins
    end if
    if (hours < 10) then
      hours = "0" & hours
    end if
    ret = hours & ":" & mins
  end if

  if (secs < 0) then
    ret = "-" & ret
  else
    ret = " " & ret
  end if
  timerEncode = ret
End Function

'*******************************************************
' TIMER TICKER: timerEncode10
' Formats ticks to ss:xx
'******************************************************
Function timerEncode10(ticks)
  dim secs, s
  s = abs(ticks)
  secs = fix(s / 10)
  s = s - (10 * secs)
  if (secs < 10 and secs>= 0) then
    secs = "0" & secs
  end if
  s = s & "0"
  ret = secs & "." & s

  if (ticks < 0) then
    ret = "-" & ret
  else
    ret = " " & ret
  end if
  timerEncode10 = ret
End Function

'*******************************************************
' TIMER TICKER: timerDecode
' Formats mm:ss to seconds
'******************************************************
Function timerDecode(minsec)
  dim mins
  dim secs
  dim arr
  if (isnumeric(minsec)) then
    secs = 60 * minsec
  else
    arr = Split(minsec, ":", -1, 1)
    mins = arr(0)
    secs = arr(1)
    secs = secs + (60 * mins)
  end if
  timerDecode = secs
End Function

'*******************************************************
' TIMER TICKER: timerDecode10
' Formats ss:xx to xx ticks
'******************************************************
Function timerDecode10(secticks)
  dim secs
  dim ticks
  dim arr
  if (isnumeric(secticks)) then
    ticks = secticks
  else
    arr = Split(secticks, ".", -1, 1)
    secs = arr(0)
    ticks = arr(1)
    ticks = ticks + (10 * secs)
  end if
  timerDecode10 = ticks
End Function

'*******************************************************
' TIMER TICKER: timerDisplay
' Displays all timers
'******************************************************
Sub timerDisplay
  ' LOOP THE TIMER LIST
  timers = timerTimers.Keys
  timerCount = timerTimers.Count-1
  jmc.showme " Time   Label"
  jmc.showme " -----  -----"
  For i = 0 To timerCount
    label = timers(i)
    dir = timerData.item(label & ".dir")
    secondsElapsed = datediff("s", timerData.item(label & ".t"), Time)
    offset = timerData.item(label & ".offset")
    timerAction = timerData.item(label & ".action")
    if (dir = -1) then
      secondsElapsed = offset - secondsElapsed
    else
      if (offset <> 0) then
        secondsElapsed = offset + secondsElapsed
      end if
    end if
    sTime = timerEncode(secondsElapsed)
    sDir = " "
    if (dir = -1) then
      sDir = "-"
    end if
    sAction = ""
    if (timerAction <> "") then
      sAction = " (" & timerAction & ")"
    end if
    jmc.showme sTime & sDir & " " & label & sAction
  Next
  timers = timerTimers10.Keys
  timerCount = timerTimers10.Count-1
  For i = 0 To timerCount
    label = timers(i)
    ticksElapsed = timerTicks - timerData10.item(label & ".t")
    dir = timerData10.item(label & ".dir")
    offset = timerData10.item(label & ".offset")
    timerAction = timerData10.item(label & ".action")
    if (dir = -1) then
      ticksElapsed = offset - ticksElapsed
    else
      if (offset <> 0) then
        ticksElapsed = offset + ticksElapsed
      end if
    end if
    sTime = timerEncode10(ticksElapsed)
    sDir = " "
    if (dir = -1) then
      sDir = "-"
    end if
    sAction = ""
    if (timerAction <> "") then
      sAction = " (" & timerAction & ")"
    end if
    jmc.showme sTime & sDir & " " & label & sAction
  Next
  jmc.showme ""
End Sub

'*******************************************************
' TIMER TICKER: timerSet
' Main interface
'   timer <label> <parameters>
'   timer * delete
'******************************************************
Sub timerSet (line)
  dim regEx, label, dir, offset, cmd, action, highres
  dir = +1
  label = "NoLabel"
  offset = 0
  action = ""
  cmd = "add"
  highres = 0

  ' Parse parameters
  Set regEx = New RegExp
  regEx.Pattern = "\s"
  if (not regEx.test(line)) then
    ' Zero or one parameters
    if (line = "") then
      ' Zero parameters
      timerDisplay
      exit sub
    end if
    ' One parameter
    cmd = "add"
    label = line
    dir = +1
    offset = 0
  else
    ' Two or more parameters
    lineArr = Split(line, " ", 2)
    label = lineArr(0)
    param2 = lineArr(1)

    if (param2 = "delete") then
      if (label = "*") then
        tSession = timerData.item("Session.t")
        timerInitialize(tSession)
      else
        if (timerTimers.exists(label)) then
          timerTimers.remove(label)
          timerData.remove(label & ".t")
          timerData.remove(label & ".dir")
          timerData.remove(label & ".offset")
          timerData.remove(label & ".action")
        end if
        if (timerTimers10.exists(label)) then
          timerTimers10.item(label) = "*DELETED*"
        end if
      end if
      exit sub
    end if

    if (not regEx.test(param2)) then
      ' Two parameters (timer MyTimer 1:00)
      firstChar = left(param2, 1)
      if (firstChar = "+" or firstChar = "-") then
        offset = timerData.item(label & ".offset")
        param2 = right(param2, len(param2) -1)
        if (firstChar = "+") then
          ' Increase offset
          if (inStr(param2, ".")) then
            highres = 1
            offset = offset + timerDecode10(param2)
          else
            offset = offset + timerDecode(param2)
          end if
        end if
        if (firstChar = "-") then
          ' Decrease offset
          if (inStr(param2, ".")) then
            highres = 1
            offset = offset - timerDecode10(param2)
          else
            offset = offset - timerDecode(param2)
          end if
        end if
        timerData.item(label & ".offset") = offset
        exit sub
      end if
      ' Set new offset
      if (inStr(param2, ".")) then
        highres = 1
        offset = timerDecode10(param2)
      else
        offset = timerDecode(param2)
      end if
      dir = +1
    else
      ' Three or more parameters (timer MyTimer 1:00 -)
      lineArr = Split(param2, " ", 2)
      param2 = lineArr(0)
      param3 = lineArr(1)
      if (inStr(param2, ".")) then
        highres = 1
        offset = timerDecode10(param2)
      else
        offset = timerDecode(param2)
      end if
      dir = +1
      if (not regEx.test(param3)) then
        ' Three parameters (timer MyTimer 1:00 -)
      else
        ' Four parameters (timer MyTimer 45:00 - #showme Dinner\;timer Dinner delete)
        lineArr = Split(param3, " ", 2)
        param3 = lineArr(0)
        param4 = lineArr(1)
        action = param4
        action = replace(action, "\" & timerCommandSeparator, timerCommandSeparator)
      end if
      if (param3 = "-") then
        dir = -1
      end if
    end if   
  end if
  if (highres = 1) then
    ' set timer
    timerData10.item(label & ".t") = timerTicks
    timerData10.item(label & ".dir") = dir
    timerData10.item(label & ".offset") = offset
    timerData10.item(label & ".action") = action
    timerTimers10.item(label) = label
  else
    ' set timer
    timerData.item(label & ".t") = time
    timerData.item(label & ".dir") = dir
    timerData.item(label & ".offset") = offset
    timerData.item(label & ".action") = action
    timerTimers.item(label) = label
  end if
End Sub

'*******************************************************
' TIMER TICKER: Jmc_Timer
' If you have this Timer event used in other scripts,
' copy the code inside this event to there instead
' and delete this event.
'******************************************************
Sub Jmc_Timer (id)
  if (id = timerTimerID) then
    timerEvent
  end if
  if (id = timerTimerID10) then
    timerEvent10
  end if
End Sub