Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Object

Inherited By: ARVRServer, AudioServer, CameraServer, ClassDB, EditorFileSystemDirectory, EditorNavigationMeshGenerator, EditorSelection, EditorVCSInterface, Engine, Geometry, GodotSharp, IP, Input, InputMap, JNISingleton, JSON, JSONRPC, JavaClassWrapper, JavaScript, MainLoop, Marshalls, Node, OS, Performance, Physics2DDirectBodyState, Physics2DDirectSpaceState, Physics2DServer, PhysicsDirectBodyState, PhysicsDirectSpaceState, PhysicsServer, ProjectSettings, Reference, ResourceLoader, ResourceSaver, Time, TranslationServer, TreeItem, UndoRedo, VisualScriptEditor, VisualServer

Base class for all non-built-in types.

Descripción

Every class which is not a built-in type inherits from this class.

You can construct Objects from scripting languages, using Object.new() in GDScript, new Object in C#, or the "Construct Object" node in VisualScript.

Objects do not manage memory. If a class inherits from Object, you will have to delete instances of it manually. To do so, call the free method from your script or delete the instance from C++.

Some classes that extend Object add memory management. This is the case of Reference, which counts references and deletes itself automatically when no longer referenced. Node, another fundamental type, deletes all its children when freed from memory.

Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in _get_property_list and handled in _get and _set. However, scripting languages and C++ have simpler means to export them.

Property membership can be tested directly in GDScript using in:

var n = Node2D.new()
print("position" in n) # Prints "True".
print("other_property" in n) # Prints "False".

The in operator will evaluate to true as long as the key exists, even if the value is null.

Objects also receive notifications. Notifications are a simple way to notify the object about different events, so they can all be handled together. See _notification.

Note: Unlike references to a Reference, references to an Object stored in a variable can become invalid without warning. Therefore, it's recommended to use Reference for data classes instead of Object.

Note: Due to a bug, you can't create a "plain" Object using Object.new(). Instead, use ClassDB.instance("Object"). This bug only applies to Object itself, not any of its descendents like Reference.

Tutoriales

Métodos

Variant

_get ( String property ) virtual

Array

_get_property_list ( ) virtual

void

_init ( ) virtual

void

_notification ( int what ) virtual

bool

_set ( String property, Variant value ) virtual

String

_to_string ( ) virtual

void

add_user_signal ( String signal, Array arguments=[ ] )

Variant

call ( String method, ... ) vararg

void

call_deferred ( String method, ... ) vararg

Variant

callv ( String method, Array arg_array )

bool

can_translate_messages ( ) const

Error

connect ( String signal, Object target, String method, Array binds=[ ], int flags=0 )

void

disconnect ( String signal, Object target, String method )

void

emit_signal ( String signal, ... ) vararg

void

free ( )

Variant

get ( String property ) const

String

get_class ( ) const

Array

get_incoming_connections ( ) const

Variant

get_indexed ( NodePath property ) const

int

get_instance_id ( ) const

Variant

get_meta ( String name ) const

PoolStringArray

get_meta_list ( ) const

Array

get_method_list ( ) const

Array

get_property_list ( ) const

Reference

get_script ( ) const

Array

get_signal_connection_list ( String signal ) const

Array

get_signal_list ( ) const

bool

has_meta ( String name ) const

bool

has_method ( String method ) const

bool

has_signal ( String signal ) const

bool

has_user_signal ( String signal ) const

bool

is_blocking_signals ( ) const

bool

is_class ( String class ) const

bool

is_connected ( String signal, Object target, String method ) const

bool

is_queued_for_deletion ( ) const

void

notification ( int what, bool reversed=false )

void

property_list_changed_notify ( )

void

remove_meta ( String name )

void

set ( String property, Variant value )

void

set_block_signals ( bool enable )

void

set_deferred ( String property, Variant value )

void

set_indexed ( NodePath property, Variant value )

void

