Inheritance #

PackedScene #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

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.

Can be used to save a node to a file. When saving, the node as well as all the nodes it owns get saved (see Node.owner property).

Note: The node doesn't need to own itself.

Example: Load a saved scene:

GDScript

# Use load() instead of preload() if the path isn't known at compile-time.
var scene = preload("res://scene.tscn").instantiate()
# Add the node as a child of the node the script is attached to.
add_child(scene)

C#

// C# has no preload, so you have to always use ResourceLoader.Load().
var scene = ResourceLoader.Load("res://scene.tscn").Instantiate();
// Add the node as a child of the node the script is attached to.
AddChild(scene);

Example: Save a node with different owners. The following example creates 3 objects: Node2D (node), RigidBody2D (body) and CollisionObject2D (collision). collision is a child of body which is a child of node. Only body is owned by node and pack will therefore only save those two nodes, but not collision.

GDScript

# Create the objects.
var node = Node2D.new()
var body = RigidBody2D.new()
var collision = CollisionShape2D.new()

# Create the object hierarchy.
body.add_child(collision)
node.add_child(body)

# Change owner of `body`, but not of `collision`.
body.owner = node
var scene = PackedScene.new()

# Only `node` and `body` are now packed.
var result = scene.pack(node)
if result == OK:
    var error = ResourceSaver.save(scene, "res://path/name.tscn")  # Or "user://..."
    if error != OK:
        push_error("An error occurred while saving the scene to disk.")

C#

// Create the objects.
var node = new Node2D();
var body = new RigidBody2D();
var collision = new CollisionShape2D();

// Create the object hierarchy.
body.AddChild(collision);
node.AddChild(body);

// Change owner of `body`, but not of `collision`.
body.Owner = node;
var scene = new PackedScene();

// Only `node` and `body` are now packed.
Error result = scene.Pack(node);
if (result == Error.Ok)
{
    Error error = ResourceSaver.Save(scene, "res://path/name.tscn"); // Or "user://..."
    if (error != Error.Ok)
    {
        GD.PushError("An error occurred while saving the scene to disk.");
    }
}

Members #

Methods #

Annotations #

Constants #

const GEN_EDIT_STATE_DISABLED = 0 enum GenEditState#

If passed to instantiate, blocks edits to the scene state.

const GEN_EDIT_STATE_INSTANCE = 1 enum GenEditState#

If passed to instantiate, provides local scene resources to the local scene.

Note: Only available in editor builds.

const GEN_EDIT_STATE_MAIN = 2 enum GenEditState#

If passed to instantiate, provides local scene resources to the local scene. Only the main scene should receive the main edit state.

Note: Only available in editor builds.

const GEN_EDIT_STATE_MAIN_INHERITED = 3 enum GenEditState#

It's similar to GEN_EDIT_STATE_MAIN, but for the case where the scene is being instantiated to be the base of another one.

Note: Only available in editor builds.

Constructors #

Enums #

GenEditState#

Operators #

Signals #

Theme Items #

Tutorials #