CollisionObject3D

package
v0.0.0-...-e1beaa7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2025 License: MIT Imports: 29 Imported by: 0

Documentation

Overview

Abstract base class for 3D physics objects. graphics.gd/classdb/CollisionObject3D can hold any number of [graphics.gd/classdb/Shape3D]s for collision. Each shape must be assigned to a shape owner. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the shape_owner_* methods.

Warning: With a non-uniform scale, this node will likely not behave as expected. It is advised to keep its scale the same on all axes and adjust its collision shape(s) instead.

Index

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 Any 

type Any interface {
	gd.IsClass
	AsCollisionObject3D() Instance
}

type DisableMode 

type DisableMode int //gd:CollisionObject3D.DisableMode

const (
	// When [graphics.gd/classdb/Node.Instance.ProcessMode] is set to [Node.ProcessModeDisabled], remove from the physics simulation to stop all physics interactions with this [graphics.gd/classdb/CollisionObject3D].
	//
	// Automatically re-added to the physics simulation when the [graphics.gd/classdb/Node] is processed again.
	DisableModeRemove DisableMode = 0
	// When [graphics.gd/classdb/Node.Instance.ProcessMode] is set to [Node.ProcessModeDisabled], make the body static. Doesn't affect [graphics.gd/classdb/Area3D]. [graphics.gd/classdb/PhysicsBody3D] can't be affected by forces or other bodies while static.
	//
	// Automatically set [graphics.gd/classdb/PhysicsBody3D] back to its original mode when the [graphics.gd/classdb/Node] is processed again.
	DisableModeMakeStatic DisableMode = 1
	// When [graphics.gd/classdb/Node.Instance.ProcessMode] is set to [Node.ProcessModeDisabled], do not affect the physics simulation.
	DisableModeKeepActive DisableMode = 2
)

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]See Interface for methods that can be overridden by T.

func (*Extension[T]) AsCollisionObject3D 

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

func (*Extension[T]) AsNode 

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

func (*Extension[T]) AsNode3D 

func (self *Extension[T]) AsNode3D() Node3D.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 Implementation 

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance 

type Instance [1]gdclass.CollisionObject3D

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

func (self Instance) AsCollisionObject3D() Instance

func (Instance) AsNode 

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D 

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject 

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

func (Instance) CollisionLayer 

func (self Instance) CollisionLayer() int

func (Instance) CollisionMask 

func (self Instance) CollisionMask() int

func (Instance) CollisionPriority 

func (self Instance) CollisionPriority() Float.X

func (Instance) CreateShapeOwner 

func (self Instance) CreateShapeOwner(owner Object.Instance) int

Creates a new shape owner for the given object. Returns owner_id of the new owner for future reference.

func (Instance) DisableMode 

func (self Instance) DisableMode() DisableMode

func (Instance) GetCollisionLayerValue 

func (self Instance) GetCollisionLayerValue(layer_number int) bool

Returns whether or not the specified layer of the Instance.CollisionLayer is enabled, given a 'layer_number' between 1 and 32.

func (Instance) GetCollisionMaskValue 

func (self Instance) GetCollisionMaskValue(layer_number int) bool

Returns whether or not the specified layer of the Instance.CollisionMask is enabled, given a 'layer_number' between 1 and 32.

func (Instance) GetRid 

func (self Instance) GetRid() RID.Body3D

Returns the object's [Resource.ID].

func (Instance) GetShapeOwners 

func (self Instance) GetShapeOwners() []int32

Returns an slice of owner_id identifiers. You can use these ids in other methods that take owner_id as an argument.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) InputCaptureOnDrag 

func (self Instance) InputCaptureOnDrag() bool

func (Instance) InputRayPickable 

func (self Instance) InputRayPickable() bool

func (Instance) IsShapeOwnerDisabled 

func (self Instance) IsShapeOwnerDisabled(owner_id int) bool

If true, the shape owner and its shapes are disabled.

func (Instance) OnInputEvent 

func (self Instance) OnInputEvent(cb func(camera Node.Instance, event InputEvent.Instance, event_position Vector3.XYZ, normal Vector3.XYZ, shape_idx int), flags ...Signal.Flags)

func (Instance) OnMouseEntered 

func (self Instance) OnMouseEntered(cb func(), flags ...Signal.Flags)

func (Instance) OnMouseExited 

func (self Instance) OnMouseExited(cb func(), flags ...Signal.Flags)

func (Instance) RemoveShapeOwner 

func (self Instance) RemoveShapeOwner(owner_id int)

Removes the given shape owner.

