1/**************************************************************************/
2/* instance_placeholder.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef INSTANCE_PLACEHOLDER_H
32#define INSTANCE_PLACEHOLDER_H
33
34#include "scene/main/node.h"
35
36class PackedScene;
37
38class InstancePlaceholder : public Node {
39 GDCLASS(InstancePlaceholder, Node);
40
41 String path;
42 struct PropSet {
43 StringName name;
44 Variant value;
45 };
46
47 List<PropSet> stored_values;
48
49protected:
50 bool _set(const StringName &p_name, const Variant &p_value);
51 bool _get(const StringName &p_name, Variant &r_ret) const;
52 void _get_property_list(List<PropertyInfo> *p_list) const;
53
54 static void _bind_methods();
55
56public:
57 void set_instance_path(const String &p_name);
58 String get_instance_path() const;
59
60 Dictionary get_stored_values(bool p_with_order = false);
61
62 Node *create_instance(bool p_replace = false, const Ref<PackedScene> &p_custom_scene = Ref<PackedScene>());
63
64 InstancePlaceholder();
65};
66
67#endif // INSTANCE_PLACEHOLDER_H
68