Base class for all non built-in types.
Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class.
Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [method free] function from the script or delete from C++).
Some derivates add memory management, such as [Reference] (which keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted.
Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [method _set]. However, scripting languages and C++ have simpler means to export them.
Objects also receive notifications ([method _notification]). Notifications are a simple way to notify the object about simple events, so they can all be handled together.
Return a property, return null if the property does not exist.
Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]).
Notification request, the notification id is received.
Set a property. Return true if the property was found.
Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*).
Return true if this object can translate strings.
Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT_*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use [method is_connected] to check.
Disconnect a signal from a method.
Get a property from the object.
Return the class of the object as a string.
Returns an [Array] of dictionaries with informations about signals that are connected to this object.
Inside each [Dictionary] there are 3 fields:
- "source" is a reference to signal emitter.
- "signal_name" is name of connected signal.
- "method_name" is a name of method to which signal is connected.
Return the instance ID. All objects have a unique instance ID.
Return a metadata from the object.
Return the list of metadata in the object.
Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]).
Return the object script (or null if it doesn't have one).
Return the list of signals as an array of dictionaries.
Return true if a metadata is found with the requested name.
Return true if signal emission blocking is enabled.
Check the class of the object against a string (including inheritance).
Return true if a connection exists for a given signal and target/method.
Notify the object of something.
Set property into the object.
If set to true, signal emission is blocked.
Define whether this object can translate strings (with calls to [method tr]). Default is true.
Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i].
Set a script into the object, scripts extend the object functionality.
Translate a message. Only works if message translation is enabled (which it is by default). See [method set_message_translation].
Called right when the object is initialized. Not available in script.
Called before the object is about to be deleted.
Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time.
Persisting connections are saved when the object is serialized to file.
One shot connections disconnect themselves after emission.