set_message_translation ( bool enable )

void

set_meta ( String name, Variant value )

void

set_script ( Reference script )

String

to_string ( )

String

tr ( String message ) const

Señales

  • script_changed ( )

Emitido cada vez que se cambia el script del objeto.

Enumeraciones

enum ConnectFlags:

  • CONNECT_DEFERRED = 1 --- Conecta una señal en modo diferido. De esta manera, las emisiones de la señal se almacenan en una cola, y luego se ajustan al tiempo de inactividad.

  • CONNECT_PERSIST = 2 --- Las conexiones persistentes se guardan cuando el objeto se serializa en un archivo.

  • CONNECT_ONESHOT = 4 --- Las conexiones de one-shot se desconectan después de la emisión.

  • CONNECT_REFERENCE_COUNTED = 8 --- Conecta una señal como contador de referencias. Esto significa que una señal dada puede conectarse varias veces al mismo objetivo, y sólo se desconectará completamente cuando no queden referencias en el contador.

Constantes

  • NOTIFICATION_POSTINITIALIZE = 0 --- Se llama así cuando el objeto se inicializa. No está disponible en el script.

  • NOTIFICATION_PREDELETE = 1 --- Llamado antes de que el objeto esté a punto de ser eliminado.

Descripciones de Métodos

Método virtual que puede ser anulado para personalizar el valor de retorno de get.

Devuelve la propiedad dada. Devuelve null si la property no existe.

  • Array _get_property_list ( ) virtual

Método virtual que puede ser anulado para personalizar el valor de retorno de get_property_list.

Devuelve la lista de propiedades del objeto como un Array de diccionarios.

El Dictionary de cada propiedad debe contener al menos entradas de name: String y type: int (ver Variant.Type). Opcionalmente, también puede incluir hint: int (ver PropertyHint), hint_string: String, y usage: int (ver PropertyUsageFlags).

  • void _init ( ) virtual

Se llama cuando el objeto se inicializa.

  • void _notification ( int what ) virtual

Llamado cada vez que el objeto recibe una notificación, que se identifica en what por una constante. La base Object tiene dos constantes NOTIFICATION_POSTINITIALIZE y NOTIFICATION_PREDELETE, pero subclases como Node definen muchas más notificaciones que también se reciben por este método.

Método virtual que puede ser anulado para personalizar el valor de retorno de set.

Establece una propiedad. Devuelve true si existe la property.

  • String _to_string ( ) virtual

Método virtual que puede ser anulado para personalizar el valor de retorno de to_string, y por lo tanto la representación del objeto donde se convierte en una cadena, por ejemplo con print(obj).

Devuelve una String que representa el objeto. Si no se anula, por defecto es "[ClassName:RID]".

  • void add_user_signal ( String signal, Array arguments=[ ] )

Añade una signal definida por el usuario. Los argumentos son opcionales, pero pueden añadirse como una Array de diccionarios, cada uno de los cuales contiene entradas de name: String y type: int (véase Variant.Type).

Llama al method en el objeto y devuelve el resultado. Este método soporta un número variable de argumentos, por lo que los parámetros se pasan como una lista separada por comas. Ejemplo:

call("set", "position", Vector2(42.0, 0.0))

Nota: En C#, el nombre del método debe especificarse como snake_case si está definido por un nodo Godot incorporado. Esto no se aplica a los métodos definidos por el usuario, en los que se debe utilizar la misma convención que en el código fuente de C# (típicamente PascalCase).

  • void call_deferred ( String method, ... ) vararg

Llama al method en el objeto durante el tiempo de inactividad. Este método soporta un número variable de argumentos, por lo que los parámetros se pasan como una lista separada por comas. Ejemplo:

call_deferred("set", "position", Vector2(42.0, 0.0))

Nota: En C#, el nombre del método debe especificarse como snake_case si está definido por un nodo Godot incorporado. Esto no se aplica a los métodos definidos por el usuario, en los que se debe utilizar la misma convención que en el código fuente de C# (típicamente PascalCase).

Llama al method en el objeto y devuelve el resultado. A diferencia de call, este método no soporta un número variable de argumentos, sino que espera que todos los parámetros sean a través de un único Array.

callv("set", [ "position", Vector2(42.0, 0.0) ])

  • bool can_translate_messages ( ) const

Devuelve true si el objeto puede traducir cadenas. Ver set_message_translation y tr.

Connects a signal to a method on a target object. Pass optional binds to the call as an Array of parameters. These parameters will be passed to the method after any parameter used in the call to emit_signal. Use flags to set deferred or one-shot connections. See ConnectFlags constants.

A signal can only be connected once to a method. It will throw an error if already connected, unless the signal was connected with CONNECT_REFERENCE_COUNTED. To avoid this, first, use is_connected to check for existing connections.

If the target is destroyed in the game's lifecycle, the connection will be lost.

Examples:

connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal

An example of the relationship between binds passed to connect and parameters used when calling emit_signal:

connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
    print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])

Disconnects a signal from a method on the given target.

If you try to disconnect a connection that does not exist, the method will throw an error. Use is_connected to ensure that the connection exists.

  • void emit_signal ( String signal, ... ) vararg

Emite la signal. La señal debe existir, por lo que debe ser una señal incorporada de esta clase o de una de sus clases superiores, o una señal definida por el usuario. Este método admite un número variable de argumentos, por lo que los parámetros se pasan como una lista separada por comas. Ejemplo:

emit_signal("golpe", tipo_arma, daño)
emit_signal("Juego_Terminado")

  • void free ( )

Deletes the object from memory immediately. For Nodes, you may want to use Node.queue_free to queue the node for safe deletion at the end of the current frame.

Important: If you have a variable pointing to an object, it will not be assigned to null once the object is freed. Instead, it will point to a previously freed instance and you should validate it with @GDScript.is_instance_valid before attempting to call its methods or access its properties.

Devuelve el valor de la Variant de la property. Si la property no existe, esto devolverá null.

Nota: En C#, el nombre de la propiedad debe especificarse como snake_case si está definida por un nodo Godot incorporado. Esto no se aplica a las propiedades definidas por el usuario, en las que se debe utilizar la misma convención que en el código fuente de C# (típicamente PascalCase).

Returns the object's class as a String. See also is_class.

Note: get_class does not take class_name declarations into account. If the object has a class_name defined, the base class name will be returned instead.

  • Array get_incoming_connections ( ) const

Devuelve un Array de diccionarios con información sobre las señales que están conectadas al objeto.

Cada Dictionary contiene tres entradas String:

  • source es una referencia al emisor de la señal.

  • signal_name es el nombre de la señal conectada.

  • method_name es el nombre del método al que está conectada la señal.

Gets the object's property indexed by the given NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Examples: "position:x" or "material:next_pass:blend_mode".

Note: Even though the method takes NodePath argument, it doesn't support actual paths to Nodes in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use Node.get_node_and_resource instead.

  • int get_instance_id ( ) const

Devuelve la identificación de instancia única del objeto.

Este ID puede guardarse en EncodedObjectAsID, y puede utilizarse para recuperar la instancia del objeto con @GDScript.instance_from_id.

Devuelve la entrada de metadatos del objeto para el name dado.

Returns the object's metadata as a PoolStringArray.

  • Array get_method_list ( ) const

Devuelve los métodos del objeto y sus firmas como un Array.

  • Array get_property_list ( ) const

Devuelve la lista de propiedades del objeto como una Array de diccionarios.

El Dictionary de cada propiedad contiene al menos entradas de name: String y type: int (véase Variant.Type). Opcionalmente, también puede incluir hint: int (ver PropertyHint), hint_string: String, y usage: int (ver PropertyUsageFlags).

Devuelve la instancia de Script del objeto, o null si no hay ninguna asignada.

  • Array get_signal_connection_list ( String signal ) const

Devuelve un Array de conexiones para la signal dada.

  • Array get_signal_list ( ) const

Devuelve la lista de señales como un Array de diccionarios.

Devuelve true si se encuentra una entrada de metadatos con el name dado.

Devuelve true si el objeto contiene el method dado.

Devuelve true si existe la signal dada.

Devuelve true si existe la signal definida por el usuario. Sólo se tienen en cuenta las señales añadidas mediante add_user_signal.

  • bool is_blocking_signals ( ) const

Devuelve true si el bloqueo de la emisión de la señal está activado.

Returns true if the object inherits from the given class. See also get_class.

Note: is_class does not take class_name declarations into account. If the object has a class_name defined, is_class will return false for that name.

Returns true if a connection exists for a given signal, target, and method.

  • bool is_queued_for_deletion ( ) const

Devuelve true si el método Node.queue_free fue llamado para el objeto.

  • void notification ( int what, bool reversed=false )

Envíe una notificación determinada al objeto, que también activará una llamada al método _notification de todas las clases de las que hereda el objeto.

Si reversed es true, _notification es llamado primero a la clase propia del objeto, y luego hasta sus sucesivas clases parentales. Si reversed es false, _notification es llamado primero en el ancestro más alto (Object itself), y luego hasta sus sucesivas clases hereditarias.

  • void property_list_changed_notify ( )

Notifica al editor que la lista de propiedades ha cambiado, para que los plugins del editor puedan tener en cuenta los nuevos valores. No hace nada en las construcciones de exportación.

  • void remove_meta ( String name )

Removes a given entry from the object's metadata. See also set_meta.

Asigna un nuevo valor a la propiedad dada. Si la property no existe, no pasará nada.

Nota: En C#, el nombre de la propiedad debe especificarse como snake_case si está definida por un nodo Godot incorporado. Esto no se aplica a las propiedades definidas por el usuario, donde se debe usar la misma convención que en el código fuente de C# (típicamente PascalCase).

  • void set_block_signals ( bool enable )

Si se ajusta a true, la emisión de la señal se bloquea.

Asigna un nuevo valor a la propiedad dada, después del paso de la física del marco actual. Esto equivale a llamar a set mediante call_deferred, es decir, call_deferred("set", property, value).

Nota: En C#, el nombre de la propiedad debe especificarse como snake_case si está definido por un nodo Godot incorporado. Esto no se aplica a las propiedades definidas por el usuario, en las que se debe utilizar la misma convención que en el código fuente de C# (típicamente PascalCase).

Asigna un nuevo valor a la propiedad identificada por el NodePath. La ruta del nodo debe ser relativa al objeto actual y puede utilizar el carácter de dos puntos (:) para acceder a las propiedades anidadas.

set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)

  • void set_message_translation ( bool enable )

Define si el objeto puede traducir strings (con llamadas a tr). Habilitado por defecto.

Adds, changes or removes a given entry in the object's metadata. Metadata are serialized and can take any Variant value.

To remove a given entry from the object's metadata, use remove_meta. Metadata is also removed if its value is set to null. This means you can also use set_meta("name", null) to remove metadata for "name".

Asigna un script al objeto. Cada objeto puede tener asignado un único script, que se utiliza para ampliar su funcionalidad.

Si el objeto ya tenía un script, la instancia anterior del script se liberará y sus variables y estado se perderán. Se llamará al método _init del nuevo script.

Devuelve una String que representa el objeto. Si no está anulado, por defecto es "[ClassName:RID]".

Anula el método _to_string para personalizar la representación de String.

Traduce un mensaje usando los catálogos de traducción configurados en la Configuración del proyecto.

Sólo funciona si la traducción del mensaje está activada (lo cual esta por defecto), de lo contrario devuelve el message sin cambios. Ver set_message_translation.