gameclk.h

/*
 *  gameclk.h - Keep track of time.
 *
 *  Copyright (C) 2000-2022  The Exult Team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef GAMECLK_H
#define GAMECLK_H 1

#include "palette.h"
#include "tqueue.h"

#include <memory>

/*
 *  The number of times that the game clock ticks in one game minute.
 */
const int ticks_per_minute = 25;

/*
 *  Keep track of time, and of the palette for a given time.
 */
class Game_clock : public Time_sensitive {
	Time_queue* tqueue;                 // The time queue.
	short       hour, minute, ticks;    // Time (0-23, 0-59).
	int         day;                    // Keep track of days played.
	int         light_source_level;     // Last set light source level.
	int         old_light_level;        // Last set light source level.
	bool        old_special_light;      // Last set light source level.
	bool        old_infravision;        // If infravision was on last time.
	bool        old_invisible;          // If invisibility was on last time.
	int         dungeon;                // Last set 'in_dungeon' value.
	int         overcast;    // >0 if day is overcast (e.g., from a storm).
	bool        was_overcast;
	int         fog;    // >0 if there is fog.
	bool        was_foggy;
	std::unique_ptr<Palette_transition>
				   transition;    // For smooth palette transitions.
	unsigned short time_rate;
	void           set_time_palette(bool force);
	void           set_light_source_level(int lev);
	void           check_hunger() const;

public:
	Game_clock(Time_queue* tq)
			: tqueue(tq), hour(6), minute(0), ticks(0), day(0),
			  light_source_level(0), old_light_level(0),
			  old_special_light(false), old_infravision(false),
			  old_invisible(false), dungeon(255), overcast(0),
			  was_overcast(false), fog(0), was_foggy(false), time_rate(1) {}

	int get_hour() const {
		return hour;
	}

	void set_hour(int h) {
		hour = h;
	}

	int get_minute() const {
		return minute;
	}

	void set_minute(int m) {
		minute = m;
	}

	int get_ticks() const {
		return ticks;
	}

	void set_ticks(int m) {
		ticks = m;
	}

	int get_day() const {
		return day;
	}

	void set_day(int d) {
		day = d;
	}

	unsigned long get_total_hours() const {    // Get total # hours.
		return day * 24 + hour;
	}

	unsigned long get_total_minutes() const {
		return get_total_hours() * 60 + minute;
	}

	void set_palette();    // Set palette for current hour.
	void reset_palette();

	// Set light source.  MUST be fast,
	//   since it's called during paint().
	void set_light_source(int lev, int dun) {
		if (lev != light_source_level || dun != dungeon) {
			set_light_source_level(lev);
		}
	}

	void reset() {
		overcast = fog = 0;
		was_overcast = was_foggy = false;
		old_special_light        = false;
		old_infravision          = false;
		old_invisible            = false;
		dungeon                  = 255;
		transition.reset();
	}

	void set_overcast(bool onoff);      // Start/end cloud cover.
	void set_fog(bool onoff);           // Start/end cloud cover.
	void increment(int num_minutes);    // Increment clock.
	void handle_event(unsigned long curtime, uintptr udata) override;
	void fake_next_period();    // For debugging.

	int get_time_rate() const {
		return time_rate;
	}

	void set_time_rate(int i) {
		time_rate = i > 0 ? i : 1;
	}
};

#endif /* INCL_GAMECLK */