func (Instance) SetCollisionLayer 

func (self Instance) SetCollisionLayer(value int)

func (Instance) SetCollisionLayerValue 

func (self Instance) SetCollisionLayerValue(layer_number int, value bool)

Based on 'value', enables or disables the specified layer in the Instance.CollisionLayer, given a 'layer_number' between 1 and 32.

func (Instance) SetCollisionMask 

func (self Instance) SetCollisionMask(value int)

func (Instance) SetCollisionMaskValue 

func (self Instance) SetCollisionMaskValue(layer_number int, value bool)

Based on 'value', enables or disables the specified layer in the Instance.CollisionMask, given a 'layer_number' between 1 and 32.

func (Instance) SetCollisionPriority 

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

func (Instance) SetDisableMode 

func (self Instance) SetDisableMode(value DisableMode)

func (Instance) SetInputCaptureOnDrag 

func (self Instance) SetInputCaptureOnDrag(value bool)

func (Instance) SetInputRayPickable 

func (self Instance) SetInputRayPickable(value bool)

func (*Instance) SetObject 

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

func (Instance) ShapeFindOwner 

func (self Instance) ShapeFindOwner(shape_index int) int

Returns the owner_id of the given shape.

func (Instance) ShapeOwnerAddShape 

func (self Instance) ShapeOwnerAddShape(owner_id int, shape Shape3D.Instance)

Adds a graphics.gd/classdb/Shape3D to the shape owner.

func (Instance) ShapeOwnerClearShapes 

func (self Instance) ShapeOwnerClearShapes(owner_id int)

Removes all shapes from the shape owner.

func (Instance) ShapeOwnerGetOwner 

func (self Instance) ShapeOwnerGetOwner(owner_id int) Object.Instance

Returns the parent object of the given shape owner.

func (Instance) ShapeOwnerGetShape 

func (self Instance) ShapeOwnerGetShape(owner_id int, shape_id int) Shape3D.Instance

Returns the graphics.gd/classdb/Shape3D with the given ID from the given shape owner.

func (Instance) ShapeOwnerGetShapeCount 

func (self Instance) ShapeOwnerGetShapeCount(owner_id int) int

Returns the number of shapes the given shape owner contains.

func (Instance) ShapeOwnerGetShapeIndex 

func (self Instance) ShapeOwnerGetShapeIndex(owner_id int, shape_id int) int

Returns the child index of the graphics.gd/classdb/Shape3D with the given ID from the given shape owner.

func (Instance) ShapeOwnerGetTransform 

func (self Instance) ShapeOwnerGetTransform(owner_id int) Transform3D.BasisOrigin

Returns the shape owner's [Transform3D.BasisOrigin].

func (Instance) ShapeOwnerRemoveShape 

func (self Instance) ShapeOwnerRemoveShape(owner_id int, shape_id int)

Removes a shape from the given shape owner.

func (Instance) ShapeOwnerSetDisabled 

func (self Instance) ShapeOwnerSetDisabled(owner_id int, disabled bool)

If true, disables the given shape owner.

func (Instance) ShapeOwnerSetTransform 

func (self Instance) ShapeOwnerSetTransform(owner_id int, transform Transform3D.BasisOrigin)

Sets the [Transform3D.BasisOrigin] of the given shape owner.

func (Instance) Virtual 

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

type Interface 

type Interface interface {
	// Receives unhandled [graphics.gd/classdb/InputEvent]s. 'event_position' is the location in world space of the mouse pointer on the surface of the shape with index 'shape_idx' and 'normal' is the normal vector of the surface at that point. Connect to the [Instance.OnInputEvent] signal to easily pick up these events.
	//
	// Note: [Interface.InputEvent] requires [Instance.InputRayPickable] to be true and at least one [Instance.CollisionLayer] bit to be set.
	InputEvent(camera Camera3D.Instance, event InputEvent.Instance, event_position Vector3.XYZ, normal Vector3.XYZ, shape_idx int)
	// Called when the mouse pointer enters any of this object's shapes. Requires [Instance.InputRayPickable] to be true and at least one [Instance.CollisionLayer] bit to be set. Note that moving between different shapes within a single [graphics.gd/classdb/CollisionObject3D] won't cause this function to be called.
	MouseEnter()
	// Called when the mouse pointer exits all this object's shapes. Requires [Instance.InputRayPickable] to be true and at least one [Instance.CollisionLayer] bit to be set. Note that moving between different shapes within a single [graphics.gd/classdb/CollisionObject3D] won't cause this function to be called.
	MouseExit()
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.