#Time Events

The TimeEvents module handles time-related events. It allows registering events that trigger at specific times or intervals (e.g. hourly, daily, monthly) and on time travel.

Access via maplebirch.dynamic.Time or shortcut maplebirchFrameworks.addTimeEvent().

#Core API

#regTimeEvent(type, eventId, options)

Register a new time event.

• @param type (string): Event type — onSec, onMin, onHour, onDay, onWeek, onMonth, onYear, onTimeTravel
• @param eventId (string): Unique event identifier
• @param options (TimeEventOptions): Event configuration
• @return boolean: Whether registration succeeded

// Register a daily event
maplebirch.dynamic.regTimeEvent("onDay", "dailyCheck", {
  action: (data) => {
    V.dayCounter = (V.dayCounter || 0) + 1;
  },
  cond: (data) => data.currentDate.hour >= 6 && data.currentDate.hour < 18,
  priority: 5,
  once: false,
});

#delTimeEvent(type, eventId)

Unregister a time event.

maplebirch.dynamic.delTimeEvent("onDay", "dailyCheck");

#timeTravel(options)

Jump game time forward or backward.

// Jump to specific date
maplebirch.dynamic.timeTravel({
  year: 2025,
  month: 3,
  day: 15,
  hour: 12,
});

// Jump forward by duration
maplebirch.dynamic.timeTravel({
  addDays: 7,
  addHours: 6,
});

#Event Options