2014-02-10 01:10:30 +00:00
/**************************************************************************/
/* packed_scene.cpp */
/**************************************************************************/
/* 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. */
/**************************************************************************/
2018-01-04 23:50:27 +00:00
2014-02-23 13:35:05 +00:00
# include "packed_scene.h"
2017-08-27 19:07:15 +00:00
2020-11-07 22:33:38 +00:00
# include "core/config/engine.h"
# include "core/config/project_settings.h"
2016-01-24 00:42:15 +00:00
# include "core/core_string_names.h"
2022-04-28 20:49:10 +00:00
# include "core/io/missing_resource.h"
2018-09-11 16:13:45 +00:00
# include "core/io/resource_loader.h"
2022-06-18 22:42:02 +00:00
# include "core/templates/local_vector.h"
2014-10-07 04:31:49 +00:00
# include "scene/2d/node_2d.h"
2024-02-26 12:34:53 +00:00
# ifndef _3D_DISABLED
2020-03-26 21:49:16 +00:00
# include "scene/3d/node_3d.h"
2024-02-26 12:34:53 +00:00
# endif // _3D_DISABLED
2014-10-07 04:31:49 +00:00
# include "scene/gui/control.h"
2015-10-16 22:11:23 +00:00
# include "scene/main/instance_placeholder.h"
2022-04-28 20:49:10 +00:00
# include "scene/main/missing_node.h"
2021-09-14 11:05:54 +00:00
# include "scene/property_utils.h"
2017-08-27 19:07:15 +00:00
2023-01-31 16:10:41 +00:00
# define PACKED_SCENE_VERSION 3
2023-02-13 22:54:44 +00:00
2023-06-07 11:44:37 +00:00
# ifdef TOOLS_ENABLED
SceneState : : InstantiationWarningNotify SceneState : : instantiation_warn_notify = nullptr ;
# endif
2021-06-17 22:03:09 +00:00
bool SceneState : : can_instantiate ( ) const {
2014-02-23 13:35:05 +00:00
return nodes . size ( ) > 0 ;
}
2021-10-26 19:12:25 +00:00
static Array _sanitize_node_pinned_properties ( Node * p_node ) {
2022-04-01 18:30:23 +00:00
Array pinned = p_node - > get_meta ( " _edit_pinned_properties_ " , Array ( ) ) ;
2021-10-26 19:12:25 +00:00
if ( pinned . is_empty ( ) ) {
return Array ( ) ;
}
2022-05-19 15:00:06 +00:00
HashSet < StringName > storable_properties ;
2021-10-26 19:12:25 +00:00
p_node - > get_storable_properties ( storable_properties ) ;
int i = 0 ;
do {
if ( storable_properties . has ( pinned [ i ] ) ) {
i + + ;
} else {
2021-07-03 22:17:03 +00:00
pinned . remove_at ( i ) ;
2021-10-26 19:12:25 +00:00
}
} while ( i < pinned . size ( ) ) ;
if ( pinned . is_empty ( ) ) {
p_node - > remove_meta ( " _edit_pinned_properties_ " ) ;
}
return pinned ;
}
2022-08-28 23:50:36 +00:00
Ref < Resource > SceneState : : get_remap_resource ( const Ref < Resource > & p_resource , HashMap < Ref < Resource > , Ref < Resource > > & remap_cache , const Ref < Resource > & p_fallback , Node * p_for_scene ) {
ERR_FAIL_COND_V ( p_resource . is_null ( ) , Ref < Resource > ( ) ) ;
Ref < Resource > remap_resource ;
// Find the shared copy of the source resource.
HashMap < Ref < Resource > , Ref < Resource > > : : Iterator R = remap_cache . find ( p_resource ) ;
if ( R ) {
remap_resource = R - > value ;
} else if ( p_fallback . is_valid ( ) & & p_fallback - > is_local_to_scene ( ) & & p_fallback - > get_class ( ) = = p_resource - > get_class ( ) ) {
// Simply copy the data from the source resource to update the fallback resource that was previously set.
p_fallback - > reset_state ( ) ; // May want to reset state.
List < PropertyInfo > pi ;
p_resource - > get_property_list ( & pi ) ;
for ( const PropertyInfo & E : pi ) {
if ( ! ( E . usage & PROPERTY_USAGE_STORAGE ) ) {
continue ;
}
if ( E . name = = " resource_path " ) {
continue ; // Do not change path.
}
Variant value = p_resource - > get ( E . name ) ;
// The local-to-scene subresource instance is preserved, thus maintaining the previous sharing relationship.
// This is mainly used when the sub-scene root is reset in the main scene.
Ref < Resource > sub_res_of_from = value ;
if ( sub_res_of_from . is_valid ( ) & & sub_res_of_from - > is_local_to_scene ( ) ) {
value = get_remap_resource ( sub_res_of_from , remap_cache , p_fallback - > get ( E . name ) , p_fallback - > get_local_scene ( ) ) ;
}
p_fallback - > set ( E . name , value ) ;
}
p_fallback - > set_scene_unique_id ( p_resource - > get_scene_unique_id ( ) ) ; // Get the id from the main scene, in case the id changes again when saving the scene.
remap_cache [ p_resource ] = p_fallback ;
remap_resource = p_fallback ;
} else { // A copy of the source resource is required to overwrite the previous one.
Ref < Resource > local_dupe = p_resource - > duplicate_for_local_scene ( p_for_scene , remap_cache ) ;
remap_cache [ p_resource ] = local_dupe ;
remap_resource = local_dupe ;
}
return remap_resource ;
}
2021-06-17 22:03:09 +00:00
Node * SceneState : : instantiate ( GenEditState p_edit_state ) const {
2022-11-15 23:13:39 +00:00
// Nodes where instantiation failed (because something is missing.)
2015-10-10 12:09:09 +00:00
List < Node * > stray_instances ;
2020-04-01 23:20:12 +00:00
# define NODE_FROM_ID(p_name, p_id) \
Node * p_name ; \
if ( p_id & FLAG_ID_IS_PATH ) { \
NodePath np = node_paths [ p_id & FLAG_MASK ] ; \
p_name = ret_nodes [ 0 ] - > get_node_or_null ( np ) ; \
} else { \
ERR_FAIL_INDEX_V ( p_id & FLAG_MASK , nc , nullptr ) ; \
p_name = ret_nodes [ p_id & FLAG_MASK ] ; \
2015-10-10 12:09:09 +00:00
}
2014-02-23 13:35:05 +00:00
int nc = nodes . size ( ) ;
2023-11-19 12:12:55 +00:00
ERR_FAIL_COND_V_MSG ( nc = = 0 , nullptr , vformat ( " Failed to instantiate scene state of \" %s \" , node count is 0. Make sure the PackedScene resource is valid. " , path ) ) ;
2014-02-23 13:35:05 +00:00
2020-04-01 23:20:12 +00:00
const StringName * snames = nullptr ;
2014-02-23 13:35:05 +00:00
int sname_count = names . size ( ) ;
2020-05-14 14:41:43 +00:00
if ( sname_count ) {
2014-02-23 13:35:05 +00:00
snames = & names [ 0 ] ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
2020-04-01 23:20:12 +00:00
const Variant * props = nullptr ;
2014-02-23 13:35:05 +00:00
int prop_count = variants . size ( ) ;
2020-05-14 14:41:43 +00:00
if ( prop_count ) {
2014-02-23 13:35:05 +00:00
props = & variants [ 0 ] ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
2015-06-29 03:29:49 +00:00
//Vector<Variant> properties;
2014-02-23 13:35:05 +00:00
const NodeData * nd = & nodes [ 0 ] ;
Node * * ret_nodes = ( Node * * ) alloca ( sizeof ( Node * ) * nc ) ;
2020-12-15 12:04:21 +00:00
bool gen_node_path_cache = p_edit_state ! = GEN_EDIT_STATE_DISABLED & & node_path_cache . is_empty ( ) ;
2017-01-10 04:04:31 +00:00
2022-05-13 13:04:37 +00:00
HashMap < Ref < Resource > , Ref < Resource > > resources_local_to_scene ;
2014-02-23 13:35:05 +00:00
2022-06-18 22:42:02 +00:00
LocalVector < DeferredNodePathProperties > deferred_node_paths ;
2014-02-23 13:35:05 +00:00
for ( int i = 0 ; i < nc ; i + + ) {
const NodeData & n = nd [ i ] ;
2020-04-01 23:20:12 +00:00
Node * parent = nullptr ;
2022-05-08 23:22:31 +00:00
String old_parent_path ;
2015-10-10 12:09:09 +00:00
if ( i > 0 ) {
2020-04-01 23:20:12 +00:00
ERR_FAIL_COND_V_MSG ( n . parent = = - 1 , nullptr , vformat ( " Invalid scene: node %s does not specify its parent node. " , snames [ n . name ] ) ) ;
2015-10-10 12:09:09 +00:00
NODE_FROM_ID ( nparent , n . parent ) ;
# ifdef DEBUG_ENABLED
2017-09-07 19:48:50 +00:00
if ( ! nparent & & ( n . parent & FLAG_ID_IS_PATH ) ) {
2022-11-15 23:13:39 +00:00
WARN_PRINT ( String ( " Parent path ' " + String ( node_paths [ n . parent & FLAG_MASK ] ) + " ' for node ' " + String ( snames [ n . name ] ) + " ' has vanished when instantiating: ' " + get_path ( ) + " '. " ) . ascii ( ) . get_data ( ) ) ;
2022-05-08 23:22:31 +00:00
old_parent_path = String ( node_paths [ n . parent & FLAG_MASK ] ) . trim_prefix ( " ./ " ) . replace ( " / " , " @ " ) ;
nparent = ret_nodes [ 0 ] ;
2015-10-10 12:09:09 +00:00
}
# endif
parent = nparent ;
2020-06-08 11:05:09 +00:00
} else {
2021-09-17 09:55:26 +00:00
// i == 0 is root node.
2020-06-08 11:05:09 +00:00
ERR_FAIL_COND_V_MSG ( n . parent ! = - 1 , nullptr , vformat ( " Invalid scene: root node %s cannot specify a parent node. " , snames [ n . name ] ) ) ;
2022-11-15 23:13:39 +00:00
ERR_FAIL_COND_V_MSG ( n . type = = TYPE_INSTANTIATED & & base_scene_idx < 0 , nullptr , vformat ( " Invalid scene: root node %s in an instance, but there's no base scene. " , snames [ n . name ] ) ) ;
2014-02-23 13:35:05 +00:00
}
2020-04-01 23:20:12 +00:00
Node * node = nullptr ;
2022-04-28 20:49:10 +00:00
MissingNode * missing_node = nullptr ;
2016-01-24 00:42:15 +00:00
2015-10-10 12:09:09 +00:00
if ( i = = 0 & & base_scene_idx > = 0 ) {
2024-01-04 13:12:27 +00:00
// Scene inheritance on root node.
2015-10-10 12:09:09 +00:00
Ref < PackedScene > sdata = props [ base_scene_idx ] ;
2020-04-01 23:20:12 +00:00
ERR_FAIL_COND_V ( ! sdata . is_valid ( ) , nullptr ) ;
2021-06-17 22:03:09 +00:00
node = sdata - > instantiate ( p_edit_state = = GEN_EDIT_STATE_DISABLED ? PackedScene : : GEN_EDIT_STATE_DISABLED : PackedScene : : GEN_EDIT_STATE_INSTANCE ) ; //only main gets main edit state
2023-06-06 12:59:54 +00:00
ERR_FAIL_NULL_V ( node , nullptr ) ;
2017-01-10 04:04:31 +00:00
if ( p_edit_state ! = GEN_EDIT_STATE_DISABLED ) {
2015-10-10 12:09:09 +00:00
node - > set_scene_inherited_state ( sdata - > get_state ( ) ) ;
}
} else if ( n . instance > = 0 ) {
2024-01-04 13:12:27 +00:00
// Instance a scene into this node.
2015-10-16 22:11:23 +00:00
if ( n . instance & FLAG_INSTANCE_IS_PLACEHOLDER ) {
2024-01-04 13:12:27 +00:00
const String scene_path = props [ n . instance & FLAG_MASK ] ;
2015-10-16 22:11:23 +00:00
if ( disable_placeholders ) {
2022-09-29 09:53:28 +00:00
Ref < PackedScene > sdata = ResourceLoader : : load ( scene_path , " PackedScene " ) ;
2024-01-04 13:12:27 +00:00
if ( sdata . is_valid ( ) ) {
node = sdata - > instantiate ( p_edit_state = = GEN_EDIT_STATE_DISABLED ? PackedScene : : GEN_EDIT_STATE_DISABLED : PackedScene : : GEN_EDIT_STATE_INSTANCE ) ;
ERR_FAIL_NULL_V ( node , nullptr ) ;
} else if ( ResourceLoader : : is_creating_missing_resources_if_class_unavailable_enabled ( ) ) {
missing_node = memnew ( MissingNode ) ;
missing_node - > set_original_scene ( scene_path ) ;
missing_node - > set_recording_properties ( true ) ;
node = missing_node ;
} else {
ERR_FAIL_V_MSG ( nullptr , " Placeholder scene is missing. " ) ;
}
2015-10-16 22:11:23 +00:00
} else {
InstancePlaceholder * ip = memnew ( InstancePlaceholder ) ;
2022-09-29 09:53:28 +00:00
ip - > set_instance_path ( scene_path ) ;
2015-10-16 22:11:23 +00:00
node = ip ;
}
node - > set_scene_instance_load_placeholder ( true ) ;
} else {
2024-01-04 13:12:27 +00:00
Ref < Resource > res = props [ n . instance & FLAG_MASK ] ;
Ref < PackedScene > sdata = res ;
if ( sdata . is_valid ( ) ) {
node = sdata - > instantiate ( p_edit_state = = GEN_EDIT_STATE_DISABLED ? PackedScene : : GEN_EDIT_STATE_DISABLED : PackedScene : : GEN_EDIT_STATE_INSTANCE ) ;
ERR_FAIL_NULL_V_MSG ( node , nullptr , vformat ( " Failed to load scene dependency: \" %s \" . Make sure the required scene is valid. " , sdata - > get_path ( ) ) ) ;
} else if ( ResourceLoader : : is_creating_missing_resources_if_class_unavailable_enabled ( ) ) {
missing_node = memnew ( MissingNode ) ;
# ifdef TOOLS_ENABLED
if ( res . is_valid ( ) ) {
missing_node - > set_original_scene ( res - > get_meta ( " __load_path__ " , " " ) ) ;
}
# endif
missing_node - > set_recording_properties ( true ) ;
node = missing_node ;
} else {
ERR_FAIL_V_MSG ( nullptr , " Scene instance is missing. " ) ;
}
2015-10-16 22:11:23 +00:00
}
2014-02-23 13:35:05 +00:00
2022-11-15 23:13:39 +00:00
} else if ( n . type = = TYPE_INSTANTIATED ) {
2024-01-04 13:12:27 +00:00
// Get the node from somewhere, it likely already exists from another instance.
2015-10-10 12:09:09 +00:00
if ( parent ) {
node = parent - > _get_child_by_name ( snames [ n . name ] ) ;
# ifdef DEBUG_ENABLED
if ( ! node ) {
2017-09-02 14:19:06 +00:00
WARN_PRINT ( String ( " Node ' " + String ( ret_nodes [ 0 ] - > get_path_to ( parent ) ) + " / " + String ( snames [ n . name ] ) + " ' was modified from inside an instance, but it has vanished. " ) . ascii ( ) . get_data ( ) ) ;
2015-10-10 12:09:09 +00:00
}
# endif
}
2021-02-25 22:58:15 +00:00
} else {
2024-01-04 13:12:27 +00:00
// Node belongs to this scene and must be created.
2022-01-08 13:02:43 +00:00
Object * obj = ClassDB : : instantiate ( snames [ n . type ] ) ;
2021-02-25 22:58:15 +00:00
2022-01-08 13:02:43 +00:00
node = Object : : cast_to < Node > ( obj ) ;
2021-02-25 22:58:15 +00:00
2022-01-08 13:02:43 +00:00
if ( ! node ) {
2014-10-07 04:31:49 +00:00
if ( obj ) {
memdelete ( obj ) ;
2020-04-01 23:20:12 +00:00
obj = nullptr ;
2014-10-07 04:31:49 +00:00
}
2022-04-28 20:49:10 +00:00
if ( ResourceLoader : : is_creating_missing_resources_if_class_unavailable_enabled ( ) ) {
missing_node = memnew ( MissingNode ) ;
missing_node - > set_original_class ( snames [ n . type ] ) ;
missing_node - > set_recording_properties ( true ) ;
node = missing_node ;
obj = missing_node ;
} else {
WARN_PRINT ( vformat ( " Node %s of type %s cannot be created. A placeholder will be created instead. " , snames [ n . name ] , snames [ n . type ] ) . ascii ( ) . get_data ( ) ) ;
if ( n . parent > = 0 & & n . parent < nc & & ret_nodes [ n . parent ] ) {
if ( Object : : cast_to < Control > ( ret_nodes [ n . parent ] ) ) {
obj = memnew ( Control ) ;
} else if ( Object : : cast_to < Node2D > ( ret_nodes [ n . parent ] ) ) {
obj = memnew ( Node2D ) ;
2021-07-04 01:43:23 +00:00
# ifndef _3D_DISABLED
2022-04-28 20:49:10 +00:00
} else if ( Object : : cast_to < Node3D > ( ret_nodes [ n . parent ] ) ) {
obj = memnew ( Node3D ) ;
2021-07-04 01:43:23 +00:00
# endif // _3D_DISABLED
2022-04-28 20:49:10 +00:00
}
2014-10-07 04:31:49 +00:00
}
2017-01-10 04:04:31 +00:00
2022-04-28 20:49:10 +00:00
if ( ! obj ) {
obj = memnew ( Node ) ;
}
2014-02-23 13:35:05 +00:00
2022-04-28 20:49:10 +00:00
node = Object : : cast_to < Node > ( obj ) ;
}
2022-01-08 13:02:43 +00:00
}
2014-02-23 13:35:05 +00:00
}
2015-10-10 12:09:09 +00:00
if ( node ) {
2021-06-17 22:03:09 +00:00
// may not have found the node (part of instantiated scene and removed)
2015-10-10 12:09:09 +00:00
// if found all is good, otherwise ignore
//properties
int nprop_count = n . properties . size ( ) ;
if ( nprop_count ) {
const NodeData : : Property * nprops = & n . properties [ 0 ] ;
2014-02-23 13:35:05 +00:00
2022-04-28 20:49:10 +00:00
Dictionary missing_resource_properties ;
2022-08-28 23:50:36 +00:00
HashMap < Ref < Resource > , Ref < Resource > > resources_local_to_sub_scene ; // Record the mappings in the sub-scene.
2022-04-28 20:49:10 +00:00
2015-10-10 12:09:09 +00:00
for ( int j = 0 ; j < nprop_count ; j + + ) {
bool valid ;
2022-06-18 22:42:02 +00:00
2020-04-01 23:20:12 +00:00
ERR_FAIL_INDEX_V ( nprops [ j ] . value , prop_count , nullptr ) ;
2017-02-15 11:29:46 +00:00
2022-06-18 22:42:02 +00:00
if ( nprops [ j ] . name & FLAG_PATH_PROPERTY_IS_NODE ) {
uint32_t name_idx = nprops [ j ] . name & ( FLAG_PATH_PROPERTY_IS_NODE - 1 ) ;
ERR_FAIL_UNSIGNED_INDEX_V ( name_idx , ( uint32_t ) sname_count , nullptr ) ;
2023-02-13 22:54:44 +00:00
2023-06-01 15:23:36 +00:00
DeferredNodePathProperties dnp ;
dnp . value = props [ nprops [ j ] . value ] ;
dnp . base = node ;
dnp . property = snames [ name_idx ] ;
deferred_node_paths . push_back ( dnp ) ;
2022-06-18 22:42:02 +00:00
continue ;
}
ERR_FAIL_INDEX_V ( nprops [ j ] . name , sname_count , nullptr ) ;
2016-01-24 00:42:15 +00:00
if ( snames [ nprops [ j ] . name ] = = CoreStringNames : : get_singleton ( ) - > _script ) {
//work around to avoid old script variables from disappearing, should be the proper fix to:
//https://github.com/godotengine/godot/issues/2958
//store old state
2020-03-17 06:33:00 +00:00
List < Pair < StringName , Variant > > old_state ;
2016-01-24 00:42:15 +00:00
if ( node - > get_script_instance ( ) ) {
node - > get_script_instance ( ) - > get_property_state ( old_state ) ;
}
node - > set ( snames [ nprops [ j ] . name ] , props [ nprops [ j ] . value ] , & valid ) ;
//restore old state for new script, if exists
2021-07-24 13:46:25 +00:00
for ( const Pair < StringName , Variant > & E : old_state ) {
2021-07-16 03:45:57 +00:00
node - > set ( E . first , E . second ) ;
2016-01-24 00:42:15 +00:00
}
} else {
2017-01-10 04:04:31 +00:00
Variant value = props [ nprops [ j ] . value ] ;
if ( value . get_type ( ) = = Variant : : OBJECT ) {
//handle resources that are local to scene by duplicating them if needed
Ref < Resource > res = value ;
if ( res . is_valid ( ) ) {
2024-01-16 19:41:58 +00:00
value = make_local_resource ( value , n , resources_local_to_sub_scene , node , snames [ nprops [ j ] . name ] , resources_local_to_scene , i , ret_nodes , p_edit_state ) ;
2017-01-10 04:04:31 +00:00
}
2022-11-27 07:56:53 +00:00
}
if ( value . get_type ( ) = = Variant : : ARRAY ) {
Array set_array = value ;
2024-01-16 19:41:58 +00:00
value = setup_resources_in_array ( set_array , n , resources_local_to_sub_scene , node , snames [ nprops [ j ] . name ] , resources_local_to_scene , i , ret_nodes , p_edit_state ) ;
2022-11-27 07:56:53 +00:00
bool is_get_valid = false ;
Variant get_value = node - > get ( snames [ nprops [ j ] . name ] , & is_get_valid ) ;
2024-01-16 19:41:58 +00:00
2022-11-27 07:56:53 +00:00
if ( is_get_valid & & get_value . get_type ( ) = = Variant : : ARRAY ) {
Array get_array = get_value ;
if ( ! set_array . is_same_typed ( get_array ) ) {
value = Array ( set_array , get_array . get_typed_builtin ( ) , get_array . get_typed_class_name ( ) , get_array . get_typed_script ( ) ) ;
}
}
}
2024-01-16 19:41:58 +00:00
if ( value . get_type ( ) = = Variant : : DICTIONARY ) {
Dictionary dictionary = value ;
const Array keys = dictionary . keys ( ) ;
const Array values = dictionary . values ( ) ;
if ( has_local_resource ( values ) | | has_local_resource ( keys ) ) {
Array duplicated_keys = keys . duplicate ( true ) ;
Array duplicated_values = values . duplicate ( true ) ;
duplicated_keys = setup_resources_in_array ( duplicated_keys , n , resources_local_to_sub_scene , node , snames [ nprops [ j ] . name ] , resources_local_to_scene , i , ret_nodes , p_edit_state ) ;
duplicated_values = setup_resources_in_array ( duplicated_values , n , resources_local_to_sub_scene , node , snames [ nprops [ j ] . name ] , resources_local_to_scene , i , ret_nodes , p_edit_state ) ;
dictionary . clear ( ) ;
for ( int dictionary_index = 0 ; dictionary_index < keys . size ( ) ; dictionary_index + + ) {
dictionary [ duplicated_keys [ dictionary_index ] ] = duplicated_values [ dictionary_index ] ;
}
value = dictionary ;
}
2017-01-10 04:04:31 +00:00
}
2022-04-28 20:49:10 +00:00
bool set_valid = true ;
if ( ResourceLoader : : is_creating_missing_resources_if_class_unavailable_enabled ( ) & & value . get_type ( ) = = Variant : : OBJECT ) {
Ref < MissingResource > mr = value ;
if ( mr . is_valid ( ) ) {
missing_resource_properties [ snames [ nprops [ j ] . name ] ] = mr ;
set_valid = false ;
}
}
if ( set_valid ) {
node - > set ( snames [ nprops [ j ] . name ] , value , & valid ) ;
}
2024-01-16 19:41:58 +00:00
if ( p_edit_state = = GEN_EDIT_STATE_INSTANCE & & value . get_type ( ) ! = Variant : : OBJECT ) {
value = value . duplicate ( true ) ; // Duplicate arrays and dictionaries for the editor.
}
2016-01-24 00:42:15 +00:00
}
2015-10-10 12:09:09 +00:00
}
2022-04-28 20:49:10 +00:00
if ( ! missing_resource_properties . is_empty ( ) ) {
node - > set_meta ( META_MISSING_RESOURCES , missing_resource_properties ) ;
}
2022-08-28 23:50:36 +00:00
for ( KeyValue < Ref < Resource > , Ref < Resource > > & E : resources_local_to_sub_scene ) {
if ( E . value - > get_local_scene ( ) = = node ) {
E . value - > setup_local_to_scene ( ) ; // Setup may be required for the resource to work properly.
}
}
2014-02-23 13:35:05 +00:00
}
2015-10-10 12:09:09 +00:00
//name
2014-02-23 13:35:05 +00:00
2015-10-10 12:09:09 +00:00
//groups
for ( int j = 0 ; j < n . groups . size ( ) ; j + + ) {
2020-04-01 23:20:12 +00:00
ERR_FAIL_INDEX_V ( n . groups [ j ] , sname_count , nullptr ) ;
2015-10-10 12:09:09 +00:00
node - > add_to_group ( snames [ n . groups [ j ] ] , true ) ;
}
2014-02-23 13:35:05 +00:00
2022-11-15 23:13:39 +00:00
if ( n . instance > = 0 | | n . type ! = TYPE_INSTANTIATED | | i = = 0 ) {
2018-10-25 00:19:21 +00:00
//if node was not part of instance, must set its name, parenthood and ownership
2015-10-10 12:09:09 +00:00
if ( i > 0 ) {
if ( parent ) {
2023-06-07 11:44:37 +00:00
bool pending_add = true ;
# ifdef TOOLS_ENABLED
if ( Engine : : get_singleton ( ) - > is_editor_hint ( ) ) {
Node * existing = parent - > _get_child_by_name ( snames [ n . name ] ) ;
if ( existing ) {
// There's already a node in the same parent with the same name.
// This means that somehow the node was added both to the scene being
// loaded and another one instantiated in the former, maybe because of
// manual editing, or a bug in scene saving, or a loophole in the workflow
// (with any of the bugs possibly already fixed).
// Bring consistency back by letting it be assigned a non-clashing name.
// This simple workaround at least avoids leaks and helps the user realize
// something awkward has happened.
if ( instantiation_warn_notify ) {
instantiation_warn_notify ( vformat (
TTR ( " An incoming node's name clashes with %s already in the scene (presumably, from a more nested instance). \n The less nested node will be renamed. Please fix and re-save the scene. " ) ,
ret_nodes [ 0 ] - > get_path_to ( existing ) ) ) ;
}
node - > set_name ( snames [ n . name ] ) ;
parent - > add_child ( node , true ) ;
pending_add = false ;
}
}
# endif
if ( pending_add ) {
parent - > _add_child_nocheck ( node , snames [ n . name ] ) ;
}
2020-05-14 14:41:43 +00:00
if ( n . index > = 0 & & n . index < parent - > get_child_count ( ) - 1 ) {
2017-12-08 14:05:15 +00:00
parent - > move_child ( node , n . index ) ;
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
} else {
2021-06-17 22:03:09 +00:00
//it may be possible that an instantiated scene has changed
2015-10-10 12:09:09 +00:00
//and the node has nowhere to go anymore
stray_instances . push_back ( node ) ; //can't be added, go to stray list
}
} else {
2018-07-29 20:39:06 +00:00
if ( Engine : : get_singleton ( ) - > is_editor_hint ( ) ) {
//validate name if using editor, to avoid broken
node - > set_name ( snames [ n . name ] ) ;
} else {
node - > _set_name_nocheck ( snames [ n . name ] ) ;
}
2015-10-10 12:09:09 +00:00
}
}
2014-02-23 13:35:05 +00:00
2022-05-08 23:22:31 +00:00
if ( ! old_parent_path . is_empty ( ) ) {
2023-10-19 08:24:32 +00:00
node - > set_name ( old_parent_path + " # " + node - > get_name ( ) ) ;
2022-05-08 23:22:31 +00:00
}
2015-10-10 12:09:09 +00:00
if ( n . owner > = 0 ) {
NODE_FROM_ID ( owner , n . owner ) ;
2020-05-14 14:41:43 +00:00
if ( owner ) {
2015-10-10 12:09:09 +00:00
node - > _set_owner_nocheck ( owner ) ;
2022-04-16 10:23:32 +00:00
if ( node - > data . unique_name_in_owner ) {
node - > _acquire_unique_name_in_owner ( ) ;
}
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
}
2014-02-23 13:35:05 +00:00
2022-11-15 23:13:39 +00:00
// We only want to deal with pinned flag if instantiating as pure main (no instance, no inheriting.)
2021-11-17 13:00:23 +00:00
if ( p_edit_state = = GEN_EDIT_STATE_MAIN ) {
_sanitize_node_pinned_properties ( node ) ;
} else {
node - > remove_meta ( " _edit_pinned_properties_ " ) ;
}
2021-10-26 19:12:25 +00:00
}
2022-04-28 20:49:10 +00:00
if ( missing_node ) {
missing_node - > set_recording_properties ( false ) ;
}
2015-10-10 12:09:09 +00:00
ret_nodes [ i ] = node ;
if ( node & & gen_node_path_cache & & ret_nodes [ 0 ] ) {
2019-02-12 20:10:08 +00:00
NodePath n2 = ret_nodes [ 0 ] - > get_path_to ( node ) ;
node_path_cache [ n2 ] = i ;
2015-10-10 12:09:09 +00:00
}
2014-02-23 13:35:05 +00:00
}
2022-12-29 00:24:45 +00:00
for ( const DeferredNodePathProperties & dnp : deferred_node_paths ) {
2023-02-13 22:54:44 +00:00
// Replace properties stored as NodePaths with actual Nodes.
2023-06-01 15:23:36 +00:00
if ( dnp . value . get_type ( ) = = Variant : : ARRAY ) {
Array paths = dnp . value ;
2023-02-13 22:54:44 +00:00
2023-06-14 20:02:39 +00:00
bool valid ;
2023-06-01 15:23:36 +00:00
Array array = dnp . base - > get ( dnp . property , & valid ) ;
2023-06-14 20:02:39 +00:00
ERR_CONTINUE ( ! valid ) ;
2023-06-01 15:23:36 +00:00
array = array . duplicate ( ) ;
2023-06-14 20:02:39 +00:00
2023-06-01 15:23:36 +00:00
array . resize ( paths . size ( ) ) ;
for ( int i = 0 ; i < array . size ( ) ; i + + ) {
array . set ( i , dnp . base - > get_node_or_null ( paths [ i ] ) ) ;
2023-02-13 22:54:44 +00:00
}
2023-06-01 15:23:36 +00:00
dnp . base - > set ( dnp . property , array ) ;
2023-02-13 22:54:44 +00:00
} else {
2023-06-01 15:23:36 +00:00
dnp . base - > set ( dnp . property , dnp . base - > get_node_or_null ( dnp . value ) ) ;
2023-02-13 22:54:44 +00:00
}
2022-06-18 22:42:02 +00:00
}
2021-08-09 20:13:42 +00:00
for ( KeyValue < Ref < Resource > , Ref < Resource > > & E : resources_local_to_scene ) {
2022-08-17 07:46:37 +00:00
if ( E . value - > get_local_scene ( ) = = ret_nodes [ 0 ] ) {
E . value - > setup_local_to_scene ( ) ;
}
2017-08-18 11:25:04 +00:00
}
2014-02-23 13:35:05 +00:00
//do connections
int cc = connections . size ( ) ;
const ConnectionData * cdata = connections . ptr ( ) ;
for ( int i = 0 ; i < cc ; i + + ) {
const ConnectionData & c = cdata [ i ] ;
2020-04-01 23:20:12 +00:00
//ERR_FAIL_INDEX_V( c.from, nc, nullptr );
//ERR_FAIL_INDEX_V( c.to, nc, nullptr );
2015-10-10 12:09:09 +00:00
NODE_FROM_ID ( cfrom , c . from ) ;
NODE_FROM_ID ( cto , c . to ) ;
2020-05-14 14:41:43 +00:00
if ( ! cfrom | | ! cto ) {
2015-10-10 12:09:09 +00:00
continue ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
2021-10-01 00:40:07 +00:00
Callable callable ( cto , snames [ c . method ] ) ;
if ( c . unbinds > 0 ) {
callable = callable . unbind ( c . unbinds ) ;
} else if ( ! c . binds . is_empty ( ) ) {
Vector < Variant > binds ;
if ( c . binds . size ( ) ) {
binds . resize ( c . binds . size ( ) ) ;
for ( int j = 0 ; j < c . binds . size ( ) ; j + + ) {
binds . write [ j ] = props [ c . binds [ j ] ] ;
}
2020-05-14 14:41:43 +00:00
}
2021-10-01 00:40:07 +00:00
2022-03-29 03:48:49 +00:00
const Variant * * argptrs = ( const Variant * * ) alloca ( sizeof ( Variant * ) * binds . size ( ) ) ;
for ( int j = 0 ; j < binds . size ( ) ; j + + ) {
argptrs [ j ] = & binds [ j ] ;
}
2022-07-28 20:56:41 +00:00
callable = callable . bindp ( argptrs , binds . size ( ) ) ;
2014-02-23 13:35:05 +00:00
}
2022-12-06 12:50:54 +00:00
cfrom - > connect ( snames [ c . signal ] , callable , CONNECT_PERSIST | c . flags | ( p_edit_state = = GEN_EDIT_STATE_MAIN ? 0 : CONNECT_INHERITED ) ) ;
2014-02-23 13:35:05 +00:00
}
2015-10-10 12:09:09 +00:00
//Node *s = ret_nodes[0];
2014-02-23 13:35:05 +00:00
2015-10-10 12:09:09 +00:00
//remove nodes that could not be added, likely as a result that
while ( stray_instances . size ( ) ) {
memdelete ( stray_instances . front ( ) - > get ( ) ) ;
2017-01-14 17:03:38 +00:00
stray_instances . pop_front ( ) ;
2015-10-10 12:09:09 +00:00
}
for ( int i = 0 ; i < editable_instances . size ( ) ; i + + ) {
2019-01-29 16:15:34 +00:00
Node * ei = ret_nodes [ 0 ] - > get_node_or_null ( editable_instances [ i ] ) ;
2015-10-10 12:09:09 +00:00
if ( ei ) {
ret_nodes [ 0 ] - > set_editable_instance ( ei , true ) ;
}
}
2015-05-04 21:30:57 +00:00
2014-02-23 13:35:05 +00:00
return ret_nodes [ 0 ] ;
}
2024-01-16 19:41:58 +00:00
Variant SceneState : : make_local_resource ( Variant & p_value , const SceneState : : NodeData & p_node_data , HashMap < Ref < Resource > , Ref < Resource > > & p_resources_local_to_sub_scene , Node * p_node , const StringName p_sname , HashMap < Ref < Resource > , Ref < Resource > > & p_resources_local_to_scene , int p_i , Node * * p_ret_nodes , SceneState : : GenEditState p_edit_state ) const {
Ref < Resource > res = p_value ;
if ( res . is_null ( ) | | ! res - > is_local_to_scene ( ) ) {
return p_value ;
}
if ( p_node_data . instance > = 0 ) { // For the root node of a sub-scene, treat it as part of the sub-scene.
return get_remap_resource ( res , p_resources_local_to_sub_scene , p_node - > get ( p_sname ) , p_node ) ;
} else {
HashMap < Ref < Resource > , Ref < Resource > > : : Iterator E = p_resources_local_to_scene . find ( res ) ;
Node * base = p_i = = 0 ? p_node : p_ret_nodes [ 0 ] ;
if ( E ) {
return E - > value ;
} else if ( p_edit_state = = GEN_EDIT_STATE_MAIN ) { // For the main scene, use the resource as is
res - > configure_for_local_scene ( base , p_resources_local_to_scene ) ;
p_resources_local_to_scene [ res ] = res ;
return res ;
} else { // For instances, a copy must be made.
Ref < Resource > local_dupe = res - > duplicate_for_local_scene ( base , p_resources_local_to_scene ) ;
p_resources_local_to_scene [ res ] = local_dupe ;
return local_dupe ;
}
}
}
Array SceneState : : setup_resources_in_array ( Array & p_array_to_scan , const SceneState : : NodeData & p_n , HashMap < Ref < Resource > , Ref < Resource > > & p_resources_local_to_sub_scene , Node * p_node , const StringName p_sname , HashMap < Ref < Resource > , Ref < Resource > > & p_resources_local_to_scene , int p_i , Node * * p_ret_nodes , SceneState : : GenEditState p_edit_state ) const {
for ( int i = 0 ; i < p_array_to_scan . size ( ) ; i + + ) {
if ( p_array_to_scan [ i ] . get_type ( ) = = Variant : : OBJECT ) {
p_array_to_scan [ i ] = make_local_resource ( p_array_to_scan [ i ] , p_n , p_resources_local_to_sub_scene , p_node , p_sname , p_resources_local_to_scene , p_i , p_ret_nodes , p_edit_state ) ;
}
}
return p_array_to_scan ;
}
bool SceneState : : has_local_resource ( const Array & p_array ) const {
for ( int i = 0 ; i < p_array . size ( ) ; i + + ) {
Ref < Resource > res = p_array [ i ] ;
if ( res . is_valid ( ) & & res - > is_local_to_scene ( ) ) {
return true ;
}
}
return false ;
}
2022-05-13 13:04:37 +00:00
static int _nm_get_string ( const String & p_string , HashMap < StringName , int > & name_map ) {
2020-05-14 14:41:43 +00:00
if ( name_map . has ( p_string ) ) {
2014-02-23 13:35:05 +00:00
return name_map [ p_string ] ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
int idx = name_map . size ( ) ;
name_map [ p_string ] = idx ;
return idx ;
}
2017-02-15 13:41:16 +00:00
static int _vm_get_variant ( const Variant & p_variant , HashMap < Variant , int , VariantHasher , VariantComparator > & variant_map ) {
2020-05-14 14:41:43 +00:00
if ( variant_map . has ( p_variant ) ) {
2014-02-23 13:35:05 +00:00
return variant_map [ p_variant ] ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
int idx = variant_map . size ( ) ;
variant_map [ p_variant ] = idx ;
return idx ;
}
2022-05-13 13:04:37 +00:00
Error SceneState : : _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 ) {
2015-10-10 12:09:09 +00:00
// this function handles all the work related to properly packing scenes, be it
2021-06-17 22:03:09 +00:00
// instantiated or inherited.
2015-10-10 12:09:09 +00:00
// given the complexity of this process, an attempt will be made to properly
// document it. if you fail to understand something, please ask!
2014-02-23 13:35:05 +00:00
2015-10-10 12:09:09 +00:00
//discard nodes that do not belong to be processed
2020-05-14 14:41:43 +00:00
if ( p_node ! = p_owner & & p_node - > get_owner ( ) ! = p_owner & & ! p_owner - > is_editable_instance ( p_node - > get_owner ( ) ) ) {
2015-10-10 12:09:09 +00:00
return OK ;
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
2021-06-16 17:54:02 +00:00
bool is_editable_instance = false ;
2021-06-17 22:03:09 +00:00
// save the child instantiated scenes that are chosen as editable, so they can be restored
2015-10-10 12:09:09 +00:00
// upon load back
2021-12-09 09:42:46 +00:00
if ( p_node ! = p_owner & & ! p_node - > get_scene_file_path ( ) . is_empty ( ) & & p_owner - > is_editable_instance ( p_node ) ) {
2015-10-10 12:09:09 +00:00
editable_instances . push_back ( p_owner - > get_path_to ( p_node ) ) ;
2021-06-16 17:54:02 +00:00
// Node is the root of an editable instance.
is_editable_instance = true ;
2021-10-05 21:49:50 +00:00
} else if ( p_node - > get_owner ( ) & & p_owner - > is_ancestor_of ( p_node - > get_owner ( ) ) & & p_owner - > is_editable_instance ( p_node - > get_owner ( ) ) ) {
2021-06-16 17:54:02 +00:00
// Node is part of an editable instance.
is_editable_instance = true ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
NodeData nd ;
nd . name = _nm_get_string ( p_node - > get_name ( ) , name_map ) ;
2021-06-17 22:03:09 +00:00
nd . instance = - 1 ; //not instantiated by default
2018-08-05 14:42:47 +00:00
//really convoluted condition, but it basically checks that index is only saved when part of an inherited scene OR the node parent is from the edited scene
if ( p_owner - > get_scene_inherited_state ( ) . is_null ( ) & & ( p_node = = p_owner | | ( p_node - > get_owner ( ) = = p_owner & & ( p_node - > get_parent ( ) = = p_owner | | p_node - > get_parent ( ) - > get_owner ( ) = = p_owner ) ) ) ) {
//do not save index, because it belongs to saved scene and scene is not inherited
nd . index = - 1 ;
2019-12-05 00:18:48 +00:00
} else if ( p_node = = p_owner ) {
//This (hopefully) happens if the node is a scene root, so its index is irrelevant.
nd . index = - 1 ;
2018-08-05 14:42:47 +00:00
} else {
2021-06-17 22:03:09 +00:00
//part of an inherited scene, or parent is from an instantiated scene
2018-08-05 14:42:47 +00:00
nd . index = p_node - > get_index ( ) ;
}
2015-10-10 12:09:09 +00:00
2021-06-17 22:03:09 +00:00
// if this node is part of an instantiated scene or sub-instantiated scene
2015-10-10 12:09:09 +00:00
// we need to get the corresponding instance states.
// with the instance states, we can query for identical properties/groups
// and only save what has changed
2021-09-14 11:05:54 +00:00
bool instantiated_by_owner = false ;
Vector < SceneState : : PackState > states_stack = PropertyUtils : : get_node_states_stack ( p_node , p_owner , & instantiated_by_owner ) ;
2015-10-16 22:11:23 +00:00
2021-12-09 09:42:46 +00:00
if ( ! p_node - > get_scene_file_path ( ) . is_empty ( ) & & p_node - > get_owner ( ) = = p_owner & & instantiated_by_owner ) {
2021-09-14 11:05:54 +00:00
if ( p_node - > get_scene_instance_load_placeholder ( ) ) {
//it's a placeholder, use the placeholder path
nd . instance = _vm_get_variant ( p_node - > get_scene_file_path ( ) , variant_map ) ;
nd . instance | = FLAG_INSTANCE_IS_PLACEHOLDER ;
} else {
//must instance ourselves
Ref < PackedScene > instance = ResourceLoader : : load ( p_node - > get_scene_file_path ( ) ) ;
if ( ! instance . is_valid ( ) ) {
return ERR_CANT_OPEN ;
2015-10-10 12:09:09 +00:00
}
2021-09-14 11:05:54 +00:00
nd . instance = _vm_get_variant ( instance , variant_map ) ;
2015-10-10 12:09:09 +00:00
}
}
// all setup, we then proceed to check all properties for the node
// and save the ones that are worth saving
2014-02-23 13:35:05 +00:00
List < PropertyInfo > plist ;
p_node - > get_property_list ( & plist ) ;
2020-05-08 10:43:23 +00:00
2021-10-26 19:12:25 +00:00
Array pinned_props = _sanitize_node_pinned_properties ( p_node ) ;
2022-04-28 20:49:10 +00:00
Dictionary missing_resource_properties = p_node - > get_meta ( META_MISSING_RESOURCES , Dictionary ( ) ) ;
2021-10-26 19:12:25 +00:00
2021-07-24 13:46:25 +00:00
for ( const PropertyInfo & E : plist ) {
2021-07-16 03:45:57 +00:00
if ( ! ( E . usage & PROPERTY_USAGE_STORAGE ) ) {
2014-02-23 13:35:05 +00:00
continue ;
2014-10-03 03:10:51 +00:00
}
2014-02-23 13:35:05 +00:00
2022-04-28 20:49:10 +00:00
if ( E . name = = META_PROPERTY_MISSING_RESOURCES ) {
2022-04-01 18:30:23 +00:00
continue ; // Ignore this property when packing.
2022-04-28 20:49:10 +00:00
}
2022-04-01 18:30:23 +00:00
// If instance or inheriting, not saving if property requested so.
if ( ! states_stack . is_empty ( ) ) {
2021-10-26 19:12:25 +00:00
if ( ( E . usage & PROPERTY_USAGE_NO_INSTANCE_STATE ) ) {
continue ;
}
2018-11-08 14:30:02 +00:00
}
2015-10-10 12:09:09 +00:00
2021-10-26 19:12:25 +00:00
StringName name = E . name ;
2022-04-01 18:30:23 +00:00
Variant value = p_node - > get ( name ) ;
2022-06-18 22:42:02 +00:00
bool use_deferred_node_path_bit = false ;
2014-02-23 13:35:05 +00:00
2022-06-18 22:42:02 +00:00
if ( E . type = = Variant : : OBJECT & & E . hint = = PROPERTY_HINT_NODE_TYPE ) {
2023-05-19 12:03:01 +00:00
if ( value . get_type ( ) = = Variant : : OBJECT ) {
if ( Node * n = Object : : cast_to < Node > ( value ) ) {
value = p_node - > get_path_to ( n ) ;
}
use_deferred_node_path_bit = true ;
}
2022-06-18 22:42:02 +00:00
if ( value . get_type ( ) ! = Variant : : NODE_PATH ) {
continue ; //was never set, ignore.
}
} else if ( E . type = = Variant : : OBJECT & & missing_resource_properties . has ( E . name ) ) {
2022-05-23 19:32:19 +00:00
// Was this missing resource overridden? If so do not save the old value.
2022-04-28 20:49:10 +00:00
Ref < Resource > ures = value ;
if ( ures . is_null ( ) ) {
value = missing_resource_properties [ E . name ] ;
}
2023-02-13 22:54:44 +00:00
} else if ( E . type = = Variant : : ARRAY & & E . hint = = PROPERTY_HINT_TYPE_STRING ) {
int hint_subtype_separator = E . hint_string . find ( " : " ) ;
if ( hint_subtype_separator > = 0 ) {
String subtype_string = E . hint_string . substr ( 0 , hint_subtype_separator ) ;
int slash_pos = subtype_string . find ( " / " ) ;
PropertyHint subtype_hint = PropertyHint : : PROPERTY_HINT_NONE ;
if ( slash_pos > = 0 ) {
subtype_hint = PropertyHint ( subtype_string . get_slice ( " / " , 1 ) . to_int ( ) ) ;
subtype_string = subtype_string . substr ( 0 , slash_pos ) ;
}
Variant : : Type subtype = Variant : : Type ( subtype_string . to_int ( ) ) ;
2023-05-19 12:03:01 +00:00
if ( subtype = = Variant : : OBJECT & & subtype_hint = = PROPERTY_HINT_NODE_TYPE ) {
use_deferred_node_path_bit = true ;
Array array = value ;
Array new_array ;
for ( int i = 0 ; i < array . size ( ) ; i + + ) {
Variant elem = array [ i ] ;
if ( elem . get_type ( ) = = Variant : : OBJECT ) {
if ( Node * n = Object : : cast_to < Node > ( elem ) ) {
new_array . push_back ( p_node - > get_path_to ( n ) ) ;
continue ;
}
}
new_array . push_back ( elem ) ;
}
value = new_array ;
}
2023-02-13 22:54:44 +00:00
}
2022-04-28 20:49:10 +00:00
}
2022-04-01 18:30:23 +00:00
if ( ! pinned_props . has ( name ) ) {
2021-12-11 13:03:48 +00:00
bool is_valid_default = false ;
Variant default_value = PropertyUtils : : get_property_default_value ( p_node , name , & is_valid_default , & states_stack , true ) ;
2024-01-16 19:41:58 +00:00
2021-12-11 13:03:48 +00:00
if ( is_valid_default & & ! PropertyUtils : : is_property_value_different ( value , default_value ) ) {
2024-01-16 19:41:58 +00:00
if ( value . get_type ( ) = = Variant : : ARRAY & & has_local_resource ( value ) ) {
// Save anyway
} else if ( value . get_type ( ) = = Variant : : DICTIONARY ) {
Dictionary dictionary = value ;
if ( ! has_local_resource ( dictionary . values ( ) ) & & ! has_local_resource ( dictionary . keys ( ) ) ) {
continue ;
}
} else {
continue ;
}
2021-10-26 19:12:25 +00:00
}
2014-02-23 13:35:05 +00:00
}
NodeData : : Property prop ;
prop . name = _nm_get_string ( name , name_map ) ;
prop . value = _vm_get_variant ( value , variant_map ) ;
2022-06-18 22:42:02 +00:00
if ( use_deferred_node_path_bit ) {
prop . name | = FLAG_PATH_PROPERTY_IS_NODE ;
}
2014-02-23 13:35:05 +00:00
nd . properties . push_back ( prop ) ;
}
2015-10-10 12:09:09 +00:00
// save the groups this node is into
// discard groups that come from the original scene
2014-02-23 13:35:05 +00:00
List < Node : : GroupInfo > groups ;
p_node - > get_groups ( & groups ) ;
2021-07-24 13:46:25 +00:00
for ( const Node : : GroupInfo & gi : groups ) {
2020-05-14 14:41:43 +00:00
if ( ! gi . persistent ) {
2014-02-23 13:35:05 +00:00
continue ;
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
bool skip = false ;
2021-09-14 11:05:54 +00:00
for ( const SceneState : : PackState & ia : states_stack ) {
2015-10-10 12:09:09 +00:00
//check all levels of pack to see if the group was added somewhere
2021-09-14 11:05:54 +00:00
if ( ia . state - > is_node_in_group ( ia . node , gi . name ) ) {
2015-10-10 12:09:09 +00:00
skip = true ;
break ;
}
}
2020-05-14 14:41:43 +00:00
if ( skip ) {
2015-10-10 12:09:09 +00:00
continue ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
nd . groups . push_back ( _nm_get_string ( gi . name , name_map ) ) ;
}
2015-10-10 12:09:09 +00:00
// save the right owner
// for the saved scene root this is -1
// for nodes of the saved scene this is 0
2021-06-17 22:03:09 +00:00
// for nodes of instantiated scenes this is >0
2015-10-10 12:09:09 +00:00
if ( p_node = = p_owner ) {
//saved scene root
nd . owner = - 1 ;
} else if ( p_node - > get_owner ( ) = = p_owner ) {
//part of saved scene
nd . owner = 0 ;
} else {
2014-02-23 13:35:05 +00:00
nd . owner = - 1 ;
2015-10-10 12:09:09 +00:00
}
2022-04-28 20:49:10 +00:00
MissingNode * missing_node = Object : : cast_to < MissingNode > ( p_node ) ;
2015-10-10 12:09:09 +00:00
// Save the right type. If this node was created by an instance
2016-03-08 23:00:52 +00:00
// then flag that the node should not be created but reused
2021-09-14 11:05:54 +00:00
if ( states_stack . is_empty ( ) & & ! is_editable_instance ) {
2022-11-15 23:13:39 +00:00
//This node is not part of an instantiation process, so save the type.
2022-04-28 20:49:10 +00:00
if ( missing_node ! = nullptr ) {
2022-05-23 19:32:19 +00:00
// It's a missing node (type non existent on load).
2022-04-28 20:49:10 +00:00
nd . type = _nm_get_string ( missing_node - > get_original_class ( ) , name_map ) ;
} else {
nd . type = _nm_get_string ( p_node - > get_class ( ) , name_map ) ;
}
2015-10-10 12:09:09 +00:00
} else {
2021-06-17 22:03:09 +00:00
// this node is part of an instantiated process, so do not save the type.
// instead, save that it was instantiated
2022-11-15 23:13:39 +00:00
nd . type = TYPE_INSTANTIATED ;
2015-10-10 12:09:09 +00:00
}
// determine whether to save this node or not
2021-06-17 22:03:09 +00:00
// if this node is part of an instantiated sub-scene, we can skip storing it if basically
2015-10-10 12:09:09 +00:00
// no properties changed and no groups were added to it.
// below condition is true for all nodes of the scene being saved, and ones in subscenes
// that hold changes
bool save_node = nd . properties . size ( ) | | nd . groups . size ( ) ; // some local properties or groups exist
save_node = save_node | | p_node = = p_owner ; // owner is always saved
2021-09-14 11:05:54 +00:00
save_node = save_node | | ( p_node - > get_owner ( ) = = p_owner & & instantiated_by_owner ) ; //part of scene and not instanced
2014-02-23 13:35:05 +00:00
int idx = nodes . size ( ) ;
2015-10-10 12:09:09 +00:00
int parent_node = NO_PARENT_SAVED ;
if ( save_node ) {
//don't save the node if nothing and subscene
node_map [ p_node ] = idx ;
//ok validate parent node
if ( p_parent_idx = = NO_PARENT_SAVED ) {
int sidx ;
if ( nodepath_map . has ( p_node - > get_parent ( ) ) ) {
sidx = nodepath_map [ p_node - > get_parent ( ) ] ;
} else {
sidx = nodepath_map . size ( ) ;
nodepath_map [ p_node - > get_parent ( ) ] = sidx ;
}
nd . parent = FLAG_ID_IS_PATH | sidx ;
} else {
nd . parent = p_parent_idx ;
}
parent_node = idx ;
nodes . push_back ( nd ) ;
}
2014-02-23 13:35:05 +00:00
for ( int i = 0 ; i < p_node - > get_child_count ( ) ; i + + ) {
Node * c = p_node - > get_child ( i ) ;
2015-10-10 12:09:09 +00:00
Error err = _parse_node ( p_owner , c , parent_node , name_map , variant_map , node_map , nodepath_map ) ;
2020-05-14 14:41:43 +00:00
if ( err ) {
2014-02-23 13:35:05 +00:00
return err ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
}
return OK ;
}
2022-05-13 13:04:37 +00:00
Error SceneState : : _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 ) {
2020-05-14 14:41:43 +00:00
if ( p_node ! = p_owner & & p_node - > get_owner ( ) & & p_node - > get_owner ( ) ! = p_owner & & ! p_owner - > is_editable_instance ( p_node - > get_owner ( ) ) ) {
2015-10-10 12:09:09 +00:00
return OK ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
2015-10-10 12:09:09 +00:00
List < MethodInfo > _signals ;
p_node - > get_signal_list ( & _signals ) ;
2016-06-30 21:43:47 +00:00
_signals . sort ( ) ;
2014-02-23 13:35:05 +00:00
2015-10-10 12:09:09 +00:00
//ERR_FAIL_COND_V( !node_map.has(p_node), ERR_BUG);
//NodeData &nd = nodes[node_map[p_node]];
2014-02-23 13:35:05 +00:00
2021-07-24 13:46:25 +00:00
for ( const MethodInfo & E : _signals ) {
2014-02-23 13:35:05 +00:00
List < Node : : Connection > conns ;
2021-07-16 03:45:57 +00:00
p_node - > get_signal_connection_list ( E . name , & conns ) ;
2016-06-30 21:43:47 +00:00
conns . sort ( ) ;
2021-07-24 13:46:25 +00:00
for ( const Node : : Connection & F : conns ) {
2021-07-16 03:45:57 +00:00
const Node : : Connection & c = F ;
2015-10-10 12:09:09 +00:00
2020-05-14 14:41:43 +00:00
if ( ! ( c . flags & CONNECT_PERSIST ) ) { //only persistent connections get saved
2014-02-23 13:35:05 +00:00
continue ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
2015-10-10 12:09:09 +00:00
// only connections that originate or end into main saved scene are saved
// everything else is discarded
2014-02-23 13:35:05 +00:00
2020-02-19 19:27:19 +00:00
Node * target = Object : : cast_to < Node > ( c . callable . get_object ( ) ) ;
2016-07-19 23:04:06 +00:00
if ( ! target ) {
2014-02-23 13:35:05 +00:00
continue ;
2015-10-10 12:09:09 +00:00
}
2021-10-01 00:40:07 +00:00
Vector < Variant > binds ;
int unbinds = 0 ;
Callable base_callable ;
if ( c . callable . is_custom ( ) ) {
CallableCustomBind * ccb = dynamic_cast < CallableCustomBind * > ( c . callable . get_custom ( ) ) ;
if ( ccb ) {
binds = ccb - > get_binds ( ) ;
base_callable = ccb - > get_callable ( ) ;
}
CallableCustomUnbind * ccu = dynamic_cast < CallableCustomUnbind * > ( c . callable . get_custom ( ) ) ;
if ( ccu ) {
unbinds = ccu - > get_unbinds ( ) ;
base_callable = ccu - > get_callable ( ) ;
}
} else {
base_callable = c . callable ;
}
2016-07-19 23:04:06 +00:00
//find if this connection already exists
Node * common_parent = target - > find_common_parent_with ( p_node ) ;
ERR_CONTINUE ( ! common_parent ) ;
2021-12-09 09:42:46 +00:00
if ( common_parent ! = p_owner & & common_parent - > get_scene_file_path ( ) . is_empty ( ) ) {
2016-07-19 23:04:06 +00:00
common_parent = common_parent - > get_owner ( ) ;
}
bool exists = false ;
//go through ownership chain to see if this exists
while ( common_parent ) {
Ref < SceneState > ps ;
2014-02-23 13:35:05 +00:00
2020-05-14 14:41:43 +00:00
if ( common_parent = = p_owner ) {
2016-07-19 23:04:06 +00:00
ps = common_parent - > get_scene_inherited_state ( ) ;
2020-05-14 14:41:43 +00:00
} else {
2016-07-19 23:04:06 +00:00
ps = common_parent - > get_scene_instance_state ( ) ;
2020-05-14 14:41:43 +00:00
}
2016-07-19 23:04:06 +00:00
if ( ps . is_valid ( ) ) {
NodePath signal_from = common_parent - > get_path_to ( p_node ) ;
NodePath signal_to = common_parent - > get_path_to ( target ) ;
2021-10-01 00:40:07 +00:00
if ( ps - > has_connection ( signal_from , c . signal . get_name ( ) , signal_to , base_callable . get_method ( ) ) ) {
2016-07-20 00:26:12 +00:00
exists = true ;
break ;
2016-07-19 23:04:06 +00:00
}
}
2020-05-14 14:41:43 +00:00
if ( common_parent = = p_owner ) {
2016-07-19 23:04:06 +00:00
break ;
2020-05-14 14:41:43 +00:00
} else {
2016-07-19 23:04:06 +00:00
common_parent = common_parent - > get_owner ( ) ;
2020-05-14 14:41:43 +00:00
}
2016-07-19 23:04:06 +00:00
}
if ( exists ) { //already exists (comes from instance or inheritance), so don't save
2014-02-23 13:35:05 +00:00
continue ;
}
2015-10-10 12:09:09 +00:00
{
Node * nl = p_node ;
2019-02-12 20:10:08 +00:00
bool exists2 = false ;
2015-10-10 12:09:09 +00:00
while ( nl ) {
if ( nl = = p_owner ) {
Ref < SceneState > state = nl - > get_scene_inherited_state ( ) ;
if ( state . is_valid ( ) ) {
int from_node = state - > find_node_by_path ( nl - > get_path_to ( p_node ) ) ;
2016-07-19 23:04:06 +00:00
int to_node = state - > find_node_by_path ( nl - > get_path_to ( target ) ) ;
2015-10-10 12:09:09 +00:00
if ( from_node > = 0 & & to_node > = 0 ) {
//this one has state for this node, save
2021-10-01 00:40:07 +00:00
if ( state - > is_connection ( from_node , c . signal . get_name ( ) , to_node , base_callable . get_method ( ) ) ) {
2019-02-12 20:10:08 +00:00
exists2 = true ;
2015-10-10 12:09:09 +00:00
break ;
}
}
}
2020-04-01 23:20:12 +00:00
nl = nullptr ;
2015-10-10 12:09:09 +00:00
} else {
2021-12-09 09:42:46 +00:00
if ( ! nl - > get_scene_file_path ( ) . is_empty ( ) ) {
2015-10-10 12:09:09 +00:00
//is an instance
Ref < SceneState > state = nl - > get_scene_instance_state ( ) ;
if ( state . is_valid ( ) ) {
int from_node = state - > find_node_by_path ( nl - > get_path_to ( p_node ) ) ;
2016-07-19 23:04:06 +00:00
int to_node = state - > find_node_by_path ( nl - > get_path_to ( target ) ) ;
2015-10-10 12:09:09 +00:00
if ( from_node > = 0 & & to_node > = 0 ) {
//this one has state for this node, save
2021-10-01 00:40:07 +00:00
if ( state - > is_connection ( from_node , c . signal . get_name ( ) , to_node , base_callable . get_method ( ) ) ) {
2019-02-12 20:10:08 +00:00
exists2 = true ;
2015-10-10 12:09:09 +00:00
break ;
}
}
}
}
nl = nl - > get_owner ( ) ;
}
}
2019-02-12 20:10:08 +00:00
if ( exists2 ) {
2015-10-10 12:09:09 +00:00
continue ;
}
}
int src_id ;
if ( node_map . has ( p_node ) ) {
src_id = node_map [ p_node ] ;
} else {
if ( nodepath_map . has ( p_node ) ) {
src_id = FLAG_ID_IS_PATH | nodepath_map [ p_node ] ;
} else {
int sidx = nodepath_map . size ( ) ;
nodepath_map [ p_node ] = sidx ;
src_id = FLAG_ID_IS_PATH | sidx ;
}
}
int target_id ;
2016-07-19 23:04:06 +00:00
if ( node_map . has ( target ) ) {
target_id = node_map [ target ] ;
2015-10-10 12:09:09 +00:00
} else {
2016-07-19 23:04:06 +00:00
if ( nodepath_map . has ( target ) ) {
target_id = FLAG_ID_IS_PATH | nodepath_map [ target ] ;
2015-10-10 12:09:09 +00:00
} else {
int sidx = nodepath_map . size ( ) ;
2016-07-19 23:04:06 +00:00
nodepath_map [ target ] = sidx ;
2015-10-10 12:09:09 +00:00
target_id = FLAG_ID_IS_PATH | sidx ;
}
}
2014-02-23 13:35:05 +00:00
ConnectionData cd ;
2015-10-10 12:09:09 +00:00
cd . from = src_id ;
cd . to = target_id ;
2021-10-01 00:40:07 +00:00
cd . method = _nm_get_string ( base_callable . get_method ( ) , name_map ) ;
2020-02-19 19:27:19 +00:00
cd . signal = _nm_get_string ( c . signal . get_name ( ) , name_map ) ;
2023-09-16 13:37:56 +00:00
cd . flags = c . flags & ~ CONNECT_INHERITED ; // Do not store inherited.
2021-10-01 00:40:07 +00:00
cd . unbinds = unbinds ;
2022-07-28 20:56:41 +00:00
2021-10-01 00:40:07 +00:00
for ( int i = 0 ; i < binds . size ( ) ; i + + ) {
cd . binds . push_back ( _vm_get_variant ( binds [ i ] , variant_map ) ) ;
}
2014-02-23 13:35:05 +00:00
connections . push_back ( cd ) ;
}
}
for ( int i = 0 ; i < p_node - > get_child_count ( ) ; i + + ) {
Node * c = p_node - > get_child ( i ) ;
2015-10-10 12:09:09 +00:00
Error err = _parse_connections ( p_owner , c , name_map , variant_map , node_map , nodepath_map ) ;
2020-05-14 14:41:43 +00:00
if ( err ) {
2014-02-23 13:35:05 +00:00
return err ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
}
return OK ;
}
2015-10-10 12:09:09 +00:00
Error SceneState : : pack ( Node * p_scene ) {
2014-02-23 13:35:05 +00:00
ERR_FAIL_NULL_V ( p_scene , ERR_INVALID_PARAMETER ) ;
clear ( ) ;
Node * scene = p_scene ;
2022-05-13 13:04:37 +00:00
HashMap < StringName , int > name_map ;
2017-02-15 13:41:16 +00:00
HashMap < Variant , int , VariantHasher , VariantComparator > variant_map ;
2022-05-13 13:04:37 +00:00
HashMap < Node * , int > node_map ;
HashMap < Node * , int > nodepath_map ;
2015-10-10 12:09:09 +00:00
2020-09-18 11:35:51 +00:00
// If using scene inheritance, pack the scene it inherits from.
2015-10-10 12:09:09 +00:00
if ( scene - > get_scene_inherited_state ( ) . is_valid ( ) ) {
2022-09-29 09:53:28 +00:00
String scene_path = scene - > get_scene_inherited_state ( ) - > get_path ( ) ;
Ref < PackedScene > instance = ResourceLoader : : load ( scene_path ) ;
2015-10-10 12:09:09 +00:00
if ( instance . is_valid ( ) ) {
base_scene_idx = _vm_get_variant ( instance , variant_map ) ;
}
}
2020-09-18 11:35:51 +00:00
// Instanced, only direct sub-scenes are supported of course.
2015-10-10 12:09:09 +00:00
Error err = _parse_node ( scene , scene , - 1 , name_map , variant_map , node_map , nodepath_map ) ;
2014-02-23 13:35:05 +00:00
if ( err ) {
clear ( ) ;
ERR_FAIL_V ( err ) ;
}
2015-10-10 12:09:09 +00:00
err = _parse_connections ( scene , scene , name_map , variant_map , node_map , nodepath_map ) ;
2014-02-23 13:35:05 +00:00
if ( err ) {
clear ( ) ;
ERR_FAIL_V ( err ) ;
}
names . resize ( name_map . size ( ) ) ;
2021-08-09 20:13:42 +00:00
for ( const KeyValue < StringName , int > & E : name_map ) {
names . write [ E . value ] = E . key ;
2014-02-23 13:35:05 +00:00
}
variants . resize ( variant_map . size ( ) ) ;
2022-05-08 08:09:19 +00:00
for ( const KeyValue < Variant , int > & E : variant_map ) {
int idx = E . value ;
variants . write [ idx ] = E . key ;
2014-02-23 13:35:05 +00:00
}
2015-10-10 12:09:09 +00:00
node_paths . resize ( nodepath_map . size ( ) ) ;
2021-08-09 20:13:42 +00:00
for ( const KeyValue < Node * , int > & E : nodepath_map ) {
node_paths . write [ E . value ] = scene - > get_path_to ( E . key ) ;
2015-10-10 12:09:09 +00:00
}
2021-06-19 11:11:30 +00:00
if ( Engine : : get_singleton ( ) - > is_editor_hint ( ) ) {
// Build node path cache
2021-08-09 20:13:42 +00:00
for ( const KeyValue < Node * , int > & E : node_map ) {
node_path_cache [ scene - > get_path_to ( E . key ) ] = E . value ;
2021-06-19 11:11:30 +00:00
}
}
2014-02-23 13:35:05 +00:00
return OK ;
}
2015-10-10 12:09:09 +00:00
void SceneState : : set_path ( const String & p_path ) {
path = p_path ;
}
String SceneState : : get_path ( ) const {
return path ;
}
void SceneState : : clear ( ) {
2014-02-23 13:35:05 +00:00
names . clear ( ) ;
variants . clear ( ) ;
nodes . clear ( ) ;
connections . clear ( ) ;
2015-10-10 12:09:09 +00:00
node_path_cache . clear ( ) ;
node_paths . clear ( ) ;
editable_instances . clear ( ) ;
base_scene_idx = - 1 ;
2014-02-23 13:35:05 +00:00
}
2022-11-26 18:46:04 +00:00
Error SceneState : : copy_from ( const Ref < SceneState > & p_scene_state ) {
ERR_FAIL_COND_V ( p_scene_state . is_null ( ) , ERR_INVALID_PARAMETER ) ;
clear ( ) ;
for ( const StringName & E : p_scene_state - > names ) {
names . append ( E ) ;
}
for ( const Variant & E : p_scene_state - > variants ) {
variants . append ( E ) ;
}
for ( const SceneState : : NodeData & E : p_scene_state - > nodes ) {
nodes . append ( E ) ;
}
for ( const SceneState : : ConnectionData & E : p_scene_state - > connections ) {
connections . append ( E ) ;
}
for ( KeyValue < NodePath , int > & E : p_scene_state - > node_path_cache ) {
node_path_cache . insert ( E . key , E . value ) ;
}
for ( const NodePath & E : p_scene_state - > node_paths ) {
node_paths . append ( E ) ;
}
for ( const NodePath & E : p_scene_state - > editable_instances ) {
editable_instances . append ( E ) ;
}
base_scene_idx = p_scene_state - > base_scene_idx ;
return OK ;
}
2021-09-14 11:05:54 +00:00
Ref < SceneState > SceneState : : get_base_scene_state ( ) const {
2015-10-10 12:09:09 +00:00
if ( base_scene_idx > = 0 ) {
Ref < PackedScene > ps = variants [ base_scene_idx ] ;
if ( ps . is_valid ( ) ) {
return ps - > get_state ( ) ;
}
}
return Ref < SceneState > ( ) ;
}
2022-01-30 21:31:32 +00:00
void SceneState : : update_instance_resource ( String p_path , Ref < PackedScene > p_packed_scene ) {
ERR_FAIL_COND ( p_packed_scene . is_null ( ) ) ;
for ( const NodeData & nd : nodes ) {
if ( nd . instance > = 0 ) {
if ( ! ( nd . instance & FLAG_INSTANCE_IS_PLACEHOLDER ) ) {
int instance_id = nd . instance & FLAG_MASK ;
Ref < PackedScene > original_packed_scene = variants [ instance_id ] ;
if ( original_packed_scene . is_valid ( ) ) {
if ( original_packed_scene - > get_path ( ) = = p_path ) {
variants . remove_at ( instance_id ) ;
variants . insert ( instance_id , p_packed_scene ) ;
}
}
}
}
}
}
2015-10-10 12:09:09 +00:00
int SceneState : : find_node_by_path ( const NodePath & p_node ) const {
2024-01-19 12:21:39 +00:00
ERR_FAIL_COND_V_MSG ( node_path_cache . is_empty ( ) , - 1 , " This operation requires the node cache to have been built. " ) ;
2021-06-19 11:11:30 +00:00
2016-03-08 23:00:52 +00:00
if ( ! node_path_cache . has ( p_node ) ) {
2021-09-14 11:05:54 +00:00
if ( get_base_scene_state ( ) . is_valid ( ) ) {
int idx = get_base_scene_state ( ) - > find_node_by_path ( p_node ) ;
2021-06-19 11:11:30 +00:00
if ( idx ! = - 1 ) {
2017-03-08 19:08:24 +00:00
int rkey = _find_base_scene_node_remap_key ( idx ) ;
if ( rkey = = - 1 ) {
rkey = nodes . size ( ) + base_scene_node_remap . size ( ) ;
base_scene_node_remap [ rkey ] = idx ;
2015-10-10 12:09:09 +00:00
}
2017-03-08 19:08:24 +00:00
return rkey ;
2015-10-10 12:09:09 +00:00
}
}
return - 1 ;
}
int nid = node_path_cache [ p_node ] ;
2021-09-14 11:05:54 +00:00
if ( get_base_scene_state ( ) . is_valid ( ) & & ! base_scene_node_remap . has ( nid ) ) {
2015-10-10 12:09:09 +00:00
//for nodes that _do_ exist in current scene, still try to look for
2021-06-17 22:03:09 +00:00
//the node in the instantiated scene, as a property may be missing
2015-10-10 12:09:09 +00:00
//from the local one
2021-09-14 11:05:54 +00:00
int idx = get_base_scene_state ( ) - > find_node_by_path ( p_node ) ;
2017-03-08 19:08:24 +00:00
if ( idx ! = - 1 ) {
base_scene_node_remap [ nid ] = idx ;
}
2015-10-10 12:09:09 +00:00
}
return nid ;
}
2017-03-08 19:08:24 +00:00
int SceneState : : _find_base_scene_node_remap_key ( int p_idx ) const {
2021-08-09 20:13:42 +00:00
for ( const KeyValue < int , int > & E : base_scene_node_remap ) {
if ( E . value = = p_idx ) {
return E . key ;
2017-03-08 19:08:24 +00:00
}
}
return - 1 ;
}
2024-02-17 03:53:30 +00:00
Variant SceneState : : get_property_value ( int p_node , const StringName & p_property , bool & r_found , bool & r_node_deferred ) const {
r_found = false ;
r_node_deferred = false ;
2015-10-10 12:09:09 +00:00
ERR_FAIL_COND_V ( p_node < 0 , Variant ( ) ) ;
if ( p_node < nodes . size ( ) ) {
2024-02-17 03:53:30 +00:00
// Find in built-in nodes.
2015-10-10 12:09:09 +00:00
int pc = nodes [ p_node ] . properties . size ( ) ;
const StringName * namep = names . ptr ( ) ;
const NodeData : : Property * p = nodes [ p_node ] . properties . ptr ( ) ;
for ( int i = 0 ; i < pc ; i + + ) {
2022-06-18 22:42:02 +00:00
if ( p_property = = namep [ p [ i ] . name & FLAG_PROP_NAME_MASK ] ) {
2024-02-17 03:53:30 +00:00
r_found = true ;
r_node_deferred = p [ i ] . name & FLAG_PATH_PROPERTY_IS_NODE ;
2015-10-10 12:09:09 +00:00
return variants [ p [ i ] . value ] ;
}
}
}
2024-02-17 03:53:30 +00:00
// Property not found, try on instance.
HashMap < int , int > : : ConstIterator I = base_scene_node_remap . find ( p_node ) ;
if ( I ) {
return get_base_scene_state ( ) - > get_property_value ( I - > value , p_property , r_found , r_node_deferred ) ;
2015-10-10 12:09:09 +00:00
}
return Variant ( ) ;
}
bool SceneState : : is_node_in_group ( int p_node , const StringName & p_group ) const {
ERR_FAIL_COND_V ( p_node < 0 , false ) ;
if ( p_node < nodes . size ( ) ) {
const StringName * namep = names . ptr ( ) ;
for ( int i = 0 ; i < nodes [ p_node ] . groups . size ( ) ; i + + ) {
2020-05-14 14:41:43 +00:00
if ( namep [ nodes [ p_node ] . groups [ i ] ] = = p_group ) {
2015-10-10 12:09:09 +00:00
return true ;
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
}
}
if ( base_scene_node_remap . has ( p_node ) ) {
2021-09-14 11:05:54 +00:00
return get_base_scene_state ( ) - > is_node_in_group ( base_scene_node_remap [ p_node ] , p_group ) ;
2015-10-10 12:09:09 +00:00
}
return false ;
}
2015-10-16 22:11:23 +00:00
bool SceneState : : disable_placeholders = false ;
void SceneState : : set_disable_placeholders ( bool p_disable ) {
disable_placeholders = p_disable ;
}
2015-10-10 12:09:09 +00:00
bool SceneState : : is_connection ( int p_node , const StringName & p_signal , int p_to_node , const StringName & p_to_method ) const {
ERR_FAIL_COND_V ( p_node < 0 , false ) ;
ERR_FAIL_COND_V ( p_to_node < 0 , false ) ;
if ( p_node < nodes . size ( ) & & p_to_node < nodes . size ( ) ) {
int signal_idx = - 1 ;
int method_idx = - 1 ;
for ( int i = 0 ; i < names . size ( ) ; i + + ) {
if ( names [ i ] = = p_signal ) {
signal_idx = i ;
} else if ( names [ i ] = = p_to_method ) {
method_idx = i ;
}
}
if ( signal_idx > = 0 & & method_idx > = 0 ) {
//signal and method strings are stored..
for ( int i = 0 ; i < connections . size ( ) ; i + + ) {
if ( connections [ i ] . from = = p_node & & connections [ i ] . to = = p_to_node & & connections [ i ] . signal = = signal_idx & & connections [ i ] . method = = method_idx ) {
return true ;
}
}
}
}
if ( base_scene_node_remap . has ( p_node ) & & base_scene_node_remap . has ( p_to_node ) ) {
2021-09-14 11:05:54 +00:00
return get_base_scene_state ( ) - > is_connection ( base_scene_node_remap [ p_node ] , p_signal , base_scene_node_remap [ p_to_node ] , p_to_method ) ;
2015-10-10 12:09:09 +00:00
}
return false ;
}
2017-08-11 19:10:05 +00:00
void SceneState : : set_bundled_scene ( const Dictionary & p_dictionary ) {
ERR_FAIL_COND ( ! p_dictionary . has ( " names " ) ) ;
ERR_FAIL_COND ( ! p_dictionary . has ( " variants " ) ) ;
ERR_FAIL_COND ( ! p_dictionary . has ( " node_count " ) ) ;
ERR_FAIL_COND ( ! p_dictionary . has ( " nodes " ) ) ;
ERR_FAIL_COND ( ! p_dictionary . has ( " conn_count " ) ) ;
ERR_FAIL_COND ( ! p_dictionary . has ( " conns " ) ) ;
//ERR_FAIL_COND( !p_dictionary.has("path"));
2014-02-23 13:35:05 +00:00
2015-10-10 12:09:09 +00:00
int version = 1 ;
2020-05-14 14:41:43 +00:00
if ( p_dictionary . has ( " version " ) ) {
2017-08-11 19:10:05 +00:00
version = p_dictionary [ " version " ] ;
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
2019-11-30 16:22:22 +00:00
ERR_FAIL_COND_MSG ( version > PACKED_SCENE_VERSION , " Save format version too new. " ) ;
2015-10-10 12:09:09 +00:00
2020-01-05 03:08:24 +00:00
const int node_count = p_dictionary [ " node_count " ] ;
2020-02-17 21:06:54 +00:00
const Vector < int > snodes = p_dictionary [ " nodes " ] ;
2020-01-06 23:21:17 +00:00
ERR_FAIL_COND ( snodes . size ( ) < node_count ) ;
2020-01-05 03:08:24 +00:00
const int conn_count = p_dictionary [ " conn_count " ] ;
2020-02-17 21:06:54 +00:00
const Vector < int > sconns = p_dictionary [ " conns " ] ;
2020-01-06 23:21:17 +00:00
ERR_FAIL_COND ( sconns . size ( ) < conn_count ) ;
2020-01-05 03:08:24 +00:00
2020-02-17 21:06:54 +00:00
Vector < String > snames = p_dictionary [ " names " ] ;
2014-02-23 13:35:05 +00:00
if ( snames . size ( ) ) {
int namecount = snames . size ( ) ;
names . resize ( namecount ) ;
2020-02-17 21:06:54 +00:00
const String * r = snames . ptr ( ) ;
2020-05-14 14:41:43 +00:00
for ( int i = 0 ; i < names . size ( ) ; i + + ) {
2018-07-25 01:11:03 +00:00
names . write [ i ] = r [ i ] ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
}
2017-08-11 19:10:05 +00:00
Array svariants = p_dictionary [ " variants " ] ;
2014-02-23 13:35:05 +00:00
if ( svariants . size ( ) ) {
int varcount = svariants . size ( ) ;
variants . resize ( varcount ) ;
for ( int i = 0 ; i < varcount ; i + + ) {
2018-07-25 01:11:03 +00:00
variants . write [ i ] = svariants [ i ] ;
2014-02-23 13:35:05 +00:00
}
} else {
variants . clear ( ) ;
}
2020-01-05 03:08:24 +00:00
nodes . resize ( node_count ) ;
if ( node_count ) {
2020-02-17 21:06:54 +00:00
const int * r = snodes . ptr ( ) ;
2014-02-23 13:35:05 +00:00
int idx = 0 ;
2020-01-05 03:08:24 +00:00
for ( int i = 0 ; i < node_count ; i + + ) {
2018-07-25 01:11:03 +00:00
NodeData & nd = nodes . write [ i ] ;
2014-02-23 13:35:05 +00:00
nd . parent = r [ idx + + ] ;
nd . owner = r [ idx + + ] ;
nd . type = r [ idx + + ] ;
2017-12-16 18:48:16 +00:00
uint32_t name_index = r [ idx + + ] ;
nd . name = name_index & ( ( 1 < < NAME_INDEX_BITS ) - 1 ) ;
nd . index = ( name_index > > NAME_INDEX_BITS ) ;
2018-01-18 20:37:17 +00:00
nd . index - - ; //0 is invalid, stored as 1
2014-02-23 13:35:05 +00:00
nd . instance = r [ idx + + ] ;
nd . properties . resize ( r [ idx + + ] ) ;
for ( int j = 0 ; j < nd . properties . size ( ) ; j + + ) {
2018-07-25 01:11:03 +00:00
nd . properties . write [ j ] . name = r [ idx + + ] ;
nd . properties . write [ j ] . value = r [ idx + + ] ;
2014-02-23 13:35:05 +00:00
}
nd . groups . resize ( r [ idx + + ] ) ;
for ( int j = 0 ; j < nd . groups . size ( ) ; j + + ) {
2018-07-25 01:11:03 +00:00
nd . groups . write [ j ] = r [ idx + + ] ;
2014-02-23 13:35:05 +00:00
}
}
}
2020-01-05 03:08:24 +00:00
connections . resize ( conn_count ) ;
if ( conn_count ) {
2020-02-17 21:06:54 +00:00
const int * r = sconns . ptr ( ) ;
2014-02-23 13:35:05 +00:00
int idx = 0 ;
2020-01-05 03:08:24 +00:00
for ( int i = 0 ; i < conn_count ; i + + ) {
2018-07-25 01:11:03 +00:00
ConnectionData & cd = connections . write [ i ] ;
2014-02-23 13:35:05 +00:00
cd . from = r [ idx + + ] ;
cd . to = r [ idx + + ] ;
cd . signal = r [ idx + + ] ;
cd . method = r [ idx + + ] ;
cd . flags = r [ idx + + ] ;
cd . binds . resize ( r [ idx + + ] ) ;
for ( int j = 0 ; j < cd . binds . size ( ) ; j + + ) {
2018-07-25 01:11:03 +00:00
cd . binds . write [ j ] = r [ idx + + ] ;
2014-02-23 13:35:05 +00:00
}
2023-01-31 16:10:41 +00:00
if ( version > = 3 ) {
cd . unbinds = r [ idx + + ] ;
}
2014-02-23 13:35:05 +00:00
}
}
2015-10-10 12:09:09 +00:00
Array np ;
2017-08-11 19:10:05 +00:00
if ( p_dictionary . has ( " node_paths " ) ) {
np = p_dictionary [ " node_paths " ] ;
2015-10-10 12:09:09 +00:00
}
node_paths . resize ( np . size ( ) ) ;
for ( int i = 0 ; i < np . size ( ) ; i + + ) {
2018-07-25 01:11:03 +00:00
node_paths . write [ i ] = np [ i ] ;
2015-10-10 12:09:09 +00:00
}
Array ei ;
2017-08-11 19:10:05 +00:00
if ( p_dictionary . has ( " editable_instances " ) ) {
ei = p_dictionary [ " editable_instances " ] ;
2015-10-10 12:09:09 +00:00
}
2017-08-11 19:10:05 +00:00
if ( p_dictionary . has ( " base_scene " ) ) {
base_scene_idx = p_dictionary [ " base_scene " ] ;
2015-10-10 12:09:09 +00:00
}
editable_instances . resize ( ei . size ( ) ) ;
for ( int i = 0 ; i < editable_instances . size ( ) ; i + + ) {
2018-07-25 01:11:03 +00:00
editable_instances . write [ i ] = ei [ i ] ;
2015-10-10 12:09:09 +00:00
}
2017-08-11 19:10:05 +00:00
//path=p_dictionary["path"];
2014-02-23 13:35:05 +00:00
}
2015-10-10 12:09:09 +00:00
Dictionary SceneState : : get_bundled_scene ( ) const {
2020-02-17 21:06:54 +00:00
Vector < String > rnames ;
2014-02-23 13:35:05 +00:00
rnames . resize ( names . size ( ) ) ;
if ( names . size ( ) ) {
2020-02-17 21:06:54 +00:00
String * r = rnames . ptrw ( ) ;
2014-02-23 13:35:05 +00:00
2020-05-14 14:41:43 +00:00
for ( int i = 0 ; i < names . size ( ) ; i + + ) {
2014-02-23 13:35:05 +00:00
r [ i ] = names [ i ] ;
2020-05-14 14:41:43 +00:00
}
2014-02-23 13:35:05 +00:00
}
Dictionary d ;
d [ " names " ] = rnames ;
d [ " variants " ] = variants ;
Vector < int > rnodes ;
d [ " node_count " ] = nodes . size ( ) ;
for ( int i = 0 ; i < nodes . size ( ) ; i + + ) {
const NodeData & nd = nodes [ i ] ;
rnodes . push_back ( nd . parent ) ;
rnodes . push_back ( nd . owner ) ;
rnodes . push_back ( nd . type ) ;
2017-12-16 18:48:16 +00:00
uint32_t name_index = nd . name ;
2018-01-18 20:37:17 +00:00
if ( nd . index < ( 1 < < ( 32 - NAME_INDEX_BITS ) ) - 1 ) { //save if less than 16k children
2017-12-16 18:48:16 +00:00
name_index | = uint32_t ( nd . index + 1 ) < < NAME_INDEX_BITS ; //for backwards compatibility, index 0 is no index
}
rnodes . push_back ( name_index ) ;
2014-02-23 13:35:05 +00:00
rnodes . push_back ( nd . instance ) ;
rnodes . push_back ( nd . properties . size ( ) ) ;
for ( int j = 0 ; j < nd . properties . size ( ) ; j + + ) {
rnodes . push_back ( nd . properties [ j ] . name ) ;
rnodes . push_back ( nd . properties [ j ] . value ) ;
}
rnodes . push_back ( nd . groups . size ( ) ) ;
for ( int j = 0 ; j < nd . groups . size ( ) ; j + + ) {
rnodes . push_back ( nd . groups [ j ] ) ;
}
}
d [ " nodes " ] = rnodes ;
Vector < int > rconns ;
d [ " conn_count " ] = connections . size ( ) ;
for ( int i = 0 ; i < connections . size ( ) ; i + + ) {
const ConnectionData & cd = connections [ i ] ;
rconns . push_back ( cd . from ) ;
rconns . push_back ( cd . to ) ;
rconns . push_back ( cd . signal ) ;
rconns . push_back ( cd . method ) ;
rconns . push_back ( cd . flags ) ;
rconns . push_back ( cd . binds . size ( ) ) ;
2020-05-14 14:41:43 +00:00
for ( int j = 0 ; j < cd . binds . size ( ) ; j + + ) {
2014-02-23 13:35:05 +00:00
rconns . push_back ( cd . binds [ j ] ) ;
2020-05-14 14:41:43 +00:00
}
2023-01-31 16:10:41 +00:00
rconns . push_back ( cd . unbinds ) ;
2014-02-23 13:35:05 +00:00
}
d [ " conns " ] = rconns ;
2015-10-10 12:09:09 +00:00
Array rnode_paths ;
rnode_paths . resize ( node_paths . size ( ) ) ;
for ( int i = 0 ; i < node_paths . size ( ) ; i + + ) {
rnode_paths [ i ] = node_paths [ i ] ;
2016-03-08 23:00:52 +00:00
}
2015-10-10 12:09:09 +00:00
d [ " node_paths " ] = rnode_paths ;
Array reditable_instances ;
reditable_instances . resize ( editable_instances . size ( ) ) ;
for ( int i = 0 ; i < editable_instances . size ( ) ; i + + ) {
reditable_instances [ i ] = editable_instances [ i ] ;
}
d [ " editable_instances " ] = reditable_instances ;
if ( base_scene_idx > = 0 ) {
d [ " base_scene " ] = base_scene_idx ;
}
2019-11-30 16:22:22 +00:00
d [ " version " ] = PACKED_SCENE_VERSION ;
2014-02-23 13:35:05 +00:00
return d ;
}
2015-10-10 12:09:09 +00:00
int SceneState : : get_node_count ( ) const {
return nodes . size ( ) ;
}
StringName SceneState : : get_node_type ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , StringName ( ) ) ;
2022-11-15 23:13:39 +00:00
if ( nodes [ p_idx ] . type = = TYPE_INSTANTIATED ) {
2015-10-10 12:09:09 +00:00
return StringName ( ) ;
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
return names [ nodes [ p_idx ] . type ] ;
}
StringName SceneState : : get_node_name ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , StringName ( ) ) ;
return names [ nodes [ p_idx ] . name ] ;
}
2017-12-08 14:05:15 +00:00
int SceneState : : get_node_index ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , - 1 ) ;
return nodes [ p_idx ] . index ;
}
2016-02-21 14:17:50 +00:00
bool SceneState : : is_node_instance_placeholder ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , false ) ;
2017-09-07 19:48:50 +00:00
return nodes [ p_idx ] . instance > = 0 & & ( nodes [ p_idx ] . instance & FLAG_INSTANCE_IS_PLACEHOLDER ) ;
2016-02-21 14:17:50 +00:00
}
2015-10-10 12:09:09 +00:00
Ref < PackedScene > SceneState : : get_node_instance ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , Ref < PackedScene > ( ) ) ;
2015-11-28 23:56:14 +00:00
2015-10-10 12:09:09 +00:00
if ( nodes [ p_idx ] . instance > = 0 ) {
2020-05-14 14:41:43 +00:00
if ( nodes [ p_idx ] . instance & FLAG_INSTANCE_IS_PLACEHOLDER ) {
2016-02-21 14:17:50 +00:00
return Ref < PackedScene > ( ) ;
2020-05-14 14:41:43 +00:00
} else {
2016-02-21 14:17:50 +00:00
return variants [ nodes [ p_idx ] . instance & FLAG_MASK ] ;
2020-05-14 14:41:43 +00:00
}
2015-11-28 23:56:14 +00:00
} else if ( nodes [ p_idx ] . parent < 0 | | nodes [ p_idx ] . parent = = NO_PARENT_SAVED ) {
2015-10-10 12:09:09 +00:00
if ( base_scene_idx > = 0 ) {
return variants [ base_scene_idx ] ;
}
}
return Ref < PackedScene > ( ) ;
}
2016-02-21 14:17:50 +00:00
String SceneState : : get_node_instance_placeholder ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , String ( ) ) ;
2017-09-07 19:48:50 +00:00
if ( nodes [ p_idx ] . instance > = 0 & & ( nodes [ p_idx ] . instance & FLAG_INSTANCE_IS_PLACEHOLDER ) ) {
2016-02-21 14:17:50 +00:00
return variants [ nodes [ p_idx ] . instance & FLAG_MASK ] ;
}
return String ( ) ;
}
2015-10-10 12:09:09 +00:00
Vector < StringName > SceneState : : get_node_groups ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , Vector < StringName > ( ) ) ;
Vector < StringName > groups ;
for ( int i = 0 ; i < nodes [ p_idx ] . groups . size ( ) ; i + + ) {
groups . push_back ( names [ nodes [ p_idx ] . groups [ i ] ] ) ;
}
return groups ;
}
NodePath SceneState : : get_node_path ( int p_idx , bool p_for_parent ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , NodePath ( ) ) ;
if ( nodes [ p_idx ] . parent < 0 | | nodes [ p_idx ] . parent = = NO_PARENT_SAVED ) {
if ( p_for_parent ) {
return NodePath ( ) ;
} else {
return NodePath ( " . " ) ;
}
}
Vector < StringName > sub_path ;
NodePath base_path ;
int nidx = p_idx ;
while ( true ) {
if ( nodes [ nidx ] . parent = = NO_PARENT_SAVED | | nodes [ nidx ] . parent < 0 ) {
sub_path . insert ( 0 , " . " ) ;
break ;
}
if ( ! p_for_parent | | p_idx ! = nidx ) {
sub_path . insert ( 0 , names [ nodes [ nidx ] . name ] ) ;
}
if ( nodes [ nidx ] . parent & FLAG_ID_IS_PATH ) {
base_path = node_paths [ nodes [ nidx ] . parent & FLAG_MASK ] ;
break ;
} else {
nidx = nodes [ nidx ] . parent & FLAG_MASK ;
}
}
2016-06-20 20:09:53 +00:00
for ( int i = base_path . get_name_count ( ) - 1 ; i > = 0 ; i - - ) {
2015-10-10 12:09:09 +00:00
sub_path . insert ( 0 , base_path . get_name ( i ) ) ;
}
2020-12-15 12:04:21 +00:00
if ( sub_path . is_empty ( ) ) {
2015-10-10 12:09:09 +00:00
return NodePath ( " . " ) ;
}
return NodePath ( sub_path , false ) ;
}
int SceneState : : get_node_property_count ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , - 1 ) ;
return nodes [ p_idx ] . properties . size ( ) ;
}
2020-05-14 12:29:06 +00:00
2015-10-10 12:09:09 +00:00
StringName SceneState : : get_node_property_name ( int p_idx , int p_prop ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , StringName ( ) ) ;
ERR_FAIL_INDEX_V ( p_prop , nodes [ p_idx ] . properties . size ( ) , StringName ( ) ) ;
2022-06-18 22:42:02 +00:00
return names [ nodes [ p_idx ] . properties [ p_prop ] . name & FLAG_PROP_NAME_MASK ] ;
}
Vector < String > SceneState : : get_node_deferred_nodepath_properties ( int p_idx ) const {
Vector < String > ret ;
2024-02-17 03:53:30 +00:00
ERR_FAIL_COND_V ( p_idx < 0 , ret ) ;
if ( p_idx < nodes . size ( ) ) {
// Find in built-in nodes.
for ( int i = 0 ; i < nodes [ p_idx ] . properties . size ( ) ; i + + ) {
uint32_t idx = nodes [ p_idx ] . properties [ i ] . name ;
if ( idx & FLAG_PATH_PROPERTY_IS_NODE ) {
ret . push_back ( names [ idx & FLAG_PROP_NAME_MASK ] ) ;
}
2022-06-18 22:42:02 +00:00
}
2024-02-17 03:53:30 +00:00
return ret ;
2022-06-18 22:42:02 +00:00
}
2024-02-17 03:53:30 +00:00
// Property not found, try on instance.
HashMap < int , int > : : ConstIterator I = base_scene_node_remap . find ( p_idx ) ;
if ( I ) {
return get_base_scene_state ( ) - > get_node_deferred_nodepath_properties ( I - > value ) ;
}
2022-06-18 22:42:02 +00:00
return ret ;
2015-10-10 12:09:09 +00:00
}
2020-05-14 12:29:06 +00:00
2015-10-10 12:09:09 +00:00
Variant SceneState : : get_node_property_value ( int p_idx , int p_prop ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , Variant ( ) ) ;
ERR_FAIL_INDEX_V ( p_prop , nodes [ p_idx ] . properties . size ( ) , Variant ( ) ) ;
return variants [ nodes [ p_idx ] . properties [ p_prop ] . value ] ;
}
NodePath SceneState : : get_node_owner_path ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , nodes . size ( ) , NodePath ( ) ) ;
2020-05-14 14:41:43 +00:00
if ( nodes [ p_idx ] . owner < 0 | | nodes [ p_idx ] . owner = = NO_PARENT_SAVED ) {
2015-10-10 12:09:09 +00:00
return NodePath ( ) ; //root likely
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
if ( nodes [ p_idx ] . owner & FLAG_ID_IS_PATH ) {
return node_paths [ nodes [ p_idx ] . owner & FLAG_MASK ] ;
} else {
return get_node_path ( nodes [ p_idx ] . owner & FLAG_MASK ) ;
}
}
int SceneState : : get_connection_count ( ) const {
return connections . size ( ) ;
}
2020-05-14 12:29:06 +00:00
2015-10-10 12:09:09 +00:00
NodePath SceneState : : get_connection_source ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , connections . size ( ) , NodePath ( ) ) ;
if ( connections [ p_idx ] . from & FLAG_ID_IS_PATH ) {
return node_paths [ connections [ p_idx ] . from & FLAG_MASK ] ;
} else {
return get_node_path ( connections [ p_idx ] . from & FLAG_MASK ) ;
}
}
StringName SceneState : : get_connection_signal ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , connections . size ( ) , StringName ( ) ) ;
return names [ connections [ p_idx ] . signal ] ;
}
2020-05-14 12:29:06 +00:00
2015-10-10 12:09:09 +00:00
NodePath SceneState : : get_connection_target ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , connections . size ( ) , NodePath ( ) ) ;
if ( connections [ p_idx ] . to & FLAG_ID_IS_PATH ) {
return node_paths [ connections [ p_idx ] . to & FLAG_MASK ] ;
} else {
return get_node_path ( connections [ p_idx ] . to & FLAG_MASK ) ;
}
}
2020-05-14 12:29:06 +00:00
2015-10-10 12:09:09 +00:00
StringName SceneState : : get_connection_method ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , connections . size ( ) , StringName ( ) ) ;
return names [ connections [ p_idx ] . method ] ;
}
2016-07-19 23:04:06 +00:00
2015-10-10 12:09:09 +00:00
int SceneState : : get_connection_flags ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , connections . size ( ) , - 1 ) ;
return connections [ p_idx ] . flags ;
}
2021-10-01 00:40:07 +00:00
int SceneState : : get_connection_unbinds ( int p_idx ) const {
ERR_FAIL_INDEX_V ( p_idx , connections . size ( ) , - 1 ) ;
return connections [ p_idx ] . unbinds ;
}
2015-10-10 12:09:09 +00:00
Array SceneState : : get_connection_binds ( int p_idx ) const {
2016-05-17 21:27:15 +00:00
ERR_FAIL_INDEX_V ( p_idx , connections . size ( ) , Array ( ) ) ;
2015-10-10 12:09:09 +00:00
Array binds ;
for ( int i = 0 ; i < connections [ p_idx ] . binds . size ( ) ; i + + ) {
binds . push_back ( variants [ connections [ p_idx ] . binds [ i ] ] ) ;
}
return binds ;
}
2022-09-30 10:28:39 +00:00
bool SceneState : : has_connection ( const NodePath & p_node_from , const StringName & p_signal , const NodePath & p_node_to , const StringName & p_method , bool p_no_inheritance ) {
2017-03-15 10:46:45 +00:00
// this method cannot be const because of this
Ref < SceneState > ss = this ;
2016-07-19 23:04:06 +00:00
2017-03-15 10:46:45 +00:00
do {
for ( int i = 0 ; i < ss - > connections . size ( ) ; i + + ) {
const ConnectionData & c = ss - > connections [ i ] ;
2016-07-20 00:26:12 +00:00
2017-03-15 10:46:45 +00:00
NodePath np_from ;
2016-07-20 00:26:12 +00:00
2017-03-15 10:46:45 +00:00
if ( c . from & FLAG_ID_IS_PATH ) {
np_from = ss - > node_paths [ c . from & FLAG_MASK ] ;
} else {
np_from = ss - > get_node_path ( c . from ) ;
}
2016-07-20 00:26:12 +00:00
2017-03-15 10:46:45 +00:00
NodePath np_to ;
2016-07-20 00:26:12 +00:00
2017-03-15 10:46:45 +00:00
if ( c . to & FLAG_ID_IS_PATH ) {
np_to = ss - > node_paths [ c . to & FLAG_MASK ] ;
} else {
np_to = ss - > get_node_path ( c . to ) ;
}
2016-07-19 23:04:06 +00:00
2017-03-15 10:46:45 +00:00
StringName sn_signal = ss - > names [ c . signal ] ;
StringName sn_method = ss - > names [ c . method ] ;
if ( np_from = = p_node_from & & sn_signal = = p_signal & & np_to = = p_node_to & & sn_method = = p_method ) {
return true ;
}
2016-07-19 23:04:06 +00:00
}
2017-03-15 10:46:45 +00:00
2022-09-30 10:28:39 +00:00
if ( p_no_inheritance ) {
break ;
}
2021-09-14 11:05:54 +00:00
ss = ss - > get_base_scene_state ( ) ;
2017-03-15 10:46:45 +00:00
} while ( ss . is_valid ( ) ) ;
2016-07-19 23:04:06 +00:00
return false ;
}
2015-10-10 12:09:09 +00:00
Vector < NodePath > SceneState : : get_editable_instances ( ) const {
return editable_instances ;
}
2020-05-14 12:29:06 +00:00
2015-11-28 23:56:14 +00:00
//add
int SceneState : : add_name ( const StringName & p_name ) {
names . push_back ( p_name ) ;
return names . size ( ) - 1 ;
}
int SceneState : : add_value ( const Variant & p_value ) {
variants . push_back ( p_value ) ;
return variants . size ( ) - 1 ;
}
int SceneState : : add_node_path ( const NodePath & p_path ) {
node_paths . push_back ( p_path ) ;
return ( node_paths . size ( ) - 1 ) | FLAG_ID_IS_PATH ;
}
2020-05-14 12:29:06 +00:00
2017-12-08 14:05:15 +00:00
int SceneState : : add_node ( int p_parent , int p_owner , int p_type , int p_name , int p_instance , int p_index ) {
2015-11-28 23:56:14 +00:00
NodeData nd ;
nd . parent = p_parent ;
nd . owner = p_owner ;
nd . type = p_type ;
nd . name = p_name ;
nd . instance = p_instance ;
2017-12-08 14:05:15 +00:00
nd . index = p_index ;
2015-11-28 23:56:14 +00:00
nodes . push_back ( nd ) ;
return nodes . size ( ) - 1 ;
}
2020-05-14 12:29:06 +00:00
2022-06-18 22:42:02 +00:00
void SceneState : : add_node_property ( int p_node , int p_name , int p_value , bool p_deferred_node_path ) {
2015-11-28 23:56:14 +00:00
ERR_FAIL_INDEX ( p_node , nodes . size ( ) ) ;
ERR_FAIL_INDEX ( p_name , names . size ( ) ) ;
ERR_FAIL_INDEX ( p_value , variants . size ( ) ) ;
NodeData : : Property prop ;
prop . name = p_name ;
2022-06-18 22:42:02 +00:00
if ( p_deferred_node_path ) {
prop . name | = FLAG_PATH_PROPERTY_IS_NODE ;
}
2015-11-28 23:56:14 +00:00
prop . value = p_value ;
2018-07-25 01:11:03 +00:00
nodes . write [ p_node ] . properties . push_back ( prop ) ;
2015-11-28 23:56:14 +00:00
}
2020-05-14 12:29:06 +00:00
2015-11-28 23:56:14 +00:00
void SceneState : : add_node_group ( int p_node , int p_group ) {
ERR_FAIL_INDEX ( p_node , nodes . size ( ) ) ;
ERR_FAIL_INDEX ( p_group , names . size ( ) ) ;
2018-07-25 01:11:03 +00:00
nodes . write [ p_node ] . groups . push_back ( p_group ) ;
2015-11-28 23:56:14 +00:00
}
2020-05-14 12:29:06 +00:00
2015-11-28 23:56:14 +00:00
void SceneState : : set_base_scene ( int p_idx ) {
ERR_FAIL_INDEX ( p_idx , variants . size ( ) ) ;
base_scene_idx = p_idx ;
}
2020-05-14 12:29:06 +00:00
2021-10-01 00:40:07 +00:00
void SceneState : : 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 ) {
2015-11-28 23:56:14 +00:00
ERR_FAIL_INDEX ( p_signal , names . size ( ) ) ;
ERR_FAIL_INDEX ( p_method , names . size ( ) ) ;
for ( int i = 0 ; i < p_binds . size ( ) ; i + + ) {
ERR_FAIL_INDEX ( p_binds [ i ] , variants . size ( ) ) ;
}
ConnectionData c ;
c . from = p_from ;
c . to = p_to ;
c . signal = p_signal ;
c . method = p_method ;
c . flags = p_flags ;
2021-10-01 00:40:07 +00:00
c . unbinds = p_unbinds ;
2015-11-28 23:56:14 +00:00
c . binds = p_binds ;
connections . push_back ( c ) ;
}
2020-05-14 12:29:06 +00:00
2015-11-28 23:56:14 +00:00
void SceneState : : add_editable_instance ( const NodePath & p_path ) {
editable_instances . push_back ( p_path ) ;
}
2022-05-12 08:20:12 +00:00
bool SceneState : : remove_group_references ( const StringName & p_name ) {
bool edited = false ;
for ( NodeData & node : nodes ) {
for ( const int & group : node . groups ) {
if ( names [ group ] = = p_name ) {
node . groups . erase ( group ) ;
edited = true ;
break ;
}
}
}
return edited ;
}
bool SceneState : : rename_group_references ( const StringName & p_old_name , const StringName & p_new_name ) {
bool edited = false ;
for ( const NodeData & node : nodes ) {
for ( const int & group : node . groups ) {
if ( names [ group ] = = p_old_name ) {
names . write [ group ] = p_new_name ;
edited = true ;
break ;
}
}
}
return edited ;
}
HashSet < StringName > SceneState : : get_all_groups ( ) {
HashSet < StringName > ret ;
for ( const NodeData & node : nodes ) {
for ( const int & group : node . groups ) {
ret . insert ( names [ group ] ) ;
}
}
return ret ;
}
2020-02-17 21:06:54 +00:00
Vector < String > SceneState : : _get_node_groups ( int p_idx ) const {
2016-01-23 15:01:42 +00:00
Vector < StringName > groups = get_node_groups ( p_idx ) ;
2020-02-17 21:06:54 +00:00
Vector < String > ret ;
2016-01-23 15:01:42 +00:00
2020-05-14 14:41:43 +00:00
for ( int i = 0 ; i < groups . size ( ) ; i + + ) {
2016-01-23 15:01:42 +00:00
ret . push_back ( groups [ i ] ) ;
2020-05-14 14:41:43 +00:00
}
2016-01-23 15:01:42 +00:00
return ret ;
}
void SceneState : : _bind_methods ( ) {
//unbuild API
2017-02-13 11:47:24 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_node_count " ) , & SceneState : : get_node_count ) ;
ClassDB : : bind_method ( D_METHOD ( " get_node_type " , " idx " ) , & SceneState : : get_node_type ) ;
ClassDB : : bind_method ( D_METHOD ( " get_node_name " , " idx " ) , & SceneState : : get_node_name ) ;
ClassDB : : bind_method ( D_METHOD ( " get_node_path " , " idx " , " for_parent " ) , & SceneState : : get_node_path , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " get_node_owner_path " , " idx " ) , & SceneState : : get_node_owner_path ) ;
ClassDB : : bind_method ( D_METHOD ( " is_node_instance_placeholder " , " idx " ) , & SceneState : : is_node_instance_placeholder ) ;
ClassDB : : bind_method ( D_METHOD ( " get_node_instance_placeholder " , " idx " ) , & SceneState : : get_node_instance_placeholder ) ;
2017-08-09 11:19:41 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_node_instance " , " idx " ) , & SceneState : : get_node_instance ) ;
2017-02-13 11:47:24 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_node_groups " , " idx " ) , & SceneState : : _get_node_groups ) ;
2017-12-08 14:05:15 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_node_index " , " idx " ) , & SceneState : : get_node_index ) ;
2017-02-13 11:47:24 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_node_property_count " , " idx " ) , & SceneState : : get_node_property_count ) ;
ClassDB : : bind_method ( D_METHOD ( " get_node_property_name " , " idx " , " prop_idx " ) , & SceneState : : get_node_property_name ) ;
2017-08-09 11:19:41 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_node_property_value " , " idx " , " prop_idx " ) , & SceneState : : get_node_property_value ) ;
2017-02-13 11:47:24 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_connection_count " ) , & SceneState : : get_connection_count ) ;
ClassDB : : bind_method ( D_METHOD ( " get_connection_source " , " idx " ) , & SceneState : : get_connection_source ) ;
ClassDB : : bind_method ( D_METHOD ( " get_connection_signal " , " idx " ) , & SceneState : : get_connection_signal ) ;
ClassDB : : bind_method ( D_METHOD ( " get_connection_target " , " idx " ) , & SceneState : : get_connection_target ) ;
ClassDB : : bind_method ( D_METHOD ( " get_connection_method " , " idx " ) , & SceneState : : get_connection_method ) ;
ClassDB : : bind_method ( D_METHOD ( " get_connection_flags " , " idx " ) , & SceneState : : get_connection_flags ) ;
ClassDB : : bind_method ( D_METHOD ( " get_connection_binds " , " idx " ) , & SceneState : : get_connection_binds ) ;
2021-10-01 00:40:07 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_connection_unbinds " , " idx " ) , & SceneState : : get_connection_unbinds ) ;
2017-03-05 15:44:50 +00:00
2017-08-20 15:45:01 +00:00
BIND_ENUM_CONSTANT ( GEN_EDIT_STATE_DISABLED ) ;
BIND_ENUM_CONSTANT ( GEN_EDIT_STATE_INSTANCE ) ;
BIND_ENUM_CONSTANT ( GEN_EDIT_STATE_MAIN ) ;
2021-10-26 19:12:25 +00:00
BIND_ENUM_CONSTANT ( GEN_EDIT_STATE_MAIN_INHERITED ) ;
2016-01-23 15:01:42 +00:00
}
2015-10-10 12:09:09 +00:00
SceneState : : SceneState ( ) {
}
////////////////
2017-08-11 19:10:05 +00:00
void PackedScene : : _set_bundled_scene ( const Dictionary & p_scene ) {
state - > set_bundled_scene ( p_scene ) ;
2015-10-10 12:09:09 +00:00
}
Dictionary PackedScene : : _get_bundled_scene ( ) const {
return state - > get_bundled_scene ( ) ;
}
Error PackedScene : : pack ( Node * p_scene ) {
return state - > pack ( p_scene ) ;
}
void PackedScene : : clear ( ) {
state - > clear ( ) ;
}
2022-11-26 18:46:04 +00:00
void PackedScene : : reload_from_file ( ) {
String path = get_path ( ) ;
if ( ! path . is_resource_file ( ) ) {
return ;
}
Ref < PackedScene > s = ResourceLoader : : load ( ResourceLoader : : path_remap ( path ) , get_class ( ) , ResourceFormatLoader : : CACHE_MODE_IGNORE ) ;
if ( ! s . is_valid ( ) ) {
return ;
}
// Backup the loaded_state
Ref < SceneState > loaded_state = s - > get_state ( ) ;
// This assigns a new state to s->state
// We do this because of the next step
s - > recreate_state ( ) ;
// This has a side-effect to clear s->state
copy_from ( s ) ;
// Then, we copy the backed-up loaded_state to state
state - > copy_from ( loaded_state ) ;
}
2021-06-17 22:03:09 +00:00
bool PackedScene : : can_instantiate ( ) const {
return state - > can_instantiate ( ) ;
2015-10-10 12:09:09 +00:00
}
2021-06-17 22:03:09 +00:00
Node * PackedScene : : instantiate ( GenEditState p_edit_state ) const {
2015-10-10 12:09:09 +00:00
# ifndef TOOLS_ENABLED
2020-04-01 23:20:12 +00:00
ERR_FAIL_COND_V_MSG ( p_edit_state ! = GEN_EDIT_STATE_DISABLED , nullptr , " Edit state is only for editors, does not work without tools compiled. " ) ;
2015-10-10 12:09:09 +00:00
# endif
2021-06-17 22:03:09 +00:00
Node * s = state - > instantiate ( ( SceneState : : GenEditState ) p_edit_state ) ;
2020-05-14 14:41:43 +00:00
if ( ! s ) {
2020-04-01 23:20:12 +00:00
return nullptr ;
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
2017-01-10 04:04:31 +00:00
if ( p_edit_state ! = GEN_EDIT_STATE_DISABLED ) {
2015-10-10 12:09:09 +00:00
s - > set_scene_instance_state ( state ) ;
}
2021-07-10 19:17:41 +00:00
if ( ! is_built_in ( ) ) {
2021-09-30 14:30:55 +00:00
s - > set_scene_file_path ( get_path ( ) ) ;
2020-05-14 14:41:43 +00:00
}
2015-10-10 12:09:09 +00:00
2022-08-14 22:50:31 +00:00
s - > notification ( Node : : NOTIFICATION_SCENE_INSTANTIATED ) ;
2015-10-10 12:09:09 +00:00
return s ;
}
2016-01-14 14:06:20 +00:00
void PackedScene : : replace_state ( Ref < SceneState > p_by ) {
state = p_by ;
state - > set_path ( get_path ( ) ) ;
# ifdef TOOLS_ENABLED
state - > set_last_modified_time ( get_last_modified_time ( ) ) ;
# endif
}
2015-12-13 23:39:01 +00:00
void PackedScene : : recreate_state ( ) {
state = Ref < SceneState > ( memnew ( SceneState ) ) ;
state - > set_path ( get_path ( ) ) ;
# ifdef TOOLS_ENABLED
state - > set_last_modified_time ( get_last_modified_time ( ) ) ;
# endif
}
2022-03-05 20:22:38 +00:00
Ref < SceneState > PackedScene : : get_state ( ) const {
2015-10-10 12:09:09 +00:00
return state ;
}
void PackedScene : : set_path ( const String & p_path , bool p_take_over ) {
state - > set_path ( p_path ) ;
Resource : : set_path ( p_path , p_take_over ) ;
}
2024-02-22 11:53:19 +00:00
void PackedScene : : set_path_cache ( const String & p_path ) {
state - > set_path ( p_path ) ;
Resource : : set_path_cache ( p_path ) ;
}
2021-02-11 17:18:45 +00:00
void PackedScene : : reset_state ( ) {
clear ( ) ;
}
2014-02-23 13:35:05 +00:00
void PackedScene : : _bind_methods ( ) {
2017-08-09 11:19:41 +00:00
ClassDB : : bind_method ( D_METHOD ( " pack " , " path " ) , & PackedScene : : pack ) ;
2021-06-17 22:03:09 +00:00
ClassDB : : bind_method ( D_METHOD ( " instantiate " , " edit_state " ) , & PackedScene : : instantiate , DEFVAL ( GEN_EDIT_STATE_DISABLED ) ) ;
ClassDB : : bind_method ( D_METHOD ( " can_instantiate " ) , & PackedScene : : can_instantiate ) ;
2022-08-08 12:18:26 +00:00
ClassDB : : bind_method ( D_METHOD ( " _set_bundled_scene " , " scene " ) , & PackedScene : : _set_bundled_scene ) ;
2017-02-13 11:47:24 +00:00
ClassDB : : bind_method ( D_METHOD ( " _get_bundled_scene " ) , & PackedScene : : _get_bundled_scene ) ;
2017-08-09 11:19:41 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_state " ) , & PackedScene : : get_state ) ;
2014-02-23 13:35:05 +00:00
2017-01-10 04:04:31 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : DICTIONARY , " _bundled " ) , " _set_bundled_scene " , " _get_bundled_scene " ) ;
2017-08-20 15:45:01 +00:00
BIND_ENUM_CONSTANT ( GEN_EDIT_STATE_DISABLED ) ;
BIND_ENUM_CONSTANT ( GEN_EDIT_STATE_INSTANCE ) ;
BIND_ENUM_CONSTANT ( GEN_EDIT_STATE_MAIN ) ;
2021-10-26 19:12:25 +00:00
BIND_ENUM_CONSTANT ( GEN_EDIT_STATE_MAIN_INHERITED ) ;
2014-02-23 13:35:05 +00:00
}
PackedScene : : PackedScene ( ) {
2015-10-10 12:09:09 +00:00
state = Ref < SceneState > ( memnew ( SceneState ) ) ;
2014-02-23 13:35:05 +00:00
}