Script

Documentation

Overview

A class stored as a resource. A script extends the functionality of all objects that instantiate it.

This is the base class for all scripts and should not be used directly. Trying to create a new script with this class will result in an error.

The new method of a script subclass creates a new instance. Object.SetScript extends an existing object, if that object's class matches one of the script's base classes.

Index

• type Advanced
• type Any
• type Expanded
• type Extension
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
  • func (self *Extension[T]) AsResource() Resource.Instance
  • func (self *Extension[T]) AsScript() Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func Get(obj Object.Any) (Instance, bool)
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) AsScript() Instance
  • func (self Instance) CanInstantiate() bool
  • func (self Instance) GetBaseScript() Instance
  • func (self Instance) GetGlobalName() string
  • func (self Instance) GetInstanceBaseType() string
  • func (self Instance) GetPropertyDefaultValue(property string) any
  • func (self Instance) GetRpcConfig() any
  • func (self Instance) GetScriptConstantMap() map[string]interface{}
  • func (self Instance) GetScriptMethodList() []Object.PropertyInfo
  • func (self Instance) GetScriptPropertyList() []Object.PropertyInfo
  • func (self Instance) GetScriptSignalList() []SignalInfo
  • func (self Instance) HasScriptSignal(signal_name string) bool
  • func (self Instance) HasSourceCode() bool
  • func (self Instance) ID() ID
  • func (self Instance) InstanceHas(base_object Object.Instance) bool
  • func (self Instance) IsAbstract() bool
  • func (self Instance) IsTool() bool
  • func (self Instance) MoreArgs() MoreArgs
  • func (self Instance) Reload() error
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetSourceCode(value string)
  • func (self Instance) SourceCode() string
  • func (self Instance) Virtual(name string) reflect.Value
• type MoreArgs
  • func (self MoreArgs) Reload(keep_state bool) error
• type SignalInfo

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
	AsScript() Instance
}

type Expanded

type Expanded = MoreArgs

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

func (*Extension[T]) AsScript

func (self *Extension[T]) AsScript() Instance

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.Script

Instance of the class with convieniently typed arguments and results.

var Nil Instance

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

func Get

func Get(obj Object.Any) (Instance, bool)

Get returns the object's Script instance, or false if no script is attached.

func New

func New() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AsScript

func (self Instance) AsScript() Instance

func (Instance) CanInstantiate

func (self Instance) CanInstantiate() bool

Returns true if the script can be instantiated.

func (Instance) GetBaseScript

func (self Instance) GetBaseScript() Instance

Returns the script directly inherited by this script.

func (Instance) GetGlobalName

func (self Instance) GetGlobalName() string

Returns the class name associated with the script, if there is one. Returns an empty string otherwise.

To give the script a global name, you can use the class_name keyword in GDScript and the [GlobalClass] attribute in C#.

package main

func (Instance) GetInstanceBaseType

func (self Instance) GetInstanceBaseType() string

Returns the script's base type.

func (Instance) GetPropertyDefaultValue

func (self Instance) GetPropertyDefaultValue(property string) any

Returns the default value of the specified property.

func (Instance) GetRpcConfig

func (self Instance) GetRpcConfig() any

Returns a data structure mapping method names to their RPC configuration defined by this script.

func (Instance) GetScriptConstantMap

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

Returns a dictionary containing constant names and their values.

func (Instance) GetScriptMethodList

func (self Instance) GetScriptMethodList() []Object.PropertyInfo

Returns the list of methods in this Script.

Note: The dictionaries returned by this method are formatted identically to those returned by Object.GetMethodList.

func (Instance) GetScriptPropertyList

func (self Instance) GetScriptPropertyList() []Object.PropertyInfo

Returns the list of properties in this Script.

Note: The dictionaries returned by this method are formatted identically to those returned by Object.GetPropertyList.

func (Instance) GetScriptSignalList

func (self Instance) GetScriptSignalList() []SignalInfo

Returns the list of user signals defined in this Script.

Note: The dictionaries returned by this method are formatted identically to those returned by Object.GetSignalList.

func (Instance) HasScriptSignal

func (self Instance) HasScriptSignal(signal_name string) bool

Returns true if the script, or a base class, defines a signal with the given name.

func (Instance) HasSourceCode

func (self Instance) HasSourceCode() bool

Returns true if the script contains non-empty source code.

Note: If a script does not have source code, this does not mean that it is invalid or unusable. For example, a GDScript that was exported with binary tokenization has no source code, but still behaves as expected and could be instantiated. This can be checked with CanInstantiate.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) InstanceHas

func (self Instance) InstanceHas(base_object Object.Instance) bool

Returns true if 'base_object' is an instance of this script.

func (Instance) IsAbstract

func (self Instance) IsAbstract() bool

Returns true if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated.

func (Instance) IsTool

func (self Instance) IsTool() bool

Returns true if the script is a tool script. A tool script can run in the editor.

func (Instance) MoreArgs

func (self Instance) MoreArgs() MoreArgs

MoreArgs enables certain functions to be called with additional 'optional' arguments.

func (Instance) Reload

func (self Instance) Reload() error

Reloads the script's class implementation. Returns an error code.

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetSourceCode

func (self Instance) SetSourceCode(value string)

SetSourceCode sets the property returned by [GetSourceCode].

func (Instance) SourceCode

func (self Instance) SourceCode() string

The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.

func (Instance) Virtual

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

type MoreArgs

type MoreArgs [1]gdclass.Script

MoreArgs is a container for Instance functions with additional 'optional' arguments.

func (MoreArgs) Reload

func (self MoreArgs) Reload(keep_state bool) error

Reloads the script's class implementation. Returns an error code.

type SignalInfo

type SignalInfo struct {
	Name        string                `gd:"name"`
	Flags       int                   `gd:"flags"`
	ID          int                   `gd:"id"`
	DefaultArgs []interface{}         `gd:"default_args"`
	Args        []Object.PropertyInfo `gd:"args"`
}