InstancePlaceholder

Documentation

Overview

Package InstancePlaceholder provides methods for working with InstancePlaceholder object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsInstancePlaceholder() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) CreateInstance() [1]gdclass.Node
  • func (self Instance) GetInstancePath() string
  • func (self Instance) GetStoredValues() map[string]interface{}
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsInstancePlaceholder() Instance
}

type Instance

type Instance [1]gdclass.InstancePlaceholder

Turning on the option [b]Load As Placeholder[/b] for an instantiated scene in the editor causes it to be replaced by an [InstancePlaceholder] when running the game, this will not replace the node in the editor. This makes it possible to delay actually loading the scene until calling [method create_instance]. This is useful to avoid loading large scenes all at once by loading parts of it selectively. The [InstancePlaceholder] does not have a transform. This causes any child nodes to be positioned relatively to the [Viewport] from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsInstancePlaceholder

func (self Instance) AsInstancePlaceholder() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) CreateInstance

func (self Instance) CreateInstance() [1]gdclass.Node

Call this method to actually load in the node. The created node will be placed as a sibling [i]above[/i] the [InstancePlaceholder] in the scene tree. The [Node]'s reference is also returned for convenience. [b]Note:[/b] [method create_instance] is not thread-safe. Use [method Object.call_deferred] if calling from a thread.

func (Instance) GetInstancePath

func (self Instance) GetInstancePath() string

Gets the path to the [PackedScene] resource file that is loaded by default when calling [method create_instance]. Not thread-safe. Use [method Object.call_deferred] if calling from a thread.

func (Instance) GetStoredValues

func (self Instance) GetStoredValues() map[string]interface{}

Returns the list of properties that will be applied to the node when [method create_instance] is called. If [param with_order] is [code]true[/code], a key named [code].order[/code] (note the leading period) is added to the dictionary. This [code].order[/code] key is an [Array] of [String] property names specifying the order in which properties will be applied (with index 0 being the first).

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value