diff options
author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-22 01:04:47 +0200 |
---|---|---|
committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-27 22:30:19 +0200 |
commit | f7f6115f7627df24a08a9a0882b2f573cc838eb1 (patch) | |
tree | 03fd75145084c88702dbbb7e54c42c7c02d54fa6 /doc/classes/PackedScene.xml | |
parent | 538c8eec15d72b67e102f47f9df7624c29d14607 (diff) |
Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
Diffstat (limited to 'doc/classes/PackedScene.xml')
-rw-r--r-- | doc/classes/PackedScene.xml | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 7827571178..a5989f8494 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -5,26 +5,27 @@ </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. - 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 with different owners: The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidBody2D[/code] ([code]rigid[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]rigid[/code] which is a child of [code]node[/code]. Only [code]rigid[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code]. + 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]). + [b]Note:[/b] The node doesn't need to own itself. + [b]Example of saving a node with different owners:[/b] The following example creates 3 objects: [code]Node2D[/code] ([code]node[/code]), [code]RigidBody2D[/code] ([code]rigid[/code]) and [code]CollisionObject2D[/code] ([code]collision[/code]). [code]collision[/code] is a child of [code]rigid[/code] which is a child of [code]node[/code]. Only [code]rigid[/code] is owned by [code]node[/code] and [code]pack[/code] will therefore only save those two nodes, but not [code]collision[/code]. [codeblock] - # create the objects + # Create the objects var node = Node2D.new() var rigid = RigidBody2D.new() var collision = CollisionShape2D.new() - # create the object hierarchy + # Create the object hierarchy rigid.add_child(collision) node.add_child(rigid) - # change owner of rigid, but not of collision + # Change owner of rigid, but not of collision rigid.owner = node var scene = PackedScene.new() - # only node and rigid are now packed + # Only node and rigid are now packed var result = scene.pack(node) if result == OK: - ResourceSaver.save("res://path/name.scn", scene) # or user://... + ResourceSaver.save("res://path/name.scn", scene) # Or "user://..." [/codeblock] </description> <tutorials> @@ -74,10 +75,12 @@ If passed to [method instance], blocks edits to the scene state. </constant> <constant name="GEN_EDIT_STATE_INSTANCE" value="1" enum="GenEditState"> - If passed to [method instance], provides local scene resources to the local scene. Requires tools compiled. + If passed to [method instance], provides local scene resources to the local scene. + [b]Note:[/b] Only available in editor builds. </constant> <constant name="GEN_EDIT_STATE_MAIN" value="2" enum="GenEditState"> - If passed to [method instance], provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled. + If passed to [method instance], provides local scene resources to the local scene. Only the main scene should receive the main edit state. + [b]Note:[/b] Only available in editor builds. </constant> </constants> </class> |