PhysicsDirectSpaceState2D

Documentation

Overview

Package PhysicsDirectSpaceState2D provides methods for working with PhysicsDirectSpaceState2D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsPhysicsDirectSpaceState2D() Instance
  • func (self Instance) CastMotion(parameters [1]gdclass.PhysicsShapeQueryParameters2D) []float32
  • func (self Instance) CollideShape(parameters [1]gdclass.PhysicsShapeQueryParameters2D) []Vector2.XY
  • func (self Instance) GetRestInfo(parameters [1]gdclass.PhysicsShapeQueryParameters2D) PhysicsDirectSpaceState2D_RestInfo
  • func (self Instance) IntersectPoint(parameters [1]gdclass.PhysicsPointQueryParameters2D) []PhysicsDirectSpaceState2D_Intersection
  • func (self Instance) IntersectRay(parameters [1]gdclass.PhysicsRayQueryParameters2D) PhysicsDirectSpaceState2D_Intersection
  • func (self Instance) IntersectShape(parameters [1]gdclass.PhysicsShapeQueryParameters2D) []PhysicsDirectSpaceState2D_Intersection
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type PhysicsDirectSpaceState2D_Intersection
• type PhysicsDirectSpaceState2D_RestInfo

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsPhysicsDirectSpaceState2D() Instance
}

type Instance

type Instance [1]gdclass.PhysicsDirectSpaceState2D

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.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsPhysicsDirectSpaceState2D

func (self Instance) AsPhysicsDirectSpaceState2D() Instance

func (Instance) CastMotion

func (self Instance) CastMotion(parameters [1]gdclass.PhysicsShapeQueryParameters2D) []float32

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 [code][1.0, 1.0][/code] will be returned. [b]Note:[/b] Any [Shape2D]s that the shape is already colliding with e.g. inside of, will be ignored. Use [method collide_shape] to determine the [Shape2D]s that the shape is already colliding with.

func (Instance) CollideShape

func (self Instance) CollideShape(parameters [1]gdclass.PhysicsShapeQueryParameters2D) []Vector2.XY

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 [method intersect_shape], 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.

func (Instance) GetRestInfo

func (self Instance) GetRestInfo(parameters [1]gdclass.PhysicsShapeQueryParameters2D) PhysicsDirectSpaceState2D_RestInfo

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. [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The returned object is a dictionary containing the following fields: [code]collider_id[/code]: The colliding object's ID. [code]linear_velocity[/code]: The colliding object's velocity [Vector2]. If the object is an [Area2D], the result is [code](0, 0)[/code]. [code]normal[/code]: The object's surface normal at the intersection point. [code]point[/code]: The intersection point. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape.

func (Instance) IntersectPoint

func (self Instance) IntersectPoint(parameters [1]gdclass.PhysicsPointQueryParameters2D) []PhysicsDirectSpaceState2D_Intersection

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: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. The number of intersections can be limited with the [param max_results] parameter, to reduce the processing time. [b]Note:[/b] [ConcavePolygonShape2D]s and [CollisionPolygon2D]s in [code]Segments[/code] build mode are not solid shapes. Therefore, they will not be detected.

func (Instance) IntersectRay

func (self Instance) IntersectRay(parameters [1]gdclass.PhysicsRayQueryParameters2D) PhysicsDirectSpaceState2D_Intersection

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: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]normal[/code]: The object's surface normal at the intersection point, or [code]Vector2(0, 0)[/code] if the ray starts inside the shape and [member PhysicsRayQueryParameters2D.hit_from_inside] is [code]true[/code]. [code]position[/code]: The intersection point. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. If the ray did not intersect anything, then an empty dictionary is returned instead.

func (Instance) IntersectShape

func (self Instance) IntersectShape(parameters [1]gdclass.PhysicsShapeQueryParameters2D) []PhysicsDirectSpaceState2D_Intersection

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: [code]collider[/code]: The colliding object. [code]collider_id[/code]: The colliding object's ID. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. The number of intersections can be limited with the [param max_results] parameter, to reduce the processing time.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type PhysicsDirectSpaceState2D_Intersection

type PhysicsDirectSpaceState2D_Intersection struct {
	Collider   Object.Instance `gd:"collider"`
	ColliderID Object.ID       `gd:"collider_id"`
	Normal     struct {
		X float32
		Y float32
	} `gd:"normal"`
	Position struct {
		X float32
		Y float32
	} `gd:"position"`
	RID   RID.Any `gd:"rid"`
	Shape int     `gd:"shape"`
}

type PhysicsDirectSpaceState2D_RestInfo

type PhysicsDirectSpaceState2D_RestInfo struct {
	ColliderID     Object.ID `gd:"collider_id"`
	LinearVelocity struct {
		X float32
		Y float32
	} `gd:"linear_velocity"`
	Normal struct {
		X float32
		Y float32
	} `gd:"normal"`
	Point struct {
		X float32
		Y float32
	} `gd:"point"`
	RID   RID.Any `gd:"rid"`
	Shape int     `gd:"shape"`
}