ClockEventclass | subtime.t[527]

Clock-setting plot event. This object represents a plot point that occurs at a particular time in the story world. Create one of these for each of your plot events. The Clock Manager automatically builds a list of all of these objects during pre-initialization, so you don't have to explicitly tell the clock manager about these.

Whenever the story reaches one of these events, you should call the eventReached() method of the event object. This will set the clock time to the event's current time, and take note of how long we have until the next plot event. [DEFINED IN SUBTIME EXTENSION]

`class ClockEvent : object`

Superclass Tree (in declaration order)

`ClockEvent`
`object`

Subclass Tree

(none)

Global Objects

(none)

Summary of Properties

`eventDate eventTime hasBeenReached reachedWhen scaleFactor turnsToEvent`

Summary of Methods

`calcScaleFactor eventReached formatTime`

Properties

`eventDate` | `subtime.t[540]`

This is the eventTime expressed as a Date object

`eventTime` | `subtime.t[537]`

The time at which this event occurs. This is expressed as a list with three elements: the day number, the hour (on a 24-hour clock), and the minute. The day number is relative to the start of the game - day 1 is the first day of the game. So, for example, to express 2:40pm on the second day of the game, you'd write [2,14,40]. Note that 12 AM is written as 0 (zero) on a 24-hour clock, so 12:05am on day 1 would be [1,0,5].

`hasBeenReached` | `subtime.t[618]`

Flag: has this event been reached? This is used internally by the library and shouldn't normally be changed in game code. [SUBTIME EXTENSION]

`reachedWhen` | `subtime.t[611]`

A condition (or a method that returns true or nil) that causes this event to be reached when it becomes true. This provides an alternative way of reaching events (instead of calling the eventReached method). [SUBTIME EXTENSION]

`scaleFactor` | `subtime.t[570]`

This is the number of minutes per hundred turns when we have unlimited time until this next event. This number is pretty arbitrary, since we're depending so much on the player's uncertainty about just how long things take, and also because we'll adjust it anyway when we're running out of time before the next event. Even so, you might want to adjust this value up or down according to your sense of the pacing of your game.

Alternatively you can define the turnsToEvent property (see below) and the game will calculate an appropriate scaleFactor for you. [SUBTIME EXTENSION]

`turnsToEvent` | `subtime.t[579]`

Optional: if specified this should contain an estimate of the number of turns a player is typically likely to take to get to this event from the previous one; the game will then calculate an appropriate scaleFactor. Alternatively this can be left at nil and the scaleFactor specified directly. [SUBTIME EXTENSION]

Methods

`calcScaleFactor ( )` | `subtime.t[586]`

If the turnsToEvent property is not nil and the clockManager has recorded a previous event, calculate the scaleFactor for this event. [SUBTIME EXTENSION]

`eventReached ( )` | `subtime.t[551]`

Notify the clock manager that this event has just occurred. This sets the game clock to the event's time. The game code must call this method when our point in the plot is reached.

`formatTime (fmt)` | `subtime.t[543]`

get a formatted version of the event time

Adv3Lite Library Reference Manual
Generated on 15/03/2023 from adv3Lite version 1.6.1