From 9f341971c91104d088cdbdf7d8d712282ef65498 Mon Sep 17 00:00:00 2001 From: Will Nations Date: Sun, 3 Dec 2017 22:34:28 -0600 Subject: [PATCH] [DOCS] PackedScene member/method/class descs. --- doc/classes/PackedScene.xml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 3940995936f..80ef3afdb18 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -1,8 +1,10 @@ + An abstraction of a serialized scene. + 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 @@ -14,12 +16,14 @@ + Returns [code]true[/code] if the scene file has nodes. + Returns the [code]SceneState[/code] representing the scene file contents. @@ -28,6 +32,7 @@ + Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the [enum Object.NOTIFICATION_INSTANCED] notification on the root node. @@ -42,14 +47,19 @@ + 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. + If passed to [method instance], blocks edits to the scene state. + 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. Only the main scene should receive the main edit state. Requires tools compiled.