Class PhysicsDirectSpaceState2D
- Namespace
- Godot
- Assembly
- GodotSharp.dll
Provides direct access to a physics space in the PhysicsServer2D. It's used mainly to do queries against objects and areas residing in a given space.
public class PhysicsDirectSpaceState2D : GodotObject, IDisposable- Inheritance
-
PhysicsDirectSpaceState2D
- Implements
- Derived
- Inherited Members
Methods
CastMotion(PhysicsShapeQueryParameters2D)
Checks how far a Shape2D can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a PhysicsShapeQueryParameters2D object.
Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [1.0, 1.0] will be returned.
Note: Any Shape2Ds that the shape is already colliding with e.g. inside of, will be ignored. Use CollideShape(PhysicsShapeQueryParameters2D, int) to determine the Shape2Ds that the shape is already colliding with.
public float[] CastMotion(PhysicsShapeQueryParameters2D parameters)Parameters
parametersPhysicsShapeQueryParameters2D
Returns
- float[]
CollideShape(PhysicsShapeQueryParameters2D, int)
Checks the intersections of a shape, given through a PhysicsShapeQueryParameters2D object, against the space. The resulting array contains a list of points where the shape intersects another. Like with IntersectShape(PhysicsShapeQueryParameters2D, int), the number of returned results can be limited to save processing time.
Returned points are a list of pairs of contact points. For each pair the first one is in the shape passed in PhysicsShapeQueryParameters2D object, second one is in the collided shape from the physics space.
public Array<Vector2> CollideShape(PhysicsShapeQueryParameters2D parameters, int maxResults = 32)Parameters
parametersPhysicsShapeQueryParameters2DmaxResultsint
Returns
GetRestInfo(PhysicsShapeQueryParameters2D)
Checks the intersections of a shape, given through a PhysicsShapeQueryParameters2D object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead.
Note: This method does not take into account the motion property of the object. The returned object is a dictionary containing the following fields:
collider_id: The colliding object's ID.
linear_velocity: The colliding object's velocity Vector2. If the object is an Area2D, the result is (0, 0).
normal: The object's surface normal at the intersection point.
point: The intersection point.
rid: The intersecting object's Rid.
shape: The shape index of the colliding shape.
public Dictionary GetRestInfo(PhysicsShapeQueryParameters2D parameters)Parameters
parametersPhysicsShapeQueryParameters2D
Returns
HasGodotClassMethod(in godot_string_name)
Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.
protected override bool HasGodotClassMethod(in godot_string_name method)Parameters
methodgodot_string_nameName of the method to check for.
Returns
HasGodotClassSignal(in godot_string_name)
Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.
protected override bool HasGodotClassSignal(in godot_string_name signal)Parameters
signalgodot_string_nameName of the signal to check for.
Returns
IntersectPoint(PhysicsPointQueryParameters2D, int)
Checks whether a point is inside any solid shape. Position and other parameters are defined through PhysicsPointQueryParameters2D. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:
collider: The colliding object.
collider_id: The colliding object's ID.
rid: The intersecting object's Rid.
shape: The shape index of the colliding shape.
The number of intersections can be limited with the maxResults parameter, to reduce the processing time.
Note:
ConcavePolygonShape2Ds and CollisionPolygon2Ds in Segments build mode are not solid shapes. Therefore, they will not be detected.
public Array<Dictionary> IntersectPoint(PhysicsPointQueryParameters2D parameters, int maxResults = 32)Parameters
parametersPhysicsPointQueryParameters2DmaxResultsint
Returns
IntersectRay(PhysicsRayQueryParameters2D)
Intersects a ray in a given space. Ray position and other parameters are defined through PhysicsRayQueryParameters2D. The returned object is a dictionary with the following fields:
collider: The colliding object.
collider_id: The colliding object's ID.
normal: The object's surface normal at the intersection point, or Vector2(0, 0) if the ray starts inside the shape and HitFromInside is true.
position: The intersection point.
rid: The intersecting object's Rid.
shape: The shape index of the colliding shape.
If the ray did not intersect anything, then an empty dictionary is returned instead.
public Dictionary IntersectRay(PhysicsRayQueryParameters2D parameters)Parameters
parametersPhysicsRayQueryParameters2D
Returns
IntersectShape(PhysicsShapeQueryParameters2D, int)
Checks the intersections of a shape, given through a PhysicsShapeQueryParameters2D object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields:
collider: The colliding object.
collider_id: The colliding object's ID.
rid: The intersecting object's Rid.
shape: The shape index of the colliding shape.
The number of intersections can be limited with the maxResults parameter, to reduce the processing time.
public Array<Dictionary> IntersectShape(PhysicsShapeQueryParameters2D parameters, int maxResults = 32)Parameters
parametersPhysicsShapeQueryParameters2DmaxResultsint
Returns
InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)
Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.
protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)Parameters
methodgodot_string_nameName of the method to invoke.
argsNativeVariantPtrArgsArguments to use with the invoked method.
retgodot_variantValue returned by the invoked method.