aboutsummaryrefslogtreecommitdiff
path: root/engines/zvision/scripting/controls/timer_node.h
blob: a8e579cbe401d43949f838c06e276e5206e6ae22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef ZVISION_TIMER_NODE_H
#define ZVISION_TIMER_NODE_H

#include "zvision/scripting/control.h"

namespace ZVision {

class ZVision;

class TimerNode : public Control {
public:
	TimerNode(ZVision *engine, uint32 key, uint timeInSeconds);
	~TimerNode();

	/**
	 * Decrement the timer by the delta time. If the timer is finished, set the status
	 * in _globalState and let this node be deleted
	 *
	 * @param deltaTimeInMillis    The number of milliseconds that have passed since last frame
	 * @return                     If true, the node can be deleted after process() finishes
	 */
	bool process(uint32 deltaTimeInMillis);
	void serialize(Common::WriteStream *stream);
	void deserialize(Common::SeekableReadStream *stream);
	inline bool needsSerialization() { return true; }

private:
	int32 _timeLeft;
};

} // End of namespace ZVision

#endif