GameCalendarKit.GameCalendar - Gravideots/GameCalendarKit GitHub Wiki

GameCalendar is the successor of MonoBehaviour and provides the necessary set of methods and events for creating game calendar and work with events collections.

Namespace

GameCalendar contains in main GameCalendarKit namespace, don't forget to include it to your header.

Fields

• BaseEventsCollection - Pregenerated events ScriptableObject, you can find generator in menu "Assets/Game Calendar Kit/Event Collection Creator".

  public EventsCollection BaseEventsCollection;

• StartYear, StartMonth, StartDay - Initial value. Here you can choose the year, month and date from which the time begins in the game.

  public int StartYear;
  public int StartMonth;
  public int StartDay;

• ActiveHoursStart, ActiveHoursEnd - Initial value. Here you can choose the start and end value for active calendar work.

   [Range(0, 23)]
   public int ActiveHoursStart;
   [Range(0, 23)]
   public int ActiveHoursEnd ;

• MinutesScale - This value provides the ability to set the number of seconds in one game minute. The minimum stable and guaranteed working value is one second for now.

   [Range(.01f, 1f)]
   public float SecondsScale;

Events

• CalendarTimeChangedEvent is event method which will be launched every game seconds.

   public event EventHandler<GameClockEventObject> CalendarTimeChangedEvent;

• CalendarDayEndEvent is event method which will be launched at the end of the working day.

   public event EventHandler<GameClockEventObject> CalendarDayEndEvent;

• CalendarEventStarted is event method which will be launched when and if new event started.

   public event EventHandler<GameCalendarEventObjectList> CalendarEventStarted;

• CalendarEventEnded is event method which will be launched when any event ended.

   public event EventHandler<GameCalendarEventObjectList> CalendarEventEnded;

Methods

• StartNewDay is a method for starting new day.

   public void StartNewDay()

• RestartDay is a method for restart current day.

   public void RestartDay()

• PauseDay is a method for pause calendar time. Stops only calendar, not the all game.

   public void PauseDay()

• ContinueDay is a method for continue calendar time if it was paused. Continue tick from paused moment.

   public void ContinueDay()

• GetCurrentDate return current game date.

   public DateTime GetCurrentDate()

• CreateEvent put new GameCalendarEventObject object to calendar events collection.

   public void CreateEvent(GameCalendarEventObject newEvent)

• GetAllEventsByDate return all GameCalendarEventObject that matches requested date.

   public GameCalendarEventObjectList GetAllEventsByDate(DateTime date)

• GetAllEvents return all GameCalendarEventObject.

   public GameCalendarEventObjectList GetAllEvents()

• ChangeTimeScale change global timeScale to transmitted value.

   public void ChangeTimeScale(float timeScale)