1 /*************************************************************************/
2 /*  instance_placeholder.h                                               */
3 /*************************************************************************/
4 /*                       This file is part of:                           */
5 /*                           GODOT ENGINE                                */
6 /*                      https://godotengine.org                          */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
9 /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
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 
36 class PackedScene;
37 
38 class InstancePlaceholder : public Node {
39 
40 	GDCLASS(InstancePlaceholder, Node);
41 
42 	String path;
43 	struct PropSet {
44 		StringName name;
45 		Variant value;
46 	};
47 
48 	List<PropSet> stored_values;
49 
50 protected:
51 	bool _set(const StringName &p_name, const Variant &p_value);
52 	bool _get(const StringName &p_name, Variant &r_ret) const;
53 	void _get_property_list(List<PropertyInfo> *p_list) const;
54 
55 	static void _bind_methods();
56 
57 public:
58 	void set_instance_path(const String &p_name);
59 	String get_instance_path() const;
60 
61 	Dictionary get_stored_values(bool p_with_order = false);
62 
63 	Node *create_instance(bool p_replace = false, const Ref<PackedScene> &p_custom_scene = Ref<PackedScene>());
64 	void replace_by_instance(const Ref<PackedScene> &p_custom_scene = Ref<PackedScene>());
65 
66 	InstancePlaceholder();
67 };
68 
69 #endif // INSTANCE_PLACEHOLDER_H
70