@drincs/nqtr
Version:
A complete system introducing the concepts of location, time and event, producing the framework of a not-quite-point-and-click adventure game.
59 lines (57 loc) • 1.28 kB
TypeScript
type ITimeStlot = {
name: string;
startHour: number;
};
/**
* Time Settings, which can be set using {@link timeTracker.editSettings}
*/
type TimeSettings = {
/**
* Minimum hour of the day
* @default 0
*/
minDayHours?: number;
/**
* Maximum hour of the day
* @default 24
*/
maxDayHours?: number;
/**
* Default time spent
* @default 1
*/
defaultTimeSpent?: number;
/**
* Time slots
* @default []
* @example
* ```ts
* [
* { name: 'Morning', startHour: 5 },
* { name: 'Afternoon', startHour: 12 },
* { name: 'Evening', startHour: 18 },
* { name: 'Night', startHour: 22 }
* ]
*/
timeSlots?: ITimeStlot[];
/**
* Week length
* @default 7
*/
weekLength?: number;
/**
* Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6
* @default weekLength - 1
*/
weekendStartDay?: number;
/**
* Week days names
* @default []
* @example
* ```ts
* ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
* ```
*/
weekDaysNames?: string[];
};
export type { ITimeStlot, TimeSettings };