CollisionPolygon2D

Documentation

Overview

Package CollisionPolygon2D provides methods for working with CollisionPolygon2D object instances.

Index

• type Advanced
• type Any
• type BuildMode
• type Instance
  • func New() Instance
  • func (self Instance) AsCanvasItem() CanvasItem.Instance
  • func (self Instance) AsCollisionPolygon2D() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode2D() Node2D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) BuildMode() gdclass.CollisionPolygon2DBuildMode
  • func (self Instance) Disabled() bool
  • func (self Instance) OneWayCollision() bool
  • func (self Instance) OneWayCollisionMargin() Float.X
  • func (self Instance) Polygon() []Vector2.XY
  • func (self Instance) SetBuildMode(value gdclass.CollisionPolygon2DBuildMode)
  • func (self Instance) SetDisabled(value bool)
  • func (self Instance) SetOneWayCollision(value bool)
  • func (self Instance) SetOneWayCollisionMargin(value Float.X)
  • func (self Instance) SetPolygon(value []Vector2.XY)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • 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
	AsCollisionPolygon2D() Instance
}

type BuildMode

type BuildMode = gdclass.CollisionPolygon2DBuildMode //gd:CollisionPolygon2D.BuildMode

const (
	/*Collisions will include the polygon and its contained area. In this mode the node has the same effect as several [ConvexPolygonShape2D] nodes, one for each convex shape in the convex decomposition of the polygon (but without the overhead of multiple nodes).*/
	BuildSolids BuildMode = 0
	/*Collisions will only include the polygon edges. In this mode the node has the same effect as a single [ConcavePolygonShape2D] made of segments, with the restriction that each segment (after the first one) starts where the previous one ends, and the last one ends where the first one starts (forming a closed but hollow polygon).*/
	BuildSegments BuildMode = 1
)

type Instance

type Instance [1]gdclass.CollisionPolygon2D

A node that provides a polygon shape to a [CollisionObject2D] parent and allows to edit it. The polygon can be concave or convex. This can give a detection shape to an [Area2D], turn [PhysicsBody2D] into a solid object, or give a hollow shape to a [StaticBody2D]. [b]Warning:[/b] A non-uniformly scaled [CollisionShape2D] will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its shape resource instead.

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) AsCollisionPolygon2D

func (self Instance) AsCollisionPolygon2D() 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) BuildMode

func (self Instance) BuildMode() gdclass.CollisionPolygon2DBuildMode

func (Instance) Disabled

func (self Instance) Disabled() bool

func (Instance) OneWayCollision

func (self Instance) OneWayCollision() bool

func (Instance) OneWayCollisionMargin

func (self Instance) OneWayCollisionMargin() Float.X

func (Instance) Polygon

func (self Instance) Polygon() []Vector2.XY

func (Instance) SetBuildMode

func (self Instance) SetBuildMode(value gdclass.CollisionPolygon2DBuildMode)

func (Instance) SetDisabled

func (self Instance) SetDisabled(value bool)

func (Instance) SetOneWayCollision

func (self Instance) SetOneWayCollision(value bool)

func (Instance) SetOneWayCollisionMargin

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

func (Instance) SetPolygon

func (self Instance) SetPolygon(value []Vector2.XY)

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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