TimeFuse class | objtime.t[260]

A TimeFuse is a Fuse that executes either at a set time or after a set time

obj and prop are the same as for Fuse, i.e. when the Fuse fires it will call the prop property of obj.

interval may be speficied as a list, an integer, a BigNumber, a Date or a single-quoted string. A string or a Date specifies the time at which the Fuse will execute. Anything else specifies the time after which the Fuse will execute.

If interval is a list it should be in the form [years, months, days, hours, minutes, seconds] (trailing elements can be omitted if they are zero). The Fuse will then execute after the interval

If interval is an integer then it specifies the number of minutes into the future that the Fuse will execute.

If interval is a BigNumber than it specifies the number of hours into the future that the Fuse will execute. E.g. 1.0 specifies 1 hour, while 2.5 specifies 2 hours 30 minutes.

If interval is a single-quoted String, then it specifies the time at which the Fuse will execute. The format may be any of the formats recognized by Date.parseDate (for which see the System Manual). For example '15:34' would specify that the Fuse is to execute at 15:34 on the current day, while '2014:06:22 15:34:00' would specify that the Fuse is to execute at 15:34 on 22nd June 2014 (game time, not real time).

[PART OF THE OBJTIME EXTENSION]

`class TimeFuse : Fuse`

Superclass Tree (in declaration order)

`TimeFuse`
`Fuse`
`Event`
`object`

Subclass Tree

`TimeFuse`
`SenseTimeFuse`

Global Objects

(none)

Summary of Properties

`eventTime`

``

Inherited from `Event` :
`captureText eventOrder executed interval_ isPromptDaemon nextRunTime obj_ prop_ senseObj_ senseProp_`

Summary of Methods

`construct getNextRunTime`

Inherited from `Fuse` :
`executeEvent`

Inherited from `Event` :
`callMethod delayEvent eventMatches removeEvent`

Properties

`eventTime` | `objtime.t[301]`

The time (as a Date object) at which this Fuse is set to activate

Methods

`construct (obj, prop, interval)`OVERRIDDEN | `objtime.t[261]`

no description available

`getNextRunTime ( )`OVERRIDDEN | `objtime.t[308]`

If our eventTime is still in the future, return a turn count well into the future so we don't execute yet; otherwise return the current turn count so we do execute on this turn.

Adv3Lite Library Reference Manual
Generated on 26/02/2025 from adv3Lite version 2.2