Documentation
¶
Overview ¶
By changing various properties of this object, such as the motion, you can configure the parameters for PhysicsServer2D.BodyTestMotion.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsPhysicsTestMotionParameters2D() Instance
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) CollideSeparationRay() bool
- func (self Instance) ExcludeBodies() []RID.Any
- func (self Instance) ExcludeObjects() []int
- func (self Instance) From() Transform2D.OriginXY
- func (self Instance) ID() ID
- func (self Instance) Margin() Float.X
- func (self Instance) Motion() Vector2.XY
- func (self Instance) RecoveryAsCollision() bool
- func (self Instance) SetCollideSeparationRay(value bool)
- func (self Instance) SetExcludeBodies(value []RID.Any)
- func (self Instance) SetExcludeObjects(value []int)
- func (self Instance) SetFrom(value Transform2D.OriginXY)
- func (self Instance) SetMargin(value Float.X)
- func (self Instance) SetMotion(value Vector2.XY)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetRecoveryAsCollision(value 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]) AsPhysicsTestMotionParameters2D ¶
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.PhysicsTestMotionParameters2D
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) AsPhysicsTestMotionParameters2D ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) CollideSeparationRay ¶
If set to true, shapes of type [Physicsserver2d.ShapeSeparationRay] are used to detect collisions and can stop the motion. Can be useful when snapping to the ground.
If set to false, shapes of type [Physicsserver2d.ShapeSeparationRay] are only used for separation when overlapping with other bodies. That's the main use for separation ray shapes.
func (Instance) ExcludeBodies ¶
Optional array of body Resource.ID to exclude from collision. Use CollisionObject2D.GetRid to get the Resource.ID associated with a CollisionObject2D-derived node.
func (Instance) ExcludeObjects ¶
Optional array of object unique instance ID to exclude from collision. See Object.GetInstanceId.
func (Instance) From ¶
func (self Instance) From() Transform2D.OriginXY
Transform in global space where the motion should start. Usually set to Node2D.GlobalTransform for the current body's transform.
func (Instance) RecoveryAsCollision ¶
If set to true, any depenetration from the recovery phase is reported as a collision; this is used e.g. by CharacterBody2D for improving floor detection during floor snapping.
If set to false, only collisions resulting from the motion are reported, which is generally the desired behavior.
func (Instance) SetCollideSeparationRay ¶
SetCollideSeparationRay sets the property returned by [IsCollideSeparationRayEnabled].
func (Instance) SetExcludeBodies ¶
SetExcludeBodies sets the property returned by [GetExcludeBodies].
func (Instance) SetExcludeObjects ¶
SetExcludeObjects sets the property returned by [GetExcludeObjects].
func (Instance) SetFrom ¶
func (self Instance) SetFrom(value Transform2D.OriginXY)
SetFrom sets the property returned by [GetFrom].
func (Instance) SetRecoveryAsCollision ¶
SetRecoveryAsCollision sets the property returned by [IsRecoveryAsCollisionEnabled].
Source Files