Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-16 17:13:11 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
a7583881af
godot/scene/resources/packed_scene.h

271 lines
9.0 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* packed_scene.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
#ifndef PACKED_SCENE_H
#define PACKED_SCENE_H
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/io/resource.h"
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
#include "scene/main/node.h"
Rename Reference to RefCounted
2021-06-04 16:03:15 +00:00
class SceneState : public RefCounted {
GDCLASS(SceneState, RefCounted);
-Ability to retrieve state data from PackedScene, closes #3413
2016-01-23 15:01:42 +00:00
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
Vector<StringName> names;
Vector<Variant> variants;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Vector<NodePath> node_paths;
Vector<NodePath> editable_instances;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
mutable HashMap<NodePath, int> node_path_cache;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
mutable HashMap<int, int> base_scene_node_remap;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int base_scene_idx = -1;
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
enum {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
NO_PARENT_SAVED = 0x7FFFFFFF,
restored binary compatibility, which was broken in #14406
2017-12-16 18:48:16 +00:00
NAME_INDEX_BITS = 18,
NAME_MASK = (1 << NAME_INDEX_BITS) - 1,
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
};
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
struct NodeData {
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int parent = 0;
int owner = 0;
int type = 0;
int name = 0;
int instance = 0;
int index = 0;
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
struct Property {
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int name = 0;
int value = 0;
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
};
Vector<Property> properties;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Vector<int> groups;
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
};
Add ability to export Node pointers as NodePaths This PR implements: * A new hint: PROPERTY_HINT_NODE_TYPE for variant type OBJECT, which can take specific node types as hint string. * The editor will show it as a node path, but will set it as a pointer to a node from the current scene if you select a path. * When scene is saved, the node path is saved, then restored as a pointer. NOTE: This is a proof of concept and this approach will most likely not work. The reason if that, if the node referenced is deleted, then when trying to edit this the node will become invalid. Potential workarounds: Since this uses the Variant API, it should obtain the pointer from the Variant object ID. Yet, this would either only really work in GDScript or it would need to be implemented with workarounds in every language. Alternative ways to make this work: Nodes could export an additional property with a node path (like for which_node, it could be which_node_path). Another alternative: Path editing could happen as a hidden metadata (ignoring the pointer).
2022-06-18 22:42:02 +00:00
struct DeferredNodePathProperties {
Node *base = nullptr;
StringName property;
Fix index in loading of `Array[Node]`
2023-06-01 15:23:36 +00:00
Variant value;
Add ability to export Node pointers as NodePaths This PR implements: * A new hint: PROPERTY_HINT_NODE_TYPE for variant type OBJECT, which can take specific node types as hint string. * The editor will show it as a node path, but will set it as a pointer to a node from the current scene if you select a path. * When scene is saved, the node path is saved, then restored as a pointer. NOTE: This is a proof of concept and this approach will most likely not work. The reason if that, if the node referenced is deleted, then when trying to edit this the node will become invalid. Potential workarounds: Since this uses the Variant API, it should obtain the pointer from the Variant object ID. Yet, this would either only really work in GDScript or it would need to be implemented with workarounds in every language. Alternative ways to make this work: Nodes could export an additional property with a node path (like for which_node, it could be which_node_path). Another alternative: Path editing could happen as a hidden metadata (ignoring the pointer).
2022-06-18 22:42:02 +00:00
};
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
Vector<NodeData> nodes;
struct ConnectionData {
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int from = 0;
int to = 0;
int signal = 0;
int method = 0;
int flags = 0;
Add support for unbinding in connection dialog
2021-10-01 00:40:07 +00:00
int unbinds = 0;
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
Vector<int> binds;
};
Vector<ConnectionData> connections;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
Error _parse_node(Node *p_owner, Node *p_node, int p_parent_idx, HashMap<StringName, int> &name_map, HashMap<Variant, int, VariantHasher, VariantComparator> &variant_map, HashMap<Node *, int> &node_map, HashMap<Node *, int> &nodepath_map);
Error _parse_connections(Node *p_owner, Node *p_node, HashMap<StringName, int> &name_map, HashMap<Variant, int, VariantHasher, VariantComparator> &variant_map, HashMap<Node *, int> &node_map, HashMap<Node *, int> &nodepath_map);
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
String path;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
uint64_t last_modified_time = 0;
-scenes are properly reloaded when a dependency changes, fixes #2896 (it's clevery done so local changes to scenes are kept even if unsaved)
2015-12-13 23:39:01 +00:00
-fixes and more fixes to new scene system, seems stable now.. BUT DONT TRUST ME IT MAY STILL BREAK, USE WITH CARE!!
2015-10-16 22:11:23 +00:00
static bool disable_placeholders;
-Ability to retrieve state data from PackedScene, closes #3413
2016-01-23 15:01:42 +00:00
PoolVector is gone, replaced by Vector Typed `PoolTypeArray` types are now renamed `PackedTypeArray` and are sugar for `Vector<Type>`.
2020-02-17 21:06:54 +00:00
Vector<String> _get_node_groups(int p_idx) const;
-Ability to retrieve state data from PackedScene, closes #3413
2016-01-23 15:01:42 +00:00
Fix node duplication in scene sub-inheritance
2017-03-08 19:08:24 +00:00
int _find_base_scene_node_remap_key(int p_idx) const;
Let editor workaround a case of inconsistency in compound scenes
2023-06-07 11:44:37 +00:00
#ifdef TOOLS_ENABLED
public:
typedef void (*InstantiationWarningNotify)(const String &p_warning);
private:
static InstantiationWarningNotify instantiation_warn_notify;
#endif
-Ability to retrieve state data from PackedScene, closes #3413
2016-01-23 15:01:42 +00:00
protected:
static void _bind_methods();
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
public:
Fix situation where TSCN format might crash, closes #3062
2016-01-12 10:07:36 +00:00
enum {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
FLAG_ID_IS_PATH = (1 << 30),
Remove more instances of 'instance' being used as a verb
2022-11-15 23:13:39 +00:00
TYPE_INSTANTIATED = 0x7FFFFFFF,
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
FLAG_INSTANCE_IS_PLACEHOLDER = (1 << 30),
Add ability to export Node pointers as NodePaths This PR implements: * A new hint: PROPERTY_HINT_NODE_TYPE for variant type OBJECT, which can take specific node types as hint string. * The editor will show it as a node path, but will set it as a pointer to a node from the current scene if you select a path. * When scene is saved, the node path is saved, then restored as a pointer. NOTE: This is a proof of concept and this approach will most likely not work. The reason if that, if the node referenced is deleted, then when trying to edit this the node will become invalid. Potential workarounds: Since this uses the Variant API, it should obtain the pointer from the Variant object ID. Yet, this would either only really work in GDScript or it would need to be implemented with workarounds in every language. Alternative ways to make this work: Nodes could export an additional property with a node path (like for which_node, it could be which_node_path). Another alternative: Path editing could happen as a hidden metadata (ignoring the pointer).
2022-06-18 22:42:02 +00:00
FLAG_PATH_PROPERTY_IS_NODE = (1 << 30),
FLAG_PROP_NAME_MASK = FLAG_PATH_PROPERTY_IS_NODE - 1,
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
FLAG_MASK = (1 << 24) - 1,
Fix situation where TSCN format might crash, closes #3062
2016-01-12 10:07:36 +00:00
};
Groundbreaking!! Godot resources can now be flagged to be local to the scene being edited! This means that each time this scene is instanced, the resource will be unique! As such, thanks to this, the following features were implemented: -ButtonGroup is no longer a control, it's now a resource local to the scene -ViewportTexture can be created from the editor and set to any object, making ViewportSprite and other kind of nodes obsolete!
2017-01-10 04:04:31 +00:00
enum GenEditState {
GEN_EDIT_STATE_DISABLED,
GEN_EDIT_STATE_INSTANCE,
GEN_EDIT_STATE_MAIN,
Add property value pinning
2021-10-26 19:12:25 +00:00
GEN_EDIT_STATE_MAIN_INHERITED,
Groundbreaking!! Godot resources can now be flagged to be local to the scene being edited! This means that each time this scene is instanced, the resource will be unique! As such, thanks to this, the following features were implemented: -ButtonGroup is no longer a control, it's now a resource local to the scene -ViewportTexture can be created from the editor and set to any object, making ViewportSprite and other kind of nodes obsolete!
2017-01-10 04:04:31 +00:00
};
Unify determination of default property values
2021-09-14 11:05:54 +00:00
struct PackState {
Ref<SceneState> state;
int node = -1;
};
-fixes and more fixes to new scene system, seems stable now.. BUT DONT TRUST ME IT MAY STILL BREAK, USE WITH CARE!!
2015-10-16 22:11:23 +00:00
static void set_disable_placeholders(bool p_disable);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
int find_node_by_path(const NodePath &p_node) const;
Variant get_property_value(int p_node, const StringName &p_property, bool &found) const;
bool is_node_in_group(int p_node, const StringName &p_group) const;
bool is_connection(int p_node, const StringName &p_signal, int p_to_node, const StringName &p_to_method) const;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_bundled_scene(const Dictionary &p_dictionary);
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Dictionary get_bundled_scene() const;
Error pack(Node *p_scene);
void set_path(const String &p_path);
String get_path() const;
void clear();
Add PackedScene::reload_from_file() override
2022-11-26 18:46:04 +00:00
Error copy_from(const Ref<SceneState> &p_scene_state);
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
bool can_instantiate() const;
Node *instantiate(GenEditState p_edit_state) const;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Unify determination of default property values
2021-09-14 11:05:54 +00:00
Ref<SceneState> get_base_scene_state() const;
Update instances of scenes which have been reimported.
2022-01-30 21:31:32 +00:00
void update_instance_resource(String p_path, Ref<PackedScene> p_packed_scene);
-Fixed bug with scene inheritance, should work again -Proper .tscn and .tres parsing, should work, please test well!
2015-11-28 23:56:14 +00:00
//unbuild API
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
int get_node_count() const;
StringName get_node_type(int p_idx) const;
StringName get_node_name(int p_idx) const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
NodePath get_node_path(int p_idx, bool p_for_parent = false) const;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
NodePath get_node_owner_path(int p_idx) const;
Ref<PackedScene> get_node_instance(int p_idx) const;
Add support for placeholders in tscn, which was missing. Closes #3652
2016-02-21 14:17:50 +00:00
String get_node_instance_placeholder(int p_idx) const;
bool is_node_instance_placeholder(int p_idx) const;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Vector<StringName> get_node_groups(int p_idx) const;
Improve duplication and saving of instanced scenes
2017-12-08 14:05:15 +00:00
int get_node_index(int p_idx) const;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
int get_node_property_count(int p_idx) const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
StringName get_node_property_name(int p_idx, int p_prop) const;
Variant get_node_property_value(int p_idx, int p_prop) const;
Add ability to export Node pointers as NodePaths This PR implements: * A new hint: PROPERTY_HINT_NODE_TYPE for variant type OBJECT, which can take specific node types as hint string. * The editor will show it as a node path, but will set it as a pointer to a node from the current scene if you select a path. * When scene is saved, the node path is saved, then restored as a pointer. NOTE: This is a proof of concept and this approach will most likely not work. The reason if that, if the node referenced is deleted, then when trying to edit this the node will become invalid. Potential workarounds: Since this uses the Variant API, it should obtain the pointer from the Variant object ID. Yet, this would either only really work in GDScript or it would need to be implemented with workarounds in every language. Alternative ways to make this work: Nodes could export an additional property with a node path (like for which_node, it could be which_node_path). Another alternative: Path editing could happen as a hidden metadata (ignoring the pointer).
2022-06-18 22:42:02 +00:00
Vector<String> get_node_deferred_nodepath_properties(int p_idx) const;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
int get_connection_count() const;
NodePath get_connection_source(int p_idx) const;
StringName get_connection_signal(int p_idx) const;
NodePath get_connection_target(int p_idx) const;
StringName get_connection_method(int p_idx) const;
int get_connection_flags(int p_idx) const;
Add support for unbinding in connection dialog
2021-10-01 00:40:07 +00:00
int get_connection_unbinds(int p_idx) const;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Array get_connection_binds(int p_idx) const;
Do not allow editing Scene-inherited signal connections Inherited connections are also highlighted with the warning color in the Node dock.
2022-09-30 10:28:39 +00:00
bool has_connection(const NodePath &p_node_from, const StringName &p_signal, const NodePath &p_node_to, const StringName &p_method, bool p_no_inheritance = false);
WIP bugfix for existing connections
2016-07-19 23:04:06 +00:00
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Vector<NodePath> get_editable_instances() const;
-Fixed bug with scene inheritance, should work again -Proper .tscn and .tres parsing, should work, please test well!
2015-11-28 23:56:14 +00:00
//build API
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
int add_name(const StringName &p_name);
int add_value(const Variant &p_value);
int add_node_path(const NodePath &p_path);
Improve duplication and saving of instanced scenes
2017-12-08 14:05:15 +00:00
int add_node(int p_parent, int p_owner, int p_type, int p_name, int p_instance, int p_index);
Add ability to export Node pointers as NodePaths This PR implements: * A new hint: PROPERTY_HINT_NODE_TYPE for variant type OBJECT, which can take specific node types as hint string. * The editor will show it as a node path, but will set it as a pointer to a node from the current scene if you select a path. * When scene is saved, the node path is saved, then restored as a pointer. NOTE: This is a proof of concept and this approach will most likely not work. The reason if that, if the node referenced is deleted, then when trying to edit this the node will become invalid. Potential workarounds: Since this uses the Variant API, it should obtain the pointer from the Variant object ID. Yet, this would either only really work in GDScript or it would need to be implemented with workarounds in every language. Alternative ways to make this work: Nodes could export an additional property with a node path (like for which_node, it could be which_node_path). Another alternative: Path editing could happen as a hidden metadata (ignoring the pointer).
2022-06-18 22:42:02 +00:00
void add_node_property(int p_node, int p_name, int p_value, bool p_deferred_node_path = false);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void add_node_group(int p_node, int p_group);
-Fixed bug with scene inheritance, should work again -Proper .tscn and .tres parsing, should work, please test well!
2015-11-28 23:56:14 +00:00
void set_base_scene(int p_idx);
Add support for unbinding in connection dialog
2021-10-01 00:40:07 +00:00
void add_connection(int p_from, int p_to, int p_signal, int p_method, int p_flags, int p_unbinds, const Vector<int> &p_binds);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void add_editable_instance(const NodePath &p_path);
-Fixed bug with scene inheritance, should work again -Proper .tscn and .tres parsing, should work, please test well!
2015-11-28 23:56:14 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void set_last_modified_time(uint64_t p_time) { last_modified_time = p_time; }
-scenes are properly reloaded when a dependency changes, fixes #2896 (it's clevery done so local changes to scenes are kept even if unsaved)
2015-12-13 23:39:01 +00:00
uint64_t get_last_modified_time() const { return last_modified_time; }
Add ability to export Node pointers as NodePaths This PR implements: * A new hint: PROPERTY_HINT_NODE_TYPE for variant type OBJECT, which can take specific node types as hint string. * The editor will show it as a node path, but will set it as a pointer to a node from the current scene if you select a path. * When scene is saved, the node path is saved, then restored as a pointer. NOTE: This is a proof of concept and this approach will most likely not work. The reason if that, if the node referenced is deleted, then when trying to edit this the node will become invalid. Potential workarounds: Since this uses the Variant API, it should obtain the pointer from the Variant object ID. Yet, this would either only really work in GDScript or it would need to be implemented with workarounds in every language. Alternative ways to make this work: Nodes could export an additional property with a node path (like for which_node, it could be which_node_path). Another alternative: Path editing could happen as a hidden metadata (ignoring the pointer).
2022-06-18 22:42:02 +00:00
// Used when saving pointers (saves a path property instead).
static String get_meta_pointer_property(const String &p_property);
Let editor workaround a case of inconsistency in compound scenes
2023-06-07 11:44:37 +00:00
#ifdef TOOLS_ENABLED
static void set_instantiation_warning_notify_func(InstantiationWarningNotify p_warn_notify) { instantiation_warn_notify = p_warn_notify; }
#endif
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
SceneState();
};
Groundbreaking!! Godot resources can now be flagged to be local to the scene being edited! This means that each time this scene is instanced, the resource will be unique! As such, thanks to this, the following features were implemented: -ButtonGroup is no longer a control, it's now a resource local to the scene -ViewportTexture can be created from the editor and set to any object, making ViewportSprite and other kind of nodes obsolete!
2017-01-10 04:04:31 +00:00
VARIANT_ENUM_CAST(SceneState::GenEditState)
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
class PackedScene : public Resource {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GDCLASS(PackedScene, Resource);
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
RES_BASE_EXTENSION("scn");
Ref<SceneState> state;
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void _set_bundled_scene(const Dictionary &p_scene);
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
Dictionary _get_bundled_scene() const;
protected:
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual bool editor_can_reload_from_file() override { return false; } // this is handled by editor better
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
static void _bind_methods();
Improve resource load cache -Added a new method in Resource: reset_state , used for reloading the same resource from disk -Added a new cache mode "replace" in ResourceLoader, which reuses existing loaded sub-resources but resets their data from disk (or replaces them if they chaged type) -Because the correct sub-resource paths are always loaded now, this fixes bugs with subresource folding or subresource ordering when saving.
2021-02-11 17:18:45 +00:00
virtual void reset_state() override;
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
public:
Groundbreaking!! Godot resources can now be flagged to be local to the scene being edited! This means that each time this scene is instanced, the resource will be unique! As such, thanks to this, the following features were implemented: -ButtonGroup is no longer a control, it's now a resource local to the scene -ViewportTexture can be created from the editor and set to any object, making ViewportSprite and other kind of nodes obsolete!
2017-01-10 04:04:31 +00:00
enum GenEditState {
GEN_EDIT_STATE_DISABLED,
GEN_EDIT_STATE_INSTANCE,
GEN_EDIT_STATE_MAIN,
Add property value pinning
2021-10-26 19:12:25 +00:00
GEN_EDIT_STATE_MAIN_INHERITED,
Groundbreaking!! Godot resources can now be flagged to be local to the scene being edited! This means that each time this scene is instanced, the resource will be unique! As such, thanks to this, the following features were implemented: -ButtonGroup is no longer a control, it's now a resource local to the scene -ViewportTexture can be created from the editor and set to any object, making ViewportSprite and other kind of nodes obsolete!
2017-01-10 04:04:31 +00:00
};
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
Error pack(Node *p_scene);
void clear();
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
bool can_instantiate() const;
Node *instantiate(GenEditState p_edit_state = GEN_EDIT_STATE_DISABLED) const;
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
-scenes are properly reloaded when a dependency changes, fixes #2896 (it's clevery done so local changes to scenes are kept even if unsaved)
2015-12-13 23:39:01 +00:00
void recreate_state();
-Make sure scenes properly update when switching tabs, even if sub-instances changed. Fixes #3201
2016-01-14 14:06:20 +00:00
void replace_state(Ref<SceneState> p_by);
-scenes are properly reloaded when a dependency changes, fixes #2896 (it's clevery done so local changes to scenes are kept even if unsaved)
2015-12-13 23:39:01 +00:00
Add PackedScene::reload_from_file() override
2022-11-26 18:46:04 +00:00
virtual void reload_from_file() override;
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual void set_path(const String &p_path, bool p_take_over = false) override;
-scenes are properly reloaded when a dependency changes, fixes #2896 (it's clevery done so local changes to scenes are kept even if unsaved)
2015-12-13 23:39:01 +00:00
#ifdef TOOLS_ENABLED
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
virtual void set_last_modified_time(uint64_t p_time) override {
Fix `PackedScene::get_last_modified_time()` always returns `0` The variables operated by `PackedScene::set_last_modified_time()` and `PackedScene::get_last_modified_time()` are different.
2023-07-09 09:01:41 +00:00
Resource::set_last_modified_time(p_time);
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
state->set_last_modified_time(p_time);
}
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
-scenes are properly reloaded when a dependency changes, fixes #2896 (it's clevery done so local changes to scenes are kept even if unsaved)
2015-12-13 23:39:01 +00:00
#endif
Various code and documentation improvements
2022-03-05 20:22:38 +00:00
Ref<SceneState> get_state() const;
Large improvements on scene packing and management -Ability to edit and keep changes of instanced scenes and sub-scenes -Ability to inherit from other scenes
2015-10-10 12:09:09 +00:00
Updated copyright year in all headers
2015-04-18 17:38:54 +00:00
PackedScene();
};
Groundbreaking!! Godot resources can now be flagged to be local to the scene being edited! This means that each time this scene is instanced, the resource will be unique! As such, thanks to this, the following features were implemented: -ButtonGroup is no longer a control, it's now a resource local to the scene -ViewportTexture can be created from the editor and set to any object, making ViewportSprite and other kind of nodes obsolete!
2017-01-10 04:04:31 +00:00
VARIANT_ENUM_CAST(PackedScene::GenEditState)
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#endif // PACKED_SCENE_H
Reference in New Issue Copy Permalink