CollisionShape2D

Documentation

Overview

A node that provides a Shape2D to a CollisionObject2D parent and allows to edit it. This can give a detection shape to an Area2D or turn a PhysicsBody2D into a solid object.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
  • func (self *Extension[T]) AsCollisionShape2D() Instance
  • func (self *Extension[T]) AsNode() Node.Instance
  • func (self *Extension[T]) AsNode2D() Node2D.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsCanvasItem() CanvasItem.Instance
  • func (self Instance) AsCollisionShape2D() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode2D() Node2D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) DebugColor() Color.RGBA
  • func (self Instance) Disabled() bool
  • func (self Instance) ID() ID
  • func (self Instance) OneWayCollision() bool
  • func (self Instance) OneWayCollisionMargin() Float.X
  • func (self Instance) SetDebugColor(value Color.RGBA)
  • func (self Instance) SetDisabled(value bool)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetOneWayCollision(value bool)
  • func (self Instance) SetOneWayCollisionMargin(value Float.X)
  • func (self Instance) SetShape(value Shape2D.Instance)
  • func (self Instance) Shape() Shape2D.Instance
  • func (self Instance) Virtual(name string) reflect.Value

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
	AsCollisionShape2D() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsCanvasItem

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsCollisionShape2D

func (self *Extension[T]) AsCollisionShape2D() Instance

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode2D

func (self *Extension[T]) AsNode2D() Node2D.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.CollisionShape2D

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 New

func New() Instance

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsCollisionShape2D

func (self Instance) AsCollisionShape2D() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode2D

func (self Instance) AsNode2D() Node2D.Instance

func (Instance) AsObject

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

func (Instance) DebugColor

func (self Instance) DebugColor() Color.RGBA

The collision shape color that is displayed in the editor, or in the running project if Debug > Visible Collision Shapes is checked at the top of the editor.

Note: The default value is ProjectSettings "debug/shapes/collision/shape_color". The Color(0, 0, 0, 0) value documented here is a placeholder, and not the actual default debug color.

func (Instance) Disabled

func (self Instance) Disabled() bool

A disabled collision shape has no effect in the world. This property should be changed with Object.SetDeferred.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) OneWayCollision

func (self Instance) OneWayCollision() bool

Sets whether this collision shape should only detect collision on one side (top or bottom).

Note: This property has no effect if this CollisionShape2D is a child of an Area2D node.

func (Instance) OneWayCollisionMargin

func (self Instance) OneWayCollisionMargin() Float.X

The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity.

func (Instance) SetDebugColor

func (self Instance) SetDebugColor(value Color.RGBA)

SetDebugColor sets the property returned by [GetDebugColor].

func (Instance) SetDisabled

func (self Instance) SetDisabled(value bool)

SetDisabled sets the property returned by [IsDisabled].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetOneWayCollision

func (self Instance) SetOneWayCollision(value bool)

SetOneWayCollision sets the property returned by [IsOneWayCollisionEnabled].

func (Instance) SetOneWayCollisionMargin

func (self Instance) SetOneWayCollisionMargin(value Float.X)

SetOneWayCollisionMargin sets the property returned by [GetOneWayCollisionMargin].

func (Instance) SetShape

func (self Instance) SetShape(value Shape2D.Instance)

SetShape sets the property returned by [GetShape].

func (Instance) Shape

func (self Instance) Shape() Shape2D.Instance

The actual shape owned by this collision shape.

func (Instance) Virtual

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