Class default

Hierarchy

default

Index

Constructors

Properties

dayLength dayPercent frozenTime?

Accessors

day dayStart ticks

Methods

clone getBrightness getDayQuarter getHour getHoursAndMinutes getMinute getPartOfDay getTime getTranslation isBefore isBetween isDay isFrozen isNight isPast nextTick restoreFromDayNight setTime

Constructors

constructor

new default(turns: number): default
Parameters
- turns: number
Returns default
- Defined in src/game/game/time/TimeManager.ts:67

Properties

dayLength

dayLength: number = 3200

dayPercent

dayPercent: number = .625

`Optional` frozenTime

frozenTime?: number

Accessors

day

get day(): number
Returns which day it is. Starts at 1.

Returns number
- Defined in src/game/game/time/TimeManager.ts:92

dayStart

get dayStart(): number
Returns number
- Defined in src/game/game/time/TimeManager.ts:63

ticks

get ticks(): number
The total number of ticks passed.

Returns number
- Defined in src/game/game/time/TimeManager.ts:85

Methods

clone

clone(): default
Returns a copy of this TimeManager as a new object

Returns default
- Defined in src/game/game/time/TimeManager.ts:74

getBrightness

getBrightness(time?: number): number
Returns how bright it is at the given time.
Parameters
- time: number = ...
  
  The time to use, defaulting to the current time.
Returns number
- Defined in src/game/game/time/TimeManager.ts:343

getDayQuarter

getDayQuarter(time?: number): DayQuarter
Returns the DayQuarter of the given time.
Parameters
- time: number = ...
  
  The time to use, defaulting to the current time.
Returns DayQuarter
- Defined in src/game/game/time/TimeManager.ts:263

getHour

getHour(time?: number, format?: TimeFormat): number
Returns the hour of the given time.
Parameters
- time: number = ...
  
  The time to use, defaulting to the current time.
  
  Internally calls getHourMinute
- format: TimeFormat = TimeFormat.TwelveHour
Returns number
- Defined in src/game/game/time/TimeManager.ts:199

getHoursAndMinutes

getHoursAndMinutes(time?: number): {
hour: number;
minute: number;
}
Returns the hours and minutes of the given time.
Parameters
- time: number = ...
  
  The time to use, defaulting to the current time.
Returns {
hour: number;
minute: number;
}
- hour: number
- minute: number
- Defined in src/game/game/time/TimeManager.ts:189

getMinute

getMinute(time?: number): number
Returns the minute of the given time.
Parameters
- time: number = ...
  
  The time to use, defaulting to the current time.
  
  Internally calls getHourMinute
Returns number
- Defined in src/game/game/time/TimeManager.ts:226

getPartOfDay

getPartOfDay(time?: number): PartOfDayGranular
Returns the PartOfDay of the given time.
Parameters
- time: number = ...
  
  The time to use, defaulting to the current time.
Returns PartOfDayGranular
- Defined in src/game/game/time/TimeManager.ts:234

getTime

getTime(tickOffset?: number): number
Returns a decimal representation of the current time. 0 is the start of the day, and 1 is the end.
Parameters
- tickOffset: number = 0
Returns number
- Defined in src/game/game/time/TimeManager.ts:119

getTranslation

getTranslation(time?: number, format?: TimeFormat): default
Returns a string representation of the given time.
Parameters
- time: number = ...
  
  The time to use, defaulting to the current time.
- format: TimeFormat = TimeFormat.TwelveHour
  
  The format to use, defaulting to TimeFormat.TwelveHour
Returns default
- Defined in src/game/game/time/TimeManager.ts:291

isBefore

isBefore(checkTime: string, time?: number): undefined | boolean
Checks if the given time is before a formatted time.
Parameters
- checkTime: string
  
  A formatted time.
- time: number = ...
  
  The time to check, defaulting to the current time.
Returns undefined | boolean
- Defined in src/game/game/time/TimeManager.ts:161

isBetween

isBetween(checkPast: string, checkBefore: string, currentTime?: number): undefined | boolean
Returns if the given time is between two formatted times.
Parameters
- checkPast: string
  
  A formatted time to check if the given time is after.
- checkBefore: string
  
  A formatted time to check if the given time is before.
- currentTime: number = ...
Returns undefined | boolean
- Defined in src/game/game/time/TimeManager.ts:181

isDay

isDay(time?: number): boolean
Returns if the given time is at day.
Parameters
- time: number = ...
  
  The time to check, defaulting to the current time.
Returns boolean
- Defined in src/game/game/time/TimeManager.ts:127

isFrozen

isFrozen(): boolean
Returns whether time is frozen.

Returns boolean
- Defined in src/game/game/time/TimeManager.ts:99

isNight

isNight(time?: number): boolean
Returns if the given time is at night.
Parameters
- time: number = ...
  
  The time to check, defaulting to the current time.
Returns boolean
- Defined in src/game/game/time/TimeManager.ts:135

isPast

isPast(checkTime: string, time?: number): undefined | boolean
Checks if the given time is after a formatted time.
Parameters
- checkTime: string
  
  A formatted time.
- time: number = ...
  
  The time to check, defaulting to the current time.
Returns undefined | boolean
- Defined in src/game/game/time/TimeManager.ts:144

nextTick

nextTick(amount?: number): void
Increments ticks.
Parameters
- amount: number = 1
Returns void
- Defined in src/game/game/time/TimeManager.ts:106

restoreFromDayNight

restoreFromDayNight(dayNight: number, dayNightSwitch: 0 | 1): void
Sets the current time from a dayNight number and a boolean flag of whether it's day or night.

Used exclusively for save conversion.
Parameters
- dayNight: number
- dayNightSwitch: 0 | 1
Returns void
- Defined in src/game/game/time/TimeManager.ts:370

setTime

setTime(time: number): default
Sets the time.
Parameters
- time: number
  
  A number between 0 and 1, where 0 is the start of the day and 1 is the end.
  
  Setting the time with the result of getTime will likely not set to the same value. This method is provided for save conversion and utility, and should rarely be used.
Returns default
- Defined in src/game/game/time/TimeManager.ts:387

Generated using TypeDoc