godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DOCS] PackedScene member/method/class descs.

Browse Source
This commit is contained in:
Will Nations 2017-12-03 22:34:28 -06:00
parent 9b9fcb1977
commit 9f341971c9
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/classes/PackedScene.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="PackedScene" inherits="Resource" category="Core" version="3.0-beta"> <class name="PackedScene" inherits="Resource" category="Core" version="3.0-beta">
<brief_description> <brief_description>
An abstraction of a serialized scene.
</brief_description> </brief_description>
<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 TODO: explain ownership, and that node does not need to own itself
</description> </description>
<tutorials> <tutorials>
@ -14,12 +16,14 @@
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Returns [code]true[/code] if the scene file has nodes.
</description> </description>
</method> </method>
<method name="get_state"> <method name="get_state">
<return type="SceneState"> <return type="SceneState">
</return> </return>
<description> <description>
Returns the [code]SceneState[/code] representing the scene file contents.
</description> </description>
</method> </method>
<method name="instance" qualifiers="const"> <method name="instance" qualifiers="const">
@ -28,6 +32,7 @@
<argument index="0" name="edit_state" type="int" enum="PackedScene.GenEditState" default="0"> <argument index="0" name="edit_state" type="int" enum="PackedScene.GenEditState" default="0">
</argument> </argument>
<description> <description>
Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers the [enum Object.NOTIFICATION_INSTANCED] notification on the root node.
</description> </description>
</method> </method>
<method name="pack"> <method name="pack">
@ -42,14 +47,19 @@
</methods> </methods>
<members> <members>
<member name="_bundled" type="Dictionary" setter="_set_bundled_scene" getter="_get_bundled_scene"> <member name="_bundled" type="Dictionary" setter="_set_bundled_scene" getter="_get_bundled_scene">
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.
</member> </member>
</members> </members>
<constants> <constants>
<constant name="GEN_EDIT_STATE_DISABLED" value="0" enum="GenEditState"> <constant name="GEN_EDIT_STATE_DISABLED" value="0" enum="GenEditState">
If passed to [method instance], blocks edits to the scene state.
</constant> </constant>
<constant name="GEN_EDIT_STATE_INSTANCE" value="1" enum="GenEditState"> <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.
</constant> </constant>
<constant name="GEN_EDIT_STATE_MAIN" value="2" enum="GenEditState"> <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.
</constant> </constant>
</constants> </constants>
</class> </class>