Skip to main content
Version: Next

Interface: TimeData

Interface for all information about time

Extends​

  • IDataItemBase

Properties​

abbreviation?​

optional abbreviation: string

The abbreviated name of the data item.

Inherited from​

IDataItemBase.abbreviation

description?​

optional description: string

The optional description of the data item

Inherited from​

IDataItemBase.description

gameTimeRatio​

gameTimeRatio: number

When running the clock for every second that passes in the real world how many seconds pass in game.

hoursInDay​

hoursInDay: number

The number of hours in a single day.

id​

id: string

The unique ID of the data item

Inherited from​

IDataItemBase.id

minutesInHour​

minutesInHour: number

The number of minutes in a single hour.

name?​

optional name: string

The optional name of the data item

Inherited from​

IDataItemBase.name

numericRepresentation?​

optional numericRepresentation: number

The optional numeric representation of the data item

Inherited from​

IDataItemBase.numericRepresentation

secondsInMinute​

secondsInMinute: number

The number of seconds in a single minute.

showAdvanced?​

optional showAdvanced: boolean

If to show the advanced options, this is not saved

Inherited from​

IDataItemBase.showAdvanced

unifyGameAndClockPause​

unifyGameAndClockPause: boolean

If to start/stop the clock when the game is unpaused/paused.

updateFrequency​

updateFrequency: number

How often (in real world seconds) to update the time while the clock is running.