Struct gdnative_bindings::Physics2DServer
source · pub struct Physics2DServer { /* private fields */ }
Expand description
core singleton class Physics2DServer
inherits Object
(manually managed).
This class has related types in the physics_2d_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
Physics2DServer 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§
source§impl Physics2DServer
impl Physics2DServer
Constants
pub const AREA_BODY_ADDED: i64 = 0i64
pub const AREA_PARAM_GRAVITY: i64 = 0i64
pub const AREA_SPACE_OVERRIDE_DISABLED: i64 = 0i64
pub const BODY_MODE_STATIC: i64 = 0i64
pub const BODY_PARAM_BOUNCE: i64 = 0i64
pub const BODY_STATE_TRANSFORM: i64 = 0i64
pub const CCD_MODE_DISABLED: i64 = 0i64
pub const DAMPED_STRING_REST_LENGTH: i64 = 0i64
pub const INFO_ACTIVE_OBJECTS: i64 = 0i64
pub const JOINT_PARAM_BIAS: i64 = 0i64
pub const JOINT_PIN: i64 = 0i64
pub const SHAPE_LINE: i64 = 0i64
pub const SPACE_PARAM_CONTACT_RECYCLE_RADIUS: i64 = 0i64
pub const AREA_BODY_REMOVED: i64 = 1i64
pub const AREA_PARAM_GRAVITY_VECTOR: i64 = 1i64
pub const AREA_SPACE_OVERRIDE_COMBINE: i64 = 1i64
pub const BODY_MODE_KINEMATIC: i64 = 1i64
pub const BODY_PARAM_FRICTION: i64 = 1i64
pub const BODY_STATE_LINEAR_VELOCITY: i64 = 1i64
pub const CCD_MODE_CAST_RAY: i64 = 1i64
pub const DAMPED_STRING_STIFFNESS: i64 = 1i64
pub const INFO_COLLISION_PAIRS: i64 = 1i64
pub const JOINT_GROOVE: i64 = 1i64
pub const JOINT_PARAM_MAX_BIAS: i64 = 1i64
pub const SHAPE_RAY: i64 = 1i64
pub const SPACE_PARAM_CONTACT_MAX_SEPARATION: i64 = 1i64
pub const AREA_PARAM_GRAVITY_IS_POINT: i64 = 2i64
pub const AREA_SPACE_OVERRIDE_COMBINE_REPLACE: i64 = 2i64
pub const BODY_MODE_RIGID: i64 = 2i64
pub const BODY_PARAM_MASS: i64 = 2i64
pub const BODY_STATE_ANGULAR_VELOCITY: i64 = 2i64
pub const CCD_MODE_CAST_SHAPE: i64 = 2i64
pub const DAMPED_STRING_DAMPING: i64 = 2i64
pub const INFO_ISLAND_COUNT: i64 = 2i64
pub const JOINT_DAMPED_SPRING: i64 = 2i64
pub const JOINT_PARAM_MAX_FORCE: i64 = 2i64
pub const SHAPE_SEGMENT: i64 = 2i64
pub const SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION: i64 = 2i64
pub const AREA_PARAM_GRAVITY_DISTANCE_SCALE: i64 = 3i64
pub const AREA_SPACE_OVERRIDE_REPLACE: i64 = 3i64
pub const BODY_MODE_CHARACTER: i64 = 3i64
pub const BODY_PARAM_INERTIA: i64 = 3i64
pub const BODY_STATE_SLEEPING: i64 = 3i64
pub const SHAPE_CIRCLE: i64 = 3i64
pub const SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD: i64 = 3i64
pub const AREA_PARAM_GRAVITY_POINT_ATTENUATION: i64 = 4i64
pub const AREA_SPACE_OVERRIDE_REPLACE_COMBINE: i64 = 4i64
pub const BODY_PARAM_GRAVITY_SCALE: i64 = 4i64
pub const BODY_STATE_CAN_SLEEP: i64 = 4i64
pub const SHAPE_RECTANGLE: i64 = 4i64
pub const SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD: i64 = 4i64
pub const AREA_PARAM_LINEAR_DAMP: i64 = 5i64
pub const BODY_PARAM_LINEAR_DAMP: i64 = 5i64
pub const SHAPE_CAPSULE: i64 = 5i64
pub const SPACE_PARAM_BODY_TIME_TO_SLEEP: i64 = 5i64
pub const AREA_PARAM_ANGULAR_DAMP: i64 = 6i64
pub const BODY_PARAM_ANGULAR_DAMP: i64 = 6i64
pub const SHAPE_CONVEX_POLYGON: i64 = 6i64
pub const SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS: i64 = 6i64
pub const AREA_PARAM_PRIORITY: i64 = 7i64
pub const BODY_PARAM_MAX: i64 = 7i64
pub const SHAPE_CONCAVE_POLYGON: i64 = 7i64
pub const SHAPE_CUSTOM: i64 = 8i64
source§impl Physics2DServer
impl Physics2DServer
sourcepub unsafe fn godot_singleton() -> &'static Self
pub unsafe fn godot_singleton() -> &'static Self
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.
sourcepub unsafe fn area_add_shape(
&self,
area: Rid,
shape: Rid,
transform: Transform2D,
disabled: bool
)
pub unsafe fn area_add_shape(
&self,
area: Rid,
shape: Rid,
transform: Transform2D,
disabled: bool
)
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
-Transform2D( 1, 0, 0, 1, 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.
sourcepub unsafe fn area_attach_canvas_instance_id(&self, area: Rid, id: i64)
pub unsafe fn area_attach_canvas_instance_id(&self, area: Rid, id: i64)
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.
sourcepub unsafe fn area_attach_object_instance_id(&self, area: Rid, id: i64)
pub unsafe fn area_attach_object_instance_id(&self, area: Rid, id: i64)
sourcepub unsafe fn area_clear_shapes(&self, area: Rid)
pub unsafe fn area_clear_shapes(&self, area: Rid)
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.
sourcepub fn area_create(&self) -> Rid
pub fn area_create(&self) -> Rid
Creates an Area2D
. After creating an Area2D
with this method, assign it to a space using area_set_space
to use the created Area2D
in the physics world.
sourcepub unsafe fn area_get_canvas_instance_id(&self, area: Rid) -> i64
pub unsafe fn area_get_canvas_instance_id(&self, area: Rid) -> i64
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.
sourcepub unsafe fn area_get_object_instance_id(&self, area: Rid) -> i64
pub unsafe fn area_get_object_instance_id(&self, area: Rid) -> i64
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.
sourcepub unsafe fn area_get_param(&self, area: Rid, param: i64) -> Variant
pub unsafe fn area_get_param(&self, area: Rid, param: i64) -> Variant
Returns an area parameter value. See AreaParameter
for a list of available parameters.
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.
sourcepub unsafe fn area_get_shape(&self, area: Rid, shape_idx: i64) -> Rid
pub unsafe fn area_get_shape(&self, area: Rid, shape_idx: i64) -> Rid
sourcepub unsafe fn area_get_shape_count(&self, area: Rid) -> i64
pub unsafe fn area_get_shape_count(&self, area: Rid) -> i64
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.
sourcepub unsafe fn area_get_shape_transform(
&self,
area: Rid,
shape_idx: i64
) -> Transform2D
pub unsafe fn area_get_shape_transform(
&self,
area: Rid,
shape_idx: i64
) -> Transform2D
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.
sourcepub unsafe fn area_get_space(&self, area: Rid) -> Rid
pub unsafe fn area_get_space(&self, area: Rid) -> Rid
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.
sourcepub unsafe fn area_get_space_override_mode(
&self,
area: Rid
) -> AreaSpaceOverrideMode
pub unsafe fn area_get_space_override_mode(
&self,
area: Rid
) -> AreaSpaceOverrideMode
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.
sourcepub unsafe fn area_get_transform(&self, area: Rid) -> Transform2D
pub unsafe fn area_get_transform(&self, area: Rid) -> Transform2D
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.
sourcepub unsafe fn area_remove_shape(&self, area: Rid, shape_idx: i64)
pub unsafe fn area_remove_shape(&self, area: Rid, shape_idx: i64)
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.
sourcepub unsafe fn area_set_area_monitor_callback(
&self,
area: Rid,
receiver: impl AsArg<Object>,
method: impl Into<GodotString>
)
pub unsafe fn area_set_area_monitor_callback(
&self,
area: Rid,
receiver: impl AsArg<Object>,
method: impl Into<GodotString>
)
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.
sourcepub unsafe fn area_set_collision_layer(&self, area: Rid, layer: i64)
pub unsafe fn area_set_collision_layer(&self, area: Rid, layer: i64)
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.
sourcepub unsafe fn area_set_collision_mask(&self, area: Rid, mask: i64)
pub unsafe fn area_set_collision_mask(&self, area: Rid, mask: i64)
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.
sourcepub unsafe fn area_set_monitor_callback(
&self,
area: Rid,
receiver: impl AsArg<Object>,
method: impl Into<GodotString>
)
pub unsafe fn area_set_monitor_callback(
&self,
area: Rid,
receiver: impl AsArg<Object>,
method: impl Into<GodotString>
)
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.
sourcepub unsafe fn area_set_monitorable(&self, area: Rid, monitorable: bool)
pub unsafe fn area_set_monitorable(&self, area: Rid, monitorable: bool)
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.
sourcepub unsafe fn area_set_param(
&self,
area: Rid,
param: i64,
value: impl OwnedToVariant
)
pub unsafe fn area_set_param(
&self,
area: Rid,
param: i64,
value: impl OwnedToVariant
)
Sets the value for an area parameter. See AreaParameter
for a list of available parameters.
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.
sourcepub unsafe fn area_set_shape(&self, area: Rid, shape_idx: i64, shape: Rid)
pub unsafe fn area_set_shape(&self, area: Rid, shape_idx: i64, shape: Rid)
sourcepub unsafe fn area_set_shape_disabled(
&self,
area: Rid,
shape_idx: i64,
disabled: bool
)
pub unsafe fn area_set_shape_disabled(
&self,
area: Rid,
shape_idx: i64,
disabled: bool
)
Disables a given shape in 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.
sourcepub unsafe fn area_set_shape_transform(
&self,
area: Rid,
shape_idx: i64,
transform: Transform2D
)
pub unsafe fn area_set_shape_transform(
&self,
area: Rid,
shape_idx: i64,
transform: Transform2D
)
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.
sourcepub unsafe fn area_set_space(&self, area: Rid, space: Rid)
pub unsafe fn area_set_space(&self, area: Rid, space: Rid)
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.
sourcepub unsafe fn area_set_space_override_mode(&self, area: Rid, mode: i64)
pub unsafe fn area_set_space_override_mode(&self, area: Rid, mode: i64)
Sets the space override mode for the area. See AreaSpaceOverrideMode
for a list of available modes.
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.
sourcepub unsafe fn area_set_transform(&self, area: Rid, transform: Transform2D)
pub unsafe fn area_set_transform(&self, area: Rid, transform: Transform2D)
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.
sourcepub unsafe fn body_add_central_force(&self, body: Rid, force: Vector2)
pub unsafe fn body_add_central_force(&self, body: Rid, force: Vector2)
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.
sourcepub unsafe fn body_add_collision_exception(&self, body: Rid, excepted_body: Rid)
pub unsafe fn body_add_collision_exception(&self, body: Rid, excepted_body: Rid)
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.
sourcepub unsafe fn body_add_force(&self, body: Rid, offset: Vector2, force: Vector2)
pub unsafe fn body_add_force(&self, body: Rid, offset: Vector2, force: Vector2)
Adds a positioned force to the applied force and torque. As with body_apply_impulse
, both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied.
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.
sourcepub unsafe fn body_add_shape(
&self,
body: Rid,
shape: Rid,
transform: Transform2D,
disabled: bool
)
pub unsafe fn body_add_shape(
&self,
body: Rid,
shape: Rid,
transform: Transform2D,
disabled: bool
)
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
-Transform2D( 1, 0, 0, 1, 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.
sourcepub unsafe fn body_add_torque(&self, body: Rid, torque: f64)
pub unsafe fn body_add_torque(&self, body: Rid, torque: f64)
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.
sourcepub unsafe fn body_apply_central_impulse(&self, body: Rid, impulse: Vector2)
pub unsafe fn body_apply_central_impulse(&self, body: Rid, impulse: Vector2)
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.
sourcepub unsafe fn body_apply_impulse(
&self,
body: Rid,
position: Vector2,
impulse: Vector2
)
pub unsafe fn body_apply_impulse(
&self,
body: Rid,
position: Vector2,
impulse: Vector2
)
Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates.
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.
sourcepub unsafe fn body_apply_torque_impulse(&self, body: Rid, impulse: f64)
pub unsafe fn body_apply_torque_impulse(&self, body: Rid, impulse: f64)
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.
sourcepub unsafe fn body_attach_canvas_instance_id(&self, body: Rid, id: i64)
pub unsafe fn body_attach_canvas_instance_id(&self, body: Rid, id: i64)
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.
sourcepub unsafe fn body_attach_object_instance_id(&self, body: Rid, id: i64)
pub unsafe fn body_attach_object_instance_id(&self, body: Rid, id: i64)
sourcepub unsafe fn body_clear_shapes(&self, body: Rid)
pub unsafe fn body_clear_shapes(&self, body: Rid)
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.
sourcepub fn body_create(&self) -> Rid
pub fn body_create(&self) -> Rid
Creates a physics body.
sourcepub unsafe fn body_get_canvas_instance_id(&self, body: Rid) -> i64
pub unsafe fn body_get_canvas_instance_id(&self, body: Rid) -> i64
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.
sourcepub unsafe fn body_get_collision_layer(&self, body: Rid) -> i64
pub unsafe fn body_get_collision_layer(&self, body: Rid) -> i64
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.
sourcepub unsafe fn body_get_collision_mask(&self, body: Rid) -> i64
pub unsafe fn body_get_collision_mask(&self, body: Rid) -> i64
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.
sourcepub unsafe fn body_get_continuous_collision_detection_mode(
&self,
body: Rid
) -> CcdMode
pub unsafe fn body_get_continuous_collision_detection_mode(
&self,
body: Rid
) -> CcdMode
Returns the continuous collision detection 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.
sourcepub unsafe fn body_get_direct_state(
&self,
body: Rid
) -> Option<Ref<Physics2DDirectBodyState, Shared>>
pub unsafe fn body_get_direct_state(
&self,
body: Rid
) -> Option<Ref<Physics2DDirectBodyState, Shared>>
Returns the Physics2DDirectBodyState
of the body. Returns null
if the body is destroyed or removed from the physics space.
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.
sourcepub unsafe fn body_get_max_contacts_reported(&self, body: Rid) -> i64
pub unsafe fn body_get_max_contacts_reported(&self, body: Rid) -> i64
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.
sourcepub unsafe fn body_get_mode(&self, body: Rid) -> BodyMode
pub unsafe fn body_get_mode(&self, body: Rid) -> BodyMode
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.
sourcepub unsafe fn body_get_object_instance_id(&self, body: Rid) -> i64
pub unsafe fn body_get_object_instance_id(&self, body: Rid) -> i64
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.
sourcepub unsafe fn body_get_param(&self, body: Rid, param: i64) -> f64
pub unsafe fn body_get_param(&self, body: Rid, param: i64) -> f64
Returns the value of a body parameter. See BodyParameter
for a list of available parameters.
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.
sourcepub unsafe fn body_get_shape(&self, body: Rid, shape_idx: i64) -> Rid
pub unsafe fn body_get_shape(&self, body: Rid, shape_idx: i64) -> Rid
sourcepub unsafe fn body_get_shape_count(&self, body: Rid) -> i64
pub unsafe fn body_get_shape_count(&self, body: Rid) -> i64
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.
sourcepub unsafe fn body_get_shape_metadata(&self, body: Rid, shape_idx: i64) -> Variant
pub unsafe fn body_get_shape_metadata(&self, body: Rid, shape_idx: i64) -> Variant
Returns the metadata of a 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.
sourcepub unsafe fn body_get_shape_transform(
&self,
body: Rid,
shape_idx: i64
) -> Transform2D
pub unsafe fn body_get_shape_transform(
&self,
body: Rid,
shape_idx: i64
) -> Transform2D
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.
sourcepub unsafe fn body_get_space(&self, body: Rid) -> Rid
pub unsafe fn body_get_space(&self, body: Rid) -> Rid
sourcepub unsafe fn body_get_state(&self, body: Rid, state: i64) -> Variant
pub unsafe fn body_get_state(&self, body: Rid, state: i64) -> Variant
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.
sourcepub unsafe fn body_is_omitting_force_integration(&self, body: Rid) -> bool
pub unsafe fn body_is_omitting_force_integration(&self, body: Rid) -> bool
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.
sourcepub unsafe fn body_remove_collision_exception(
&self,
body: Rid,
excepted_body: Rid
)
pub unsafe fn body_remove_collision_exception(
&self,
body: Rid,
excepted_body: Rid
)
Removes a body from 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.
sourcepub unsafe fn body_remove_shape(&self, body: Rid, shape_idx: i64)
pub unsafe fn body_remove_shape(&self, body: Rid, shape_idx: i64)
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.
sourcepub unsafe fn body_set_axis_velocity(&self, body: Rid, axis_velocity: Vector2)
pub unsafe fn body_set_axis_velocity(&self, body: Rid, axis_velocity: Vector2)
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.
sourcepub unsafe fn body_set_collision_layer(&self, body: Rid, layer: i64)
pub unsafe fn body_set_collision_layer(&self, body: Rid, layer: i64)
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.
sourcepub unsafe fn body_set_collision_mask(&self, body: Rid, mask: i64)
pub unsafe fn body_set_collision_mask(&self, body: Rid, mask: i64)
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.
sourcepub unsafe fn body_set_continuous_collision_detection_mode(
&self,
body: Rid,
mode: i64
)
pub unsafe fn body_set_continuous_collision_detection_mode(
&self,
body: Rid,
mode: i64
)
Sets the continuous collision detection mode using one of the [CCDMode
][CCDMode] constants.
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.
sourcepub unsafe fn body_set_force_integration_callback(
&self,
body: Rid,
receiver: impl AsArg<Object>,
method: impl Into<GodotString>,
userdata: impl OwnedToVariant
)
pub unsafe fn body_set_force_integration_callback(
&self,
body: Rid,
receiver: impl AsArg<Object>,
method: impl Into<GodotString>,
userdata: impl OwnedToVariant
)
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.
sourcepub unsafe fn body_set_max_contacts_reported(&self, body: Rid, amount: i64)
pub unsafe fn body_set_max_contacts_reported(&self, body: Rid, amount: i64)
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.
sourcepub unsafe fn body_set_mode(&self, body: Rid, mode: i64)
pub unsafe fn body_set_mode(&self, body: Rid, mode: i64)
sourcepub unsafe fn body_set_omit_force_integration(&self, body: Rid, enable: bool)
pub unsafe fn body_set_omit_force_integration(&self, body: Rid, enable: bool)
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.
sourcepub unsafe fn body_set_param(&self, body: Rid, param: i64, value: f64)
pub unsafe fn body_set_param(&self, body: Rid, param: i64, value: f64)
Sets a body parameter. See BodyParameter
for a list of available parameters.
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.
sourcepub unsafe fn body_set_shape(&self, body: Rid, shape_idx: i64, shape: Rid)
pub unsafe fn body_set_shape(&self, body: Rid, shape_idx: i64, shape: Rid)
sourcepub unsafe fn body_set_shape_as_one_way_collision(
&self,
body: Rid,
shape_idx: i64,
enable: bool,
margin: f64
)
pub unsafe fn body_set_shape_as_one_way_collision(
&self,
body: Rid,
shape_idx: i64,
enable: bool,
margin: f64
)
Enables one way collision on body if enable
is true
.
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.
sourcepub unsafe fn body_set_shape_disabled(
&self,
body: Rid,
shape_idx: i64,
disabled: bool
)
pub unsafe fn body_set_shape_disabled(
&self,
body: Rid,
shape_idx: i64,
disabled: bool
)
Disables shape in body if disable
is true
.
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.
sourcepub unsafe fn body_set_shape_metadata(
&self,
body: Rid,
shape_idx: i64,
metadata: impl OwnedToVariant
)
pub unsafe fn body_set_shape_metadata(
&self,
body: Rid,
shape_idx: i64,
metadata: impl OwnedToVariant
)
Sets metadata of a shape within a body. This metadata is different from Object.set_meta
, and can be retrieved on shape 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.
sourcepub unsafe fn body_set_shape_transform(
&self,
body: Rid,
shape_idx: i64,
transform: Transform2D
)
pub unsafe fn body_set_shape_transform(
&self,
body: Rid,
shape_idx: i64,
transform: Transform2D
)
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.
sourcepub unsafe fn body_set_space(&self, body: Rid, space: Rid)
pub unsafe fn body_set_space(&self, body: Rid, space: Rid)
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.
sourcepub unsafe fn body_set_state(
&self,
body: Rid,
state: i64,
value: impl OwnedToVariant
)
pub unsafe fn body_set_state(
&self,
body: Rid,
state: i64,
value: impl OwnedToVariant
)
Sets a body state using one of the BodyState
constants.
Note that the method doesn’t take effect immediately. The state will change on the next physics frame.
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.
sourcepub unsafe fn body_test_motion(
&self,
body: Rid,
from: Transform2D,
motion: Vector2,
infinite_inertia: bool,
margin: f64,
result: impl AsArg<Physics2DTestMotionResult>,
exclude_raycast_shapes: bool,
exclude: VariantArray
) -> bool
pub unsafe fn body_test_motion(
&self,
body: Rid,
from: Transform2D,
motion: Vector2,
infinite_inertia: bool,
margin: f64,
result: impl AsArg<Physics2DTestMotionResult>,
exclude_raycast_shapes: bool,
exclude: VariantArray
) -> bool
Returns true
if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. Physics2DTestMotionResult
can be passed to return additional information in.
Default Arguments
margin
-0.08
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.
sourcepub fn capsule_shape_create(&self) -> Rid
pub fn capsule_shape_create(&self) -> Rid
sourcepub fn circle_shape_create(&self) -> Rid
pub fn circle_shape_create(&self) -> Rid
sourcepub fn concave_polygon_shape_create(&self) -> Rid
pub fn concave_polygon_shape_create(&self) -> Rid
sourcepub fn convex_polygon_shape_create(&self) -> Rid
pub fn convex_polygon_shape_create(&self) -> Rid
sourcepub unsafe fn damped_spring_joint_create(
&self,
anchor_a: Vector2,
anchor_b: Vector2,
body_a: Rid,
body_b: Rid
) -> Rid
pub unsafe fn damped_spring_joint_create(
&self,
anchor_a: Vector2,
anchor_b: Vector2,
body_a: Rid,
body_b: Rid
) -> Rid
Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.
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.
sourcepub unsafe fn damped_string_joint_get_param(&self, joint: Rid, param: i64) -> f64
pub unsafe fn damped_string_joint_get_param(&self, joint: Rid, param: i64) -> f64
Returns the value of a damped spring joint 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.
sourcepub unsafe fn damped_string_joint_set_param(
&self,
joint: Rid,
param: i64,
value: f64
)
pub unsafe fn damped_string_joint_set_param(
&self,
joint: Rid,
param: i64,
value: f64
)
Sets a damped spring joint parameter. See DampedStringParam
for a list of available parameters.
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.
sourcepub unsafe fn free_rid(&self, rid: Rid)
pub unsafe fn free_rid(&self, rid: Rid)
Destroys any of the objects created by Physics2DServer. If the RID
passed is not one of the objects that can be created by Physics2DServer, 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.
sourcepub fn get_process_info(&self, process_info: i64) -> i64
pub fn get_process_info(&self, process_info: i64) -> i64
Returns information about the current state of the 2D physics engine. See ProcessInfo
for a list of available states.
sourcepub unsafe fn groove_joint_create(
&self,
groove1_a: Vector2,
groove2_a: Vector2,
anchor_b: Vector2,
body_a: Rid,
body_b: Rid
) -> Rid
pub unsafe fn groove_joint_create(
&self,
groove1_a: Vector2,
groove2_a: Vector2,
anchor_b: Vector2,
body_a: Rid,
body_b: Rid
) -> Rid
Creates a groove joint between two bodies. If not specified, the bodies are assumed to be the joint itself.
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.
sourcepub unsafe fn joint_get_param(&self, joint: Rid, param: i64) -> f64
pub unsafe fn joint_get_param(&self, joint: Rid, param: i64) -> f64
Returns the value of a joint 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.
sourcepub unsafe fn joint_get_type(&self, joint: Rid) -> JointType
pub unsafe fn joint_get_type(&self, joint: Rid) -> JointType
sourcepub unsafe fn joint_set_param(&self, joint: Rid, param: i64, value: f64)
pub unsafe fn joint_set_param(&self, joint: Rid, param: i64, value: f64)
Sets a joint parameter. See JointParam
for a list of available parameters.
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.
sourcepub fn line_shape_create(&self) -> Rid
pub fn line_shape_create(&self) -> Rid
sourcepub unsafe fn pin_joint_create(
&self,
anchor: Vector2,
body_a: Rid,
body_b: Rid
) -> Rid
pub unsafe fn pin_joint_create(
&self,
anchor: Vector2,
body_a: Rid,
body_b: Rid
) -> Rid
Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
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.
sourcepub fn ray_shape_create(&self) -> Rid
pub fn ray_shape_create(&self) -> Rid
sourcepub fn rectangle_shape_create(&self) -> Rid
pub fn rectangle_shape_create(&self) -> Rid
sourcepub fn segment_shape_create(&self) -> Rid
pub fn segment_shape_create(&self) -> Rid
sourcepub fn set_active(&self, active: bool)
pub fn set_active(&self, active: bool)
Activates or deactivates the 2D physics engine.
sourcepub fn set_collision_iterations(&self, iterations: i64)
pub fn set_collision_iterations(&self, iterations: i64)
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
.
sourcepub unsafe fn shape_get_data(&self, shape: Rid) -> Variant
pub unsafe fn shape_get_data(&self, shape: Rid) -> Variant
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.
sourcepub unsafe fn shape_get_type(&self, shape: Rid) -> ShapeType
pub unsafe fn shape_get_type(&self, shape: Rid) -> ShapeType
sourcepub unsafe fn shape_set_data(&self, shape: Rid, data: impl OwnedToVariant)
pub unsafe fn shape_set_data(&self, shape: Rid, data: impl OwnedToVariant)
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.
sourcepub fn space_create(&self) -> Rid
pub fn space_create(&self) -> Rid
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
.
sourcepub unsafe fn space_get_direct_state(
&self,
space: Rid
) -> Option<Ref<Physics2DDirectSpaceState, Shared>>
pub unsafe fn space_get_direct_state(
&self,
space: Rid
) -> Option<Ref<Physics2DDirectSpaceState, Shared>>
Returns the state of a space, a Physics2DDirectSpaceState
. 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.
sourcepub unsafe fn space_get_param(&self, space: Rid, param: i64) -> f64
pub unsafe fn space_get_param(&self, space: Rid, param: i64) -> f64
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.
sourcepub unsafe fn space_is_active(&self, space: Rid) -> bool
pub unsafe fn space_is_active(&self, space: Rid) -> bool
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.
sourcepub unsafe fn space_set_active(&self, space: Rid, active: bool)
pub unsafe fn space_set_active(&self, space: Rid, active: bool)
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.
sourcepub unsafe fn space_set_param(&self, space: Rid, param: i64, value: f64)
pub unsafe fn space_set_param(&self, space: Rid, param: i64, value: f64)
Sets the value for a space parameter. See SpaceParameter
for a list of available parameters.
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>§
pub const NOTIFICATION_POSTINITIALIZE: i64 = 0i64
pub const CONNECT_DEFERRED: i64 = 1i64
pub const NOTIFICATION_PREDELETE: i64 = 1i64
pub const CONNECT_PERSIST: i64 = 2i64
pub const CONNECT_ONESHOT: i64 = 4i64
pub const CONNECT_REFERENCE_COUNTED: i64 = 8i64
sourcepub fn add_user_signal(
&self,
signal: impl Into<GodotString>,
arguments: VariantArray
)
pub fn add_user_signal(
&self,
signal: impl Into<GodotString>,
arguments: VariantArray
)
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
-[ ]
sourcepub unsafe fn call(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
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(), …).
sourcepub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
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(), …).
sourcepub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
pub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
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(), …).
sourcepub fn can_translate_messages(&self) -> bool
pub fn can_translate_messages(&self) -> bool
Returns true
if the object can translate strings. See set_message_translation
and tr
.
sourcepub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
pub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
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 print 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
sourcepub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
pub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
Disconnects a signal
from a method
on the given target
.
If you try to disconnect a connection that does not exist, the method will print an error. Use is_connected
to ensure that the connection exists.
sourcepub fn emit_signal(
&self,
signal: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub fn emit_signal(
&self,
signal: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
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")
sourcepub fn get(&self, property: impl Into<GodotString>) -> Variant
pub fn get(&self, property: impl Into<GodotString>) -> Variant
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).
sourcepub fn get_class(&self) -> GodotString
pub fn get_class(&self) -> GodotString
sourcepub fn get_incoming_connections(&self) -> VariantArray
pub fn get_incoming_connections(&self) -> VariantArray
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.
sourcepub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant
pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant
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 Node
s in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use Node.get_node_and_resource
instead.
sourcepub fn get_instance_id(&self) -> i64
pub fn get_instance_id(&self) -> i64
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].
sourcepub fn get_meta(
&self,
name: impl Into<GodotString>,
default: impl OwnedToVariant
) -> Variant
pub fn get_meta(
&self,
name: impl Into<GodotString>,
default: impl OwnedToVariant
) -> Variant
Returns the object’s metadata entry for the given name
.
Throws error if the entry does not exist, unless default
is not null
(in which case the default value will be returned).
Default Arguments
default
-null
sourcepub fn get_meta_list(&self) -> PoolArray<GodotString>
pub fn get_meta_list(&self) -> PoolArray<GodotString>
Returns the object’s metadata as a PoolStringArray
.
sourcepub fn get_method_list(&self) -> VariantArray
pub fn get_method_list(&self) -> VariantArray
Returns the object’s methods and their signatures as an Array
.
sourcepub fn get_property_list(&self) -> VariantArray
pub fn get_property_list(&self) -> VariantArray
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]).
sourcepub fn get_script(&self) -> Option<Ref<Reference, Shared>>
pub fn get_script(&self) -> Option<Ref<Reference, Shared>>
Returns the object’s Script
instance, or null
if none is assigned.
sourcepub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray
pub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray
Returns an Array
of connections for the given signal
.
sourcepub fn get_signal_list(&self) -> VariantArray
pub fn get_signal_list(&self) -> VariantArray
Returns the list of signals as an Array
of dictionaries.
sourcepub fn has_meta(&self, name: impl Into<GodotString>) -> bool
pub fn has_meta(&self, name: impl Into<GodotString>) -> bool
Returns true
if a metadata entry is found with the given name
.
sourcepub fn has_method(&self, method: impl Into<GodotString>) -> bool
pub fn has_method(&self, method: impl Into<GodotString>) -> bool
Returns true
if the object contains the given method
.
sourcepub fn has_signal(&self, signal: impl Into<GodotString>) -> bool
pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool
Returns true
if the given signal
exists.
sourcepub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool
pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool
Returns true
if the given user-defined signal
exists. Only signals added using add_user_signal
are taken into account.
sourcepub fn is_blocking_signals(&self) -> bool
pub fn is_blocking_signals(&self) -> bool
Returns true
if signal emission blocking is enabled.
sourcepub fn is_class(&self, class: impl Into<GodotString>) -> bool
pub fn is_class(&self, class: impl Into<GodotString>) -> bool
sourcepub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
pub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
Returns true
if a connection exists for a given signal
, target
, and method
.
sourcepub fn is_queued_for_deletion(&self) -> bool
pub fn is_queued_for_deletion(&self) -> bool
Returns true
if the Node.queue_free
method was called for the object.
sourcepub fn notification(&self, what: i64, reversed: bool)
pub fn notification(&self, what: i64, reversed: bool)
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
sourcepub fn property_list_changed_notify(&self)
pub fn property_list_changed_notify(&self)
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.
sourcepub fn remove_meta(&self, name: impl Into<GodotString>)
pub fn remove_meta(&self, name: impl Into<GodotString>)
Removes a given entry from the object’s metadata. See also set_meta
.
sourcepub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)
pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)
Assigns a new value to the given property. If the property
does not exist or the given value’s type doesn’t match, 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).
sourcepub fn set_block_signals(&self, enable: bool)
pub fn set_block_signals(&self, enable: bool)
If set to true
, signal emission is blocked.
sourcepub fn set_deferred(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant
)
pub fn set_deferred(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant
)
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).
sourcepub fn set_indexed(
&self,
property: impl Into<NodePath>,
value: impl OwnedToVariant
)
pub fn set_indexed(
&self,
property: impl Into<NodePath>,
value: impl OwnedToVariant
)
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)
sourcepub fn set_message_translation(&self, enable: bool)
pub fn set_message_translation(&self, enable: bool)
Defines whether the object can translate strings (with calls to tr
). Enabled by default.
sourcepub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)
pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)
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"
.
sourcepub fn set_script(&self, script: impl AsArg<Reference>)
pub fn set_script(&self, script: impl AsArg<Reference>)
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.
sourcepub fn to_string(&self) -> GodotString
pub fn to_string(&self) -> GodotString
sourcepub fn tr(&self, message: impl Into<GodotString>) -> GodotString
pub fn tr(&self, message: impl Into<GodotString>) -> GodotString
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§
source§impl Debug for Physics2DServer
impl Debug for Physics2DServer
source§impl Deref for Physics2DServer
impl Deref for Physics2DServer
source§impl DerefMut for Physics2DServer
impl DerefMut for Physics2DServer
source§impl GodotObject for Physics2DServer
impl GodotObject for Physics2DServer
§type Memory = ManuallyManaged
type Memory = ManuallyManaged
Ref
smart pointer. See its type-level documentation for more
information.fn class_name() -> &'static str
source§fn null() -> Null<Self>
fn null() -> Null<Self>
Self
as a method argument. This makes type
inference easier for the compiler compared to Option
.