aboutsummaryrefslogtreecommitdiff
path: root/doc/classes/PackedScene.xml
diff options
context:
space:
mode:
authorMax Hilbrunner2018-03-28 23:07:03 +0200
committerHein-Pieter van Braam2018-04-29 14:25:17 +0200
commitec017f4c01d7e948a2762c8182cd3032e6237c75 (patch)
tree3376ca9ac8dedbc68fce1528e7547f862305d0d4 /doc/classes/PackedScene.xml
parentf12db4013e211199eb9203540c2018e5a7c3834e (diff)
downloadgodot-ec017f4c01d7e948a2762c8182cd3032e6237c75.tar.gz
godot-ec017f4c01d7e948a2762c8182cd3032e6237c75.tar.zst
godot-ec017f4c01d7e948a2762c8182cd3032e6237c75.zip
[DOCS] Node & PackedScene (#17833)
* [DOCS] Node: SceneSaver -> PackedScene * [DOCS] PackedScene: Code example, resolve TODO (cherry picked from commit 13d5ee01f9d62e8a4b867b46e902b5d9d25f9bd1)
Diffstat (limited to 'doc/classes/PackedScene.xml')
-rw-r--r--doc/classes/PackedScene.xml9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml
index f277beff2..1a3f6f31a 100644
--- a/doc/classes/PackedScene.xml
+++ b/doc/classes/PackedScene.xml
@@ -5,7 +5,14 @@
</brief_description>
<description>
A simplified interface to a scene file. Provides access to operations and checks that can be performed on the scene resource itself.
- TODO: explain ownership, and that node does not 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 [code]owner[/code] property on [Node]). Note that the node doesn't need to own itself.
+ Example of saving a node:
+ [codeblock]
+ var scene = PackedScene.new()
+ var result = scene.pack(child)
+ if result == OK:
+ ResourceSaver.save("res://path/name.scn", scene) // or user://...
+ [/codeblock]
</description>
<tutorials>
</tutorials>