File: qd_minigame_config.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (159 lines) | stat: -rw-r--r-- 4,617 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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef QDENGINE_QDCORE_QD_MINIGAME_CONFIG_H
#define QDENGINE_QDCORE_QD_MINIGAME_CONFIG_H

#include "common/path.h"

namespace QDEngine {
/// Конфигурационные данные для миниигры.
/**
В .ini файле:
имя секции - название параметра

ключи
type = "string" / "file" / "object" - тип данных data_type_
count - количество данных, data_count_
value - строка данных, data_string_
comment - комментарий, comment_

Если тип данных не указан, то считается равным "string".

Пример:

[ParameterExample]
type = "object"
count = 2
value = "Object0"
comment = "пример параметра"
*/
class qdMinigameConfigParameter {
public:
	qdMinigameConfigParameter();
	~qdMinigameConfigParameter();

	bool operator == (const qdMinigameConfigParameter &prm) const {
		return (_name == prm._name);
	}
	bool operator == (const char *str) const {
		return !strcmp(str, name());
	}

	//! Тип данных.
	enum data_type_t {
		/// данные - строка
		PRM_DATA_STRING,
		/// данные - имя файла
		PRM_DATA_FILE,
		/// данные - имя объекта из игровой сцены
		PRM_DATA_OBJECT
	};

	const char *name() const {
		return _name.c_str();
	}
	void set_name(const char *name) {
		_name = name;
	}

	data_type_t data_type() const {
		return _data_type;
	}
	void set_data_type(data_type_t tp) {
		_data_type = tp;
	}

	const char *data_string() const {
		return _data_string.c_str();
	}
	void set_data_string(const char *str) {
		_data_string = str;
	}

	const char *comment() const {
		return _comment.c_str();
	}
	void set_comment(const char *str) {
		_comment = str;
	}

	int data_count() const {
		return _data_count;
	}
	void set_data_count(int cnt) {
		_data_count = cnt;
	}

	/// Проверяет валидность данных.
	/**
	Если данные не того формата, то возвращает false и устанавливает
	is_data_valid_ в false.
	*/
	bool validate_data();
	bool is_data_valid() const {
		return _is_data_valid;
	}

	//! Загрузка данных из скрипта.
	bool load_script(const xml::tag *p);
	//! Запись данных в скрипт.
	bool save_script(Common::WriteStream &fh, int indent = 0) const;

	//! Загрузка данных из .ini файла.
	bool load_ini(const Common::Path ini_file, const char *ini_section);

private:

	/// Имя параметра, данные из миниигры запрашиваются по нему.
	Common::String _name;

	/// Тип данных.
	data_type_t _data_type;

	/// Количество данных.
	/**
	Используется для числовых данных (указывает, сколько чисел записано в data_string_)
	и объектов (в сцене создаётся соответствующее количество копий объекта по имени data_string_,
	к их именам добавляется четырёхзначный порядковый номер).

	По умолчанию = 1.
	*/
	int _data_count;

	/// Строка данных.
	/**
	Формат зависит от типа данных.
	Для числовых данных - числа в текстовом виде через пробел, для
	остальных типов - просто строка.
	*/
	Common::String _data_string;

	/// Комментарий.
	Common::String _comment;

	/// false если строка данных не того формата.
	bool _is_data_valid;
};

} // namespace QDEngine

#endif // QDENGINE_QDCORE_QD_MINIGAME_CONFIG_H