Time system

The navigation system is composed of the following elements:

• date: A counter used to determine the date of the game.
• time: A counter is used to determine the time of day and which is reset every time date is incremented.

You can use timeTracker instance to manage your time system. It provides methods to initialize, get, increment time, etc. The time system is designed to be flexible and can be adapted to various game requirements.

Initialize

To initialize the time system, you need use the initialize method of the timeTracker instance. This function has the following parameters:

• defaultTimeSpent: The default time spent in the game (number). It is used to increment the time when no specific time is set.
• dayStartTime: The minimum time of the day (number). It is used to determine the start time of the day.
• dayEndTime: The maximum time of the day (number). It is used to determine the end time of the day.
• timeSlots: An array of time slots. Each slot is an object with the following properties:
  • name: The name of the time slot (string).
  • startTime: The start time of the time slot (number). It is used to determine the start time of the slot.
• weekLength: The length of the week (number). It is used to determine the number of days in the week.
• weekendStartDay: The start day of the weekend (number). It is used to determine the weekend days.
• getDayName: A function that returns the name of the day based on the week day number (number). It is used to determine the name of the day.

timeTracker.initialize({
    defaultTimeSpent: 1,
    dayStartTime: 0,
    dayEndTime: 24,
    timeSlots: [
        { name: "Morning", startTime: 5 },
        { name: "Afternoon", startTime: 12 },
        { name: "Evening", startTime: 18 },
        { name: "Night", startTime: 22 },
    ],
    getDayName: (weekDayNumber: number) => {
        const weekDaysNames = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"];
        return weekDaysNames[weekDayNumber];
    },
    weekendStartDay: 6,
    weekLength: 7,
});

Get

To get a current time, use the timeTracker.currentTime property. It returns the current time as a number.

import { timeTracker } from "@drincs/nqtr";

const currentTime: number = timeTracker.currentTime;

To get a current date, use the timeTracker.currentDate property. It returns the current date as a number.

import { timeTracker } from "@drincs/nqtr";

const currentDate: number = timeTracker.currentDate;

Set

To set a specific time, use the timeTracker.currentTime property. It accepts a number representing the time to set.

import { timeTracker } from "@drincs/nqtr";

timeTracker.currentTime = 12; // Set time to 12

To set a specific date, use the timeTracker.currentDate property. It accepts a number representing the date to set.

import { timeTracker } from "@drincs/nqtr";

timeTracker.currentDate = 5; // Set date to 5

Increment

timeTracker has some functions to increment the time and date with some additional logic.

To increment the current time by a specific amount, use the increaseTime method. In case that the new time exceeds the dayEndTime, it will automatically increment the date and reset the time to the dayStartTime plus the overflow time. This function has the following parameters:

• delta: The amount of time to increment (number). If not provided, it defaults to the defaultTimeSpent value.

import { timeTracker } from "@drincs/nqtr";

timeTracker.increaseTime(2);

To increment the current date by a specific amount, use the increaseDate method. This function has the following parameters:

• delta: The number of days to increase (number). If not provided, it defaults to 1.
• time: The time of the new day (number). If not provided, it defaults to the dayStartTime.

import { timeTracker } from "@drincs/nqtr";

timeTracker.increaseDate(1, 8); // Increment date by 1 and set time to 8

Is weekend

To check if the current day is a weekend, use the timeTracker.isWeekend property. It returns a boolean indicating whether the current day is a weekend.

import { timeTracker } from "@drincs/nqtr";

const isWeekend: boolean = timeTracker.isWeekend;

timeTracker.initialize({
    defaultTimeSpent: 1,
    dayStartTime: 0,
    dayEndTime: 24,
    timeSlots: [
        { name: "Morning", startTime: 5 },
        { name: "Afternoon", startTime: 12 },
        { name: "Evening", startTime: 18 },
        { name: "Night", startTime: 22 },
    ],
    getDayName: (weekDayNumber: number) => {
        const weekDaysNames = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"];
        return weekDaysNames[weekDayNumber];
    },
    weekendStartDay: 6, 
    weekLength: 7, 
});

FAQ