| 1 | /**************************************************************************/ |
| 2 | /* missing_node.cpp */ |
| 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 | #include "missing_node.h" |
| 32 | |
| 33 | bool MissingNode::_set(const StringName &p_name, const Variant &p_value) { |
| 34 | if (is_recording_properties()) { |
| 35 | properties.insert(p_name, p_value); |
| 36 | return true; //always valid to set (add) |
| 37 | } else { |
| 38 | if (!properties.has(p_name)) { |
| 39 | return false; |
| 40 | } |
| 41 | |
| 42 | properties[p_name] = p_value; |
| 43 | return true; |
| 44 | } |
| 45 | } |
| 46 | |
| 47 | bool MissingNode::_get(const StringName &p_name, Variant &r_ret) const { |
| 48 | if (!properties.has(p_name)) { |
| 49 | return false; |
| 50 | } |
| 51 | r_ret = properties[p_name]; |
| 52 | return true; |
| 53 | } |
| 54 | |
| 55 | void MissingNode::_get_property_list(List<PropertyInfo> *p_list) const { |
| 56 | for (const KeyValue<StringName, Variant> &E : properties) { |
| 57 | p_list->push_back(PropertyInfo(E.value.get_type(), E.key)); |
| 58 | } |
| 59 | } |
| 60 | |
| 61 | void MissingNode::set_original_class(const String &p_class) { |
| 62 | original_class = p_class; |
| 63 | } |
| 64 | |
| 65 | String MissingNode::get_original_class() const { |
| 66 | return original_class; |
| 67 | } |
| 68 | |
| 69 | void MissingNode::set_recording_properties(bool p_enable) { |
| 70 | recording_properties = p_enable; |
| 71 | } |
| 72 | |
| 73 | bool MissingNode::is_recording_properties() const { |
| 74 | return recording_properties; |
| 75 | } |
| 76 | |
| 77 | PackedStringArray MissingNode::get_configuration_warnings() const { |
| 78 | // The mere existence of this node is warning. |
| 79 | PackedStringArray ret; |
| 80 | ret.push_back(vformat(RTR("This node was saved as class type '%s', which was no longer available when this scene was loaded." ), original_class)); |
| 81 | ret.push_back(RTR("Data from the original node is kept as a placeholder until this type of node is available again. It can hence be safely re-saved without risk of data loss." )); |
| 82 | return ret; |
| 83 | } |
| 84 | |
| 85 | void MissingNode::_bind_methods() { |
| 86 | ClassDB::bind_method(D_METHOD("set_original_class" , "name" ), &MissingNode::set_original_class); |
| 87 | ClassDB::bind_method(D_METHOD("get_original_class" ), &MissingNode::get_original_class); |
| 88 | |
| 89 | ClassDB::bind_method(D_METHOD("set_recording_properties" , "enable" ), &MissingNode::set_recording_properties); |
| 90 | ClassDB::bind_method(D_METHOD("is_recording_properties" ), &MissingNode::is_recording_properties); |
| 91 | |
| 92 | // Expose, but not save. |
| 93 | ADD_PROPERTY(PropertyInfo(Variant::STRING, "original_class" , PROPERTY_HINT_NONE, "" , PROPERTY_USAGE_NONE), "set_original_class" , "get_original_class" ); |
| 94 | ADD_PROPERTY(PropertyInfo(Variant::BOOL, "recording_properties" , PROPERTY_HINT_NONE, "" , PROPERTY_USAGE_NONE), "set_recording_properties" , "is_recording_properties" ); |
| 95 | } |
| 96 | |
| 97 | MissingNode::MissingNode() { |
| 98 | } |
| 99 | |