class_physics2ddirectspacestate - vkbsb/godot GitHub Wiki

Physics2DDirectSpaceState

####Inherits: Object ####Category: Core

Brief Description

Direct access object to a space in the Physics2DServer.

Member Functions

Numeric Constants

  • TYPE_MASK_STATIC_BODY = 1
  • TYPE_MASK_KINEMATIC_BODY = 2
  • TYPE_MASK_RIGID_BODY = 4
  • TYPE_MASK_CHARACTER_BODY = 8
  • TYPE_MASK_AREA = 16
  • TYPE_MASK_COLLISION = 15

Description

Direct access object to a space in the Physics2DServer. It's used mainly to do queries against objects and areas residing in a given space.

Member Function Description

intersect_ray

Intersect a ray in a given space, the returned object is a dictionary with the following fields:

		position: place where ray is stopped

		normal: normal of the object at the point where the ray was stopped 

		shape:  shape index of the object agaisnt which the ray was stopped

		collider_: collider agaisnt which the ray was stopped

		collider_id: collider id of the object agaisnt which the ray was stopped

		collider: collider object agaisnt which the ray was stopped

		rid:  [RID](class_rid) of the object agaisnt which the ray was stopped

		If the ray did not intersect anything, then null is returned instead of a [Dictionary](class_dictionary).

intersect_shape

Intersect a given shape (RID or Shape2D) against the space, the intersected shapes are returned in a special result object.