scala-native-gdextension
API
Generated with
scala-native-gdextension/gdext/gdext.classes/Object

Object

gdext.classes.Object
See theObject companion object
abstract class Object extends GodotScriptClass

Generated wrapper for Godot's Object.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AudioServer
class CameraServer
class ClassDB
class EditorPaths
class Engine
class Geometry2D
class Geometry3D
class IP
class Input
class InputMap
class JNISingleton
class JSONRPC
class MainLoop
class SceneTree
class Marshalls
class MovieWriter
class NativeMenu
class Node
class CanvasItem
class Control
class BaseButton
class Button
class CheckBox
class CheckButton
class MenuButton
class OptionButton
class LinkButton
class ColorRect
class Container
class BoxContainer
class ColorPicker
class GraphElement
class GraphFrame
class GraphNode
class EditorDock
class ScriptEditor
class TabContainer
class GraphEdit
class ItemList
class Label
class LineEdit
class MenuBar
class Panel
class Range
class ProgressBar
class ScrollBar
class HScrollBar
class VScrollBar
class Slider
class HSlider
class VSlider
class SpinBox
class Separator
class HSeparator
class VSeparator
class TabBar
class TextEdit
class CodeEdit
class TextureRect
class Tree
class Node2D
class Bone2D
class Camera2D
class CanvasGroup
class Area2D
class RigidBody2D
class StaticBody2D
class Joint2D
class PinJoint2D
class Light2D
class PointLight2D
class Line2D
class Marker2D
class Parallax2D
class Path2D
class PathFollow2D
class Polygon2D
class RayCast2D
class ShapeCast2D
class Skeleton2D
class Sprite2D
class TileMap
class TileMapLayer
class CanvasLayer
class EditorPlugin
class HTTPRequest
class MissingNode
class Node3D
class Camera3D
class XRCamera3D
class Area3D
class RigidBody3D
class StaticBody3D
class GridMap
class Joint3D
class HingeJoint3D
class PinJoint3D
class Marker3D
class OpenXRHand
class Path3D
class PathFollow3D
class RayCast3D
class ShapeCast3D
class Skeleton3D
class IKModifier3D
class ChainIK3D
class IterateIK3D
class CCDIK3D
class FABRIK3D
class JacobianIK3D
class SplineIK3D
class TwoBoneIK3D
class SkeletonIK3D
class SpringArm3D
class Decal
class FogVolume
class CSGShape3D
class CSGBox3D
class CSGMesh3D
class CSGPolygon3D
class CSGSphere3D
class CSGTorus3D
class Label3D
class SoftBody3D
class SpriteBase3D
class Sprite3D
class Light3D
class OmniLight3D
class SpotLight3D
class LightmapGI
class VoxelGI
class XRNode3D
class XRAnchor3D
class XROrigin3D
class Timer
class Viewport
class SubViewport
class Window
class AcceptDialog
class FileDialog
class Popup
class PopupMenu
class PopupPanel
class OS
class Performance
class RefCounted
class AESContext
class AStar2D
class AStar3D
class AStarGrid2D
class AudioSample
class CameraFeed
class ConfigFile
class Crypto
class DTLSServer
class DirAccess
class EditorScript
class Expression
class FileAccess
class HMACContext
class HTTPClient
class JavaClass
class JavaObject
class Lightmapper
class Logger
class MeshDataTool
class Mutex
class Node3DGizmo
class PCKPacker
class PacketPeer
class RDUniform
class RegEx
class RegExMatch
class Resource
class Animation
class AudioEffect
class AudioStream
class BitMap
class BoneMap
class ButtonGroup
class ColorPalette
class Compositor
class CryptoKey
class Curve
class Curve2D
class Curve3D
class Environment
class Font
class FontFile
class SystemFont
class GDExtension
class GLTFAccessor
class GLTFCamera
class GLTFDocument
class FBXDocument
class GLTFLight
class GLTFMesh
class GLTFNode
class GLTFSkeleton
class GLTFSkin
class GLTFState
class FBXState
class GLTFTexture
class Gradient
class Image
class ImporterMesh
class InputEvent
class JSON
class Material
class FogMaterial
class Mesh
class ArrayMesh
class BoxMesh
class CapsuleMesh
class CylinderMesh
class PlaneMesh
class QuadMesh
class PointMesh
class PrismMesh
class SphereMesh
class TextMesh
class TorusMesh
class MeshLibrary
class MultiMesh
class Noise
class Occluder3D
class OpenXRAction
class PackedScene
class RDShaderFile
class Script
class GDScript
class Shader
class VisualShader
class Shape2D
class Shape3D
class BoxShape3D
class Shortcut
class Skin
class Sky
class SpriteFrames
class StyleBox
class StyleBoxFlat
class StyleBoxLine
class Texture
class Texture2D
class AtlasTexture
class CurveTexture
class DPITexture
class ImageTexture
class MeshTexture
class Texture2DRD
class Texture3D
class Texture3DRD
class Cubemap
class CubemapArray
class Theme
class TileSet
class Translation
class VideoStream
class VoxelGIData
class World2D
class World3D
class SceneState
class Semaphore
class SocketServer
class TCPServer
class UDSServer
class StreamPeer
class SurfaceTool
class TLSOptions
class TextLine
class TextServer
class Thread
class TriangleMesh
class Tween
class Tweener
class UDPServer
class UPNP
class UPNPDevice
class WeakRef
class XMLParser
class XRInterface
class XRPose
class XRTracker
class ZIPPacker
class ZIPReader
class RenderData
class RenderDataRD
class ResourceUID
class ThemeDB
class TileData
class Time
class TreeItem
class UndoRedo
class XRServer
class XRVRS
Show all

Members list

Value members

Concrete methods

final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

def connect(signal: StringName, callable: Callable, flags: Long): Long
Extension method from gdext.classes

Object.connect(signal, callable, flags) — connect a built-in (or @signal) signal to a Callable (typically Callable(self, "method")). Returns the engine Error code as a Long. The generator skips it (Callable arg).

Object.connect(signal, callable, flags) — connect a built-in (or @signal) signal to a Callable (typically Callable(self, "method")). Returns the engine Error code as a Long. The generator skips it (Callable arg).

Attributes

def connect(signal: StringName, handler: () => Unit): Long
Extension method from gdext.classes

Connect signal on this object directly to a Scala closure — no registered @func method needed. The closure is held alive (via a custom gdext.internal.engine.CustomCallable) for as long as the connection exists, and dropped when Godot frees the Callable on disconnect.

Connect signal on this object directly to a Scala closure — no registered @func method needed. The closure is held alive (via a custom gdext.internal.engine.CustomCallable) for as long as the connection exists, and dropped when Godot frees the Callable on disconnect.

Attributes

def connect(signal: SignalName, handler: () => Unit): Long
Extension method from gdext.classes

Connect a named built-in SignalName directly to a Scala closure.

Connect a named built-in SignalName directly to a Scala closure.

Attributes

def connectMethod(signal: StringName, target: Object, method: StringName): Long
Extension method from gdext.classes

Connect signal on this object to target.method (a registered @func). Builds the Callable(target, method) and connects it.

Connect signal on this object to target.method (a registered @func). Builds the Callable(target, method) and connects it.

Attributes

def connectMethod(signal: SignalName, target: Object, method: StringName): Long
Extension method from gdext.classes

Connect a named built-in SignalName to target.method.

Connect a named built-in SignalName to target.method.

Attributes

def get(property: StringName): Variant
Extension method from gdext.classes

Object.get(property) — generic property read (returns a Variant the caller must destroy() when done).

Object.get(property) — generic property read (returns a Variant the caller must destroy() when done).

Attributes

def getAs[A](property: StringName)(using FromVariant[A]): A
Extension method from gdext.classes

get decoded straight to A; the intermediate Variant is destroyed here, so no manual get -> to -> destroy dance at the call site.

get decoded straight to A; the intermediate Variant is destroyed here, so no manual get -> to -> destroy dance at the call site.

Attributes

final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

final def getTranslationDomain(): StringName

Object.get_translation_domain

Object.get_translation_domain

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

def set(property: StringName, value: Variant): Unit
Extension method from gdext.classes

Object.set(property, value) — generic property write (Variant-typed).

Object.set(property, value) — generic property write (Variant-typed).

Attributes

def set[A](property: StringName, value: A)(using ToVariant[A]): Unit
Extension method from gdext.classes

set from a plain Scala value; the Variant round-trip (build, write, destroy) is handled here.

set from a plain Scala value; the Variant round-trip (build, write, destroy) is handled here.

Attributes

final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass
Generated with