PackedScene

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.PackedScene
Namespace	Electron2D
Kind	class
Category	Scene Tree

Overview

Represents the packed scene type.

Syntax

public class Electron2D.PackedScene : Electron2D.Resource

Remarks

This type is part of the Electron2D 0.1.0 Preview public API.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
Electron2D.PackedScene()	Constructor	Initializes a new instance of the PackedScene type.
CanInstantiate()	Method	Checks whether instantiate can be performed.
Instantiate()	Method	Executes the instantiate operation.
Pack(Electron2D.Node)	Method	Executes the pack operation.

Member Details

Electron2D.PackedScene()

Kind: Constructor

public Electron2D.PackedScene()

Summary

Initializes a new instance of the PackedScene type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PackedScene

CanInstantiate()

Kind: Method

public System.Boolean CanInstantiate()()

Summary

Checks whether instantiate can be performed.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

true when the condition is met; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PackedScene

Instantiate()

Kind: Method

public Electron2D.Node Instantiate()()

Summary

Executes the instantiate operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PackedScene

Pack(Electron2D.Node)

Kind: Method

public Electron2D.Error Pack(Electron2D.Node)(Electron2D.Node path)

Summary

Executes the pack operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• path: The path value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PackedScene