File: dialogplayer.h

package info (click to toggle)
residualvm 0.3.1%2Bdfsg-1
  • links: PTS, VCS
  • area: contrib
  • in suites: buster
  • size: 31,284 kB
  • sloc: cpp: 227,029; sh: 7,256; xml: 1,731; perl: 1,067; java: 861; asm: 738; python: 691; ansic: 272; makefile: 139; objc: 81; sed: 22; php: 1
file content (119 lines) | stat: -rw-r--r-- 3,037 bytes parent folder | download | duplicates (2)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/* ResidualVM - A 3D game interpreter
 *
 * ResidualVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the AUTHORS
 * 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 STARK_SERVICES_DIALOG_PLAYER_H
#define STARK_SERVICES_DIALOG_PLAYER_H

#include "common/array.h"

#include "engines/stark/resources/dialog.h"

namespace Stark {

namespace Resources {
class Speech;
}

/**
 * Dialog player
 *
 * Handles the state of the currently running dialog, and implements the
 * associated logic.
 */
class DialogPlayer {
public:
	DialogPlayer();
	virtual ~DialogPlayer();

	enum OptionType {
		kOptionTypeAsk = 0
	};

	struct Option {
		uint32 _type;
		Common::String _caption;
		Resources::Dialog::Topic *_topic;
		int32 _replyIndex;
	};

	/** Enter a dialog */
	void run(Resources::Dialog *dialog);

	/** Play a one-shot sentence */
	void playSingle(Resources::Speech *speech);

	/** Check if a dialog is running */
	bool isRunning();

	/** Update the currently running dialog */
	void update();

	/** Select a dialog option */
	void selectOption(uint32 index);

	/** Can a speech be played? */
	bool isSpeechReady() const;

	/** Return the speech to be played */
	Resources::Speech *acquireReadySpeech();

	/** Does the player need to choose between options? */
	bool areOptionsAvailable() const;

	/** List the currently available dialog options */
	Common::Array<DialogPlayer::Option> listOptions() const;

	/** Resume the dialog after it was interrupted to run a script */
	void resume(Resources::Dialog *dialog);

	/** Clear the currently running dialog */
	void reset();

protected:
	/** Build a list of available dialog options */
	void buildOptions();

	/** Removes the last only option from the options list */
	void removeLastOnlyOption();

	/** Initiate the next action after the end of a reply */
	void onReplyEnd();

	void saveToInterruptionSlot();
	void restoreFromInterruptionSlot();

	Resources::Dialog *_currentDialog;
	Resources::Dialog::Reply *_currentReply;

	Resources::Dialog *_interruptedDialog;
	Resources::Dialog::Reply *_interruptedReply;

	Resources::Speech *_singleSpeech;

	bool _speechReady;
	bool _optionsAvailable;
	Common::Array<Option> _options;
};

} // End of namespace Stark

#endif // STARK_SERVICES_DIALOG_PLAYER_H