ScummVM API documentation
properties.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef AGS_ENGINE_AC_PROPERTIES_H
23#define AGS_ENGINE_AC_PROPERTIES_H
24
25#include "ags/shared/game/custom_properties.h"
26
27namespace AGS3 {
28
29using AGS::Shared::StringIMap;
30
31// Getting a property value requires static and runtime property maps.
32// Key is first searched in runtime map, if not found - static map is taken,
33// which contains original property values for particular game entity.
34// Lastly, if the key is still not found, then the default schema value is
35// returned for the given property.
36int get_int_property(const StringIMap &st_prop, const StringIMap &rt_prop, const char *property);
37void get_text_property(const StringIMap &st_prop, const StringIMap &rt_prop, const char *property, char *bufer);
38const char *get_text_property_dynamic_string(const StringIMap &st_prop, const StringIMap &rt_prop, const char *property);
39
40bool set_int_property(StringIMap &rt_prop, const char *property, int value);
41bool set_text_property(StringIMap &rt_prop, const char *property, const char *value);
42
43} // namespace AGS3
44
45#endif