godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Fix links case and sync headers with editor

Browse Source 
Output from godotengine/godot#22002.
This commit is contained in:
Rémi Verschelde
2018-09-13 01:56:41 +02:00
parent 942b6d3ac1
commit f9caa4be29
579 changed files with 16363 additions and 16329 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
classes/class_packedscene.rst
View File

@@ -7,8 +7,7 @@
PackedScene
===========
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -16,31 +15,21 @@ Brief Description
An abstraction of a serialized scene.
Member Functions
----------------
Methods
-------
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_instance<class_PackedScene_can_instance>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SceneState<class_scenestate>` | :ref:`get_state<class_PackedScene_get_state>` **(** **)** |
| :ref:`SceneState<class_SceneState>` | :ref:`get_state<class_PackedScene_get_state>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>` | :ref:`instance<class_PackedScene_instance>` **(** :ref:`GenEditState<enum_packedscene_geneditstate>` edit_state=0 **)** const |
| :ref:`Node<class_Node>` | :ref:`instance<class_PackedScene_instance>` **(** :ref:`GenEditState<enum_PackedScene_GenEditState>` edit_state=0 **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@globalscope_error>` | :ref:`pack<class_PackedScene_pack>` **(** :ref:`Node<class_node>` path **)** |
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`pack<class_PackedScene_pack>` **(** :ref:`Node<class_Node>` path **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_PackedScene__bundled:
- :ref:`Dictionary<class_dictionary>` **_bundled** - A dictionary representation of the scene contents.
Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene.
Enums
-----
Enumerations
------------
.. _enum_PackedScene_GenEditState:
@@ -56,7 +45,7 @@ Description
A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself.
Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see ``owner`` property on :ref:`Node<class_node>`). Note that the node doesn't need to own itself.
Can be used to save a node to a file. When saving, the node as well as all the node it owns get saved (see ``owner`` property on :ref:`Node<class_Node>`). Note that the node doesn't need to own itself.
Example of saving a node:
@@ -67,8 +56,18 @@ Example of saving a node:
if result == OK:
ResourceSaver.save("res://path/name.scn", scene) // or user://...
Member Function Description
---------------------------
Property Descriptions
---------------------
.. _class_PackedScene__bundled:
- :ref:`Dictionary<class_Dictionary>` **_bundled** - A dictionary representation of the scene contents.
Available keys include "rnames" and "variants" for resources, "node_count", "nodes", "node_paths" for nodes, "editable_instances" for base scene children overrides, "conn_count" and "conns" for signal connections, and "version" for the format style of the PackedScene.
Method Descriptions
-------------------
.. _class_PackedScene_can_instance:
@@ -78,19 +77,19 @@ Returns ``true`` if the scene file has nodes.
.. _class_PackedScene_get_state:
- :ref:`SceneState<class_scenestate>` **get_state** **(** **)**
- :ref:`SceneState<class_SceneState>` **get_state** **(** **)**
Returns the ``SceneState`` representing the scene file contents.
.. _class_PackedScene_instance:
- :ref:`Node<class_node>` **instance** **(** :ref:`GenEditState<enum_packedscene_geneditstate>` edit_state=0 **)** const
- :ref:`Node<class_Node>` **instance** **(** :ref:`GenEditState<enum_PackedScene_GenEditState>` edit_state=0 **)** const
Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the :ref:`NOTIFICATION_INSTANCED<enum_object_notification_instanced>` notification on the root node.
Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the :ref:`NOTIFICATION_INSTANCED<enum_Object_NOTIFICATION_INSTANCED>` notification on the root node.
.. _class_PackedScene_pack:
- :ref:`Error<enum_@globalscope_error>` **pack** **(** :ref:`Node<class_node>` path **)**
- :ref:`Error<enum_@GlobalScope_Error>` **pack** **(** :ref:`Node<class_Node>` path **)**
Pack will ignore any sub-nodes not owned by given node. See :ref:`Node.set_owner<class_Node_set_owner>`.