Documentation
¶
Overview ¶
Describes the motion and collision result from graphics.gd/classdb/PhysicsServer2D.BodyTestMotion.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsPhysicsTestMotionResult2D() Instance
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) GetCollider() Object.Instance
- func (self Instance) GetColliderId() int
- func (self Instance) GetColliderRid() RID.Body2D
- func (self Instance) GetColliderShape() int
- func (self Instance) GetColliderVelocity() Vector2.XY
- func (self Instance) GetCollisionDepth() Float.X
- func (self Instance) GetCollisionLocalShape() int
- func (self Instance) GetCollisionNormal() Vector2.XY
- func (self Instance) GetCollisionPoint() Vector2.XY
- func (self Instance) GetCollisionSafeFraction() Float.X
- func (self Instance) GetCollisionUnsafeFraction() Float.X
- func (self Instance) GetRemainder() Vector2.XY
- func (self Instance) GetTravel() Vector2.XY
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsPhysicsTestMotionResult2D ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.PhysicsTestMotionResult2D
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsPhysicsTestMotionResult2D ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) GetCollider ¶
Returns the colliding body's attached graphics.gd/classdb/Object, if a collision occurred.
func (Instance) GetColliderId ¶
Returns the unique instance ID of the colliding body's attached graphics.gd/classdb/Object, if a collision occurred. See graphics.gd/classdb/Object.Instance.GetInstanceId.
func (Instance) GetColliderRid ¶
Returns the colliding body's [Resource.ID] used by the graphics.gd/classdb/PhysicsServer2D, if a collision occurred.
func (Instance) GetColliderShape ¶
Returns the colliding body's shape index, if a collision occurred. See graphics.gd/classdb/CollisionObject2D.
func (Instance) GetColliderVelocity ¶
Returns the colliding body's velocity, if a collision occurred.
func (Instance) GetCollisionDepth ¶
Returns the length of overlap along the collision normal, if a collision occurred.
func (Instance) GetCollisionLocalShape ¶
Returns the moving object's colliding shape, if a collision occurred.
func (Instance) GetCollisionNormal ¶
Returns the colliding body's shape's normal at the point of collision, if a collision occurred.
func (Instance) GetCollisionPoint ¶
Returns the point of collision in global coordinates, if a collision occurred.
func (Instance) GetCollisionSafeFraction ¶
Returns the maximum fraction of the motion that can occur without a collision, between 0 and 1.
func (Instance) GetCollisionUnsafeFraction ¶
Returns the minimum fraction of the motion needed to collide, if a collision occurred, between 0 and 1.
func (Instance) GetRemainder ¶
Returns the moving object's remaining movement vector.
Source Files