Struct gdnative_bindings::PhysicsServer

source · [−]
pub struct PhysicsServer { /* private fields */ }
Expand description

core singleton class PhysicsServer inherits Object (manually managed).

This class has related types in the physics_server module.

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Class hierarchy

PhysicsServer inherits methods from:

Safety

All types in the Godot API have interior mutability in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Ownership in these types tracks whether ownership is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

Constants

source

pub const AREA_BODY_ADDED: i64 = 0i64

source

pub const AREA_BODY_REMOVED: i64 = 1i64

source

pub const SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION: i64 = 2i64

source

pub const SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD: i64 = 3i64

source

pub const SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD: i64 = 4i64

source

pub const SPACE_PARAM_BODY_TIME_TO_SLEEP: i64 = 5i64

source

pub const SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO: i64 = 6i64

Returns a reference to the singleton instance.

Safety

This singleton server is only safe to access from outside the main thread if thread-safe operations are enabled in the project settings. See the official thread-safety guidelines for more information.

Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.

Default Arguments
  • transform - Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )
  • disabled - false
Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Assigns the area to a descendant of Object, so it can exist in the node tree.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Creates an Area.

Gets the instance ID of the object the area is assigned to.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns an area parameter value. A list of available parameters is on the AreaParameter constants.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the RID of the nth shape of an area.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the number of shapes assigned to an area.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the transform matrix of a shape within an area.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the space assigned to the area.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the space override mode for the area.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the transform matrix for an area.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

If true, area collides with rays.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Removes a shape from an area. It does not delete the shape, so it can be reassigned later.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Assigns the area to one or many physics layers.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets which physics layers the area will monitor.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area. 2: RID of the object that entered/exited the area. 3: Instance ID of the object that entered/exited the area. 4: The shape index of the object that entered/exited the area. 5: The shape index of the area where the object entered/exited.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the value for an area parameter. A list of available parameters is on the AreaParameter constants.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets object pickable with rays.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Substitutes a given area shape by another. The old shape is selected by its index, the new one by its RID.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the transform matrix for an area shape.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Assigns a space to the area.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the space override mode for the area. The modes are described in the AreaSpaceOverrideMode constants.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the transform matrix for an area.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Adds a body to the list of bodies exempt from collisions.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.

Default Arguments
  • transform - Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )
  • disabled - false
Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gives the body a push at a position in the direction of the impulse.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gives the body a push to rotate it.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Assigns the area to a descendant of Object, so it can exist in the node tree.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Removes all shapes from a body.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Creates a physics body. The first parameter can be any value from BodyMode constants, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.

Default Arguments
  • mode - 2
  • init_sleeping - false

Returns the physics layer or layers a body belongs to.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the physics layer or layers a body can collide with.
Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the PhysicsDirectBodyState of the body.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the maximum contacts that can be reported. See body_set_max_contacts_reported.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the body mode.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets the instance ID of the object the area is assigned to.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the value of a body parameter. A list of available parameters is on the BodyParameter constants.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the RID of the nth shape of a body.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the number of shapes assigned to a body.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the transform matrix of a body shape.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the RID of the space assigned to a body.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns a body state.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

If true, the continuous collision detection mode is enabled.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns whether a body uses a callback function to calculate its own physics (see body_set_force_integration_callback).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

If true, the body can be detected by rays.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Removes a body from the list of bodies exempt from collisions. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Removes a shape from a body. The shape is not deleted, so it can be reused afterwards.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the physics layer or layers a body belongs to.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the physics layer or layers a body can collide with.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

If true, the continuous collision detection mode is enabled. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the function used to calculate physics for an object, if that object allows it (see body_set_omit_force_integration).

Default Arguments
  • userdata - null
Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the body mode, from one of the BodyMode constants.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets whether a body uses a callback function to calculate its own physics (see body_set_force_integration_callback).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets a body parameter. A list of available parameters is on the BodyParameter constants.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the body pickable with rays if enabled is set.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Substitutes a given body shape by another. The old shape is selected by its index, the new one by its RID.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the transform matrix for a body shape.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Assigns a space to the body (see space_create).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets a body state (see BodyState constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns true if a collision would result from moving in the given direction from a given point in space. PhysicsTestMotionResult can be passed to return additional information in.

Default Arguments
  • result - null
  • exclude_raycast_shapes - true
  • exclude - [ ]
Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets a cone_twist_joint parameter (see ConeTwistJointParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets a cone_twist_joint parameter (see ConeTwistJointParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Destroys any of the objects created by PhysicsServer. If the RID passed is not one of the objects that can be created by PhysicsServer, an error will be sent to the console.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets a generic_6_DOF_joint flag (see G6DOFJointAxisFlag constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets a generic_6_DOF_joint parameter (see G6DOFJointAxisParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets a generic_6_DOF_joint flag (see G6DOFJointAxisFlag constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets a generic_6_DOF_joint parameter (see G6DOFJointAxisParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns an Info defined by the ProcessInfo input given.

Gets a hinge_joint flag (see HingeJointFlag constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets a hinge_joint parameter (see HingeJointParam).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets a hinge_joint flag (see HingeJointFlag constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets a hinge_joint parameter (see HingeJointParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Creates a ConeTwistJoint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Creates a Generic6DOFJoint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Creates a HingeJoint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Creates a PinJoint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Creates a SliderJoint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets the priority value of the Joint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the type of the Joint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the priority value of the Joint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns position of the joint in the local space of body a of the joint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns position of the joint in the local space of body b of the joint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets a pin_joint parameter (see PinJointParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets position of the joint in the local space of body a of the joint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets position of the joint in the local space of body b of the joint.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets a pin_joint parameter (see PinJointParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Activates or deactivates the 3D physics engine.

Sets the amount of iterations for calculating velocities of colliding bodies. The greater the amount of iterations, the more accurate the collisions will be. However, a greater amount of iterations requires more CPU power, which can decrease performance. The default value is 8. Note: Only has an effect when using the GodotPhysics engine, not the default Bullet physics engine.

Creates a shape of a type from ShapeType. Does not assign it to a body or an area. To do so, you must use area_set_shape or body_set_shape.

Returns the shape data.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the type of shape (see ShapeType constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created shape_get_type.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets a slider_joint parameter (see SliderJointParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Gets a slider_joint parameter (see SliderJointParam constants).

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with area_set_space, or to a body with body_set_space.

Returns the state of a space, a PhysicsDirectSpaceState. This object can be used to make collision/intersection queries.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns the value of a space parameter.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Returns whether the space is active.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Marks a space as active. It will not have an effect, unless it is assigned to an area or body.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Sets the value for a space parameter. A list of available parameters is on the SpaceParameter constants.

Safety

This function has parameters of type Rid (resource ID). RIDs are untyped and interpreted as raw pointers by the engine, so passing an incorrect RID can cause UB.

Methods from Deref<Target = Object>

Adds a user-defined signal. Arguments are optional, but can be added as an Array of dictionaries, each containing name: String and type: int (see [enum Variant.Type]) entries.

Default Arguments
  • arguments - [ ]

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

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

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Sample code is GDScript unless otherwise noted.

Calls the method on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

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

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. Contrarily to call, this method does not support a variable number of arguments but expects all parameters to be via a single Array.

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

This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).

Returns true if the object can translate strings. See set_message_translation and tr.

Sample code is GDScript unless otherwise noted.

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])
Default Arguments
  • binds - [ ]
  • flags - 0

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.

Sample code is GDScript unless otherwise noted.

Emits the given signal. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

emit_signal("hit", weapon_type, damage)
emit_signal("game_over")

Returns the Variant value of the given property. If the property doesn’t exist, this will return null. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically 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.

Returns an Array of dictionaries with information about signals that are connected to the object. Each Dictionary contains three String entries:

  • source is a reference to the signal emitter.
  • signal_name is the name of the connected signal.
  • method_name is the name of the method to which the signal is connected.

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".

Returns the object’s unique instance ID. This ID can be saved in EncodedObjectAsID, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].

Returns the object’s metadata entry for the given name.

Returns the object’s metadata as a PoolStringArray.

Returns the object’s methods and their signatures as an Array.

Returns the object’s property list as an Array of dictionaries. Each property’s Dictionary contain at least name: String and type: int (see [enum Variant.Type]) entries. Optionally, it can also include hint: int (see [PropertyHint][PropertyHint]), hint_string: String, and usage: int (see [PropertyUsageFlags][PropertyUsageFlags]).

Returns the object’s Script instance, or null if none is assigned.

Returns an Array of connections for the given signal.

Returns the list of signals as an Array of dictionaries.

Returns true if a metadata entry is found with the given name.

Returns true if the object contains the given method.

Returns true if the given signal exists.

Returns true if the given user-defined signal exists. Only signals added using add_user_signal are taken into account.

Returns true if signal emission blocking is enabled.

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.

Returns true if the Node.queue_free method was called for the object.

Send a given notification to the object, which will also trigger a call to the [_notification][Self::_notification] method of all classes that the object inherits from. If reversed is true, [_notification][Self::_notification] is called first on the object’s own class, and then up to its successive parent classes. If reversed is false, [_notification][Self::_notification] is called first on the highest ancestor (Object itself), and then down to its successive inheriting classes.

Default Arguments
  • reversed - false

Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.

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

Assigns a new value to the given property. If the property does not exist, nothing will happen. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

If set to true, signal emission is blocked.

Assigns a new value to the given property, after the current frame’s physics step. This is equivalent to calling set via call_deferred, i.e. call_deferred("set", property, value). Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

Sample code is GDScript unless otherwise noted.

Assigns a new value to the property identified by the NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Example:

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

Defines whether the object can translate strings (with calls to tr). Enabled by default.

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".

Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script’s [_init][Self::_init] method will be called.

Returns a String representing the object. If not overridden, defaults to "[ClassName:RID]". Override the method [_to_string][Self::_to_string] to customize the String representation.

Translates a message using translation catalogs configured in the Project Settings. Only works if message translation is enabled (which it is by default), otherwise it returns the message unchanged. See set_message_translation.

Trait Implementations

Formats the value using the given formatter. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information. Read more

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option. Read more

Performs a dynamic reference downcast to target type. Read more

Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more

Creates a persistent reference to the same Godot object with shared thread access. Read more

Creates a persistent reference to the same Godot object with unique access. Read more

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id. Read more

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.