Documentation
¶
Overview ¶
A node that provides a thickened polygon shape (a prism) to a CollisionObject3D parent and allows to edit it. The polygon can be concave or convex. This can give a detection shape to an Area3D or turn PhysicsBody3D into a solid object.
Warning: A non-uniformly scaled CollisionShape3D will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its shape resource instead.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsCollisionPolygon3D() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) DebugColor() Color.RGBA
- func (self Instance) DebugFill() bool
- func (self Instance) Depth() Float.X
- func (self Instance) Disabled() bool
- func (self Instance) ID() ID
- func (self Instance) Margin() Float.X
- func (self Instance) Polygon() []Vector2.XY
- func (self Instance) SetDebugColor(value Color.RGBA)
- func (self Instance) SetDebugFill(value bool)
- func (self Instance) SetDepth(value Float.X)
- func (self Instance) SetDisabled(value bool)
- func (self Instance) SetMargin(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPolygon(value []Vector2.XY)
- 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]) AsCollisionPolygon3D ¶
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.CollisionPolygon3D
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) AsCollisionPolygon3D ¶
func (Instance) DebugColor ¶
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) DebugFill ¶
If true, when the shape is displayed, it will show a solid fill color in addition to its wireframe.
func (Instance) Depth ¶
Length that the resulting collision extends in either direction perpendicular to its 2D polygon.
func (Instance) Disabled ¶
If true, no collision will be produced. This property should be changed with Object.SetDeferred.
func (Instance) Margin ¶
The collision margin for the generated Shape3D. See Shape3D.Margin for more details.
func (Instance) SetDebugColor ¶
SetDebugColor sets the property returned by [GetDebugColor].
func (Instance) SetDebugFill ¶
SetDebugFill sets the property returned by [GetEnableDebugFill].
func (Instance) SetDisabled ¶
SetDisabled sets the property returned by [IsDisabled].
func (Instance) SetPolygon ¶
SetPolygon sets the property returned by [GetPolygon].
Source Files