Documentation
¶
Overview ¶
graphics.gd/classdb/Area3D is a region of 3D space defined by one or multiple graphics.gd/classdb/CollisionShape3D or graphics.gd/classdb/CollisionPolygon3D child nodes. It detects when other [graphics.gd/classdb/CollisionObject3D]s enter or exit it, and it also keeps track of which collision objects haven't exited it yet (i.e. which one are overlapping it).
This node can also locally alter or override physics parameters (gravity, damping) and route audio to custom audio buses.
Note: Areas and bodies created with graphics.gd/classdb/PhysicsServer3D might not interact as expected with [graphics.gd/classdb/Area3D]s, and might not emit signals or track objects correctly.
Warning: Using a graphics.gd/classdb/ConcavePolygonShape3D inside a graphics.gd/classdb/CollisionShape3D child of this node (created e.g. by using the Create Trimesh Collision Sibling option in the Mesh menu that appears when selecting a graphics.gd/classdb/MeshInstance3D node) may give unexpected results, since this collision shape is hollow. If this is not desired, it has to be split into multiple [graphics.gd/classdb/ConvexPolygonShape3D]s or primitive shapes like graphics.gd/classdb/BoxShape3D, or in some cases it may be replaceable by a graphics.gd/classdb/CollisionPolygon3D.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AngularDamp() Float.X
- func (self Instance) AngularDampSpaceOverride() SpaceOverride
- func (self Instance) AsArea3D() Instance
- func (self Instance) AsCollisionObject3D() CollisionObject3D.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AudioBusName() string
- func (self Instance) AudioBusOverride() bool
- func (self Instance) GetOverlappingAreas() []Instance
- func (self Instance) GetOverlappingBodies() []Node3D.Instance
- func (self Instance) Gravity() Float.X
- func (self Instance) GravityDirection() Vector3.XYZ
- func (self Instance) GravityPoint() bool
- func (self Instance) GravityPointCenter() Vector3.XYZ
- func (self Instance) GravityPointUnitDistance() Float.X
- func (self Instance) GravitySpaceOverride() SpaceOverride
- func (self Instance) HasOverlappingAreas() bool
- func (self Instance) HasOverlappingBodies() bool
- func (self Instance) ID() ID
- func (self Instance) LinearDamp() Float.X
- func (self Instance) LinearDampSpaceOverride() SpaceOverride
- func (self Instance) Monitorable() bool
- func (self Instance) Monitoring() bool
- func (self Instance) OnAreaEntered(cb func(area Instance), flags ...Signal.Flags)
- func (self Instance) OnAreaExited(cb func(area Instance), flags ...Signal.Flags)
- func (self Instance) OnAreaShapeEntered(...)
- func (self Instance) OnAreaShapeExited(...)
- func (self Instance) OnBodyEntered(cb func(body Node3D.Instance), flags ...Signal.Flags)
- func (self Instance) OnBodyExited(cb func(body Node3D.Instance), flags ...Signal.Flags)
- func (self Instance) OnBodyShapeEntered(cb func(body_rid RID.Any, body Node3D.Instance, body_shape_index int, ...), ...)
- func (self Instance) OnBodyShapeExited(cb func(body_rid RID.Any, body Node3D.Instance, body_shape_index int, ...), ...)
- func (self Instance) OverlapsArea(area Node.Instance) bool
- func (self Instance) OverlapsBody(body Node.Instance) bool
- func (self Instance) Priority() int
- func (self Instance) ReverbBusAmount() Float.X
- func (self Instance) ReverbBusEnabled() bool
- func (self Instance) ReverbBusName() string
- func (self Instance) ReverbBusUniformity() Float.X
- func (self Instance) SetAngularDamp(value Float.X)
- func (self Instance) SetAngularDampSpaceOverride(value SpaceOverride)
- func (self Instance) SetAudioBusName(value string)
- func (self Instance) SetAudioBusOverride(value bool)
- func (self Instance) SetGravity(value Float.X)
- func (self Instance) SetGravityDirection(value Vector3.XYZ)
- func (self Instance) SetGravityPoint(value bool)
- func (self Instance) SetGravityPointCenter(value Vector3.XYZ)
- func (self Instance) SetGravityPointUnitDistance(value Float.X)
- func (self Instance) SetGravitySpaceOverride(value SpaceOverride)
- func (self Instance) SetLinearDamp(value Float.X)
- func (self Instance) SetLinearDampSpaceOverride(value SpaceOverride)
- func (self Instance) SetMonitorable(value bool)
- func (self Instance) SetMonitoring(value bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPriority(value int)
- func (self Instance) SetReverbBusAmount(value Float.X)
- func (self Instance) SetReverbBusEnabled(value bool)
- func (self Instance) SetReverbBusName(value string)
- func (self Instance) SetReverbBusUniformity(value Float.X)
- func (self Instance) SetWindAttenuationFactor(value Float.X)
- func (self Instance) SetWindForceMagnitude(value Float.X)
- func (self Instance) SetWindSourcePath(value string)
- func (self Instance) Virtual(name string) reflect.Value
- func (self Instance) WindAttenuationFactor() Float.X
- func (self Instance) WindForceMagnitude() Float.X
- func (self Instance) WindSourcePath() string
- type SpaceOverride
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]) AsCollisionObject3D ¶
func (self *Extension[T]) AsCollisionObject3D() CollisionObject3D.Instance
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 ¶
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) AngularDamp ¶
func (Instance) AngularDampSpaceOverride ¶
func (self Instance) AngularDampSpaceOverride() SpaceOverride
func (Instance) AsCollisionObject3D ¶
func (self Instance) AsCollisionObject3D() CollisionObject3D.Instance
func (Instance) AudioBusName ¶
func (Instance) AudioBusOverride ¶
func (Instance) GetOverlappingAreas ¶
Returns a list of intersecting [graphics.gd/classdb/Area3D]s. The overlapping area's graphics.gd/classdb/CollisionObject3D.Instance.CollisionLayer must be part of this area's graphics.gd/classdb/CollisionObject3D.Instance.CollisionMask in order to be detected.
For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
func (Instance) GetOverlappingBodies ¶
Returns a list of intersecting [graphics.gd/classdb/PhysicsBody3D]s and [graphics.gd/classdb/GridMap]s. The overlapping body's graphics.gd/classdb/CollisionObject3D.Instance.CollisionLayer must be part of this area's graphics.gd/classdb/CollisionObject3D.Instance.CollisionMask in order to be detected.
For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
func (Instance) GravityDirection ¶
func (Instance) GravityPoint ¶
func (Instance) GravityPointCenter ¶
func (Instance) GravityPointUnitDistance ¶
func (Instance) GravitySpaceOverride ¶
func (self Instance) GravitySpaceOverride() SpaceOverride
func (Instance) HasOverlappingAreas ¶
Returns true if intersecting any [graphics.gd/classdb/Area3D]s, otherwise returns false. The overlapping area's graphics.gd/classdb/CollisionObject3D.Instance.CollisionLayer must be part of this area's graphics.gd/classdb/CollisionObject3D.Instance.CollisionMask in order to be detected.
For performance reasons (collisions are all processed at the same time) the list of overlapping areas is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
func (Instance) HasOverlappingBodies ¶
Returns true if intersecting any [graphics.gd/classdb/PhysicsBody3D]s or [graphics.gd/classdb/GridMap]s, otherwise returns false. The overlapping body's graphics.gd/classdb/CollisionObject3D.Instance.CollisionLayer must be part of this area's graphics.gd/classdb/CollisionObject3D.Instance.CollisionMask in order to be detected.
For performance reasons (collisions are all processed at the same time) the list of overlapping bodies is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
func (Instance) LinearDamp ¶
func (Instance) LinearDampSpaceOverride ¶
func (self Instance) LinearDampSpaceOverride() SpaceOverride
func (Instance) Monitorable ¶
func (Instance) Monitoring ¶
func (Instance) OnAreaEntered ¶
func (Instance) OnAreaExited ¶
func (Instance) OnAreaShapeEntered ¶
func (Instance) OnAreaShapeExited ¶
func (Instance) OnBodyEntered ¶
func (Instance) OnBodyExited ¶
func (Instance) OnBodyShapeEntered ¶
func (Instance) OnBodyShapeExited ¶
func (Instance) OverlapsArea ¶
Returns true if the given graphics.gd/classdb/Area3D intersects or overlaps this graphics.gd/classdb/Area3D, false otherwise.
Note: The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
func (Instance) OverlapsBody ¶
Returns true if the given physics body intersects or overlaps this graphics.gd/classdb/Area3D, false otherwise.
Note: The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
The 'body' argument can either be a graphics.gd/classdb/PhysicsBody3D or a graphics.gd/classdb/GridMap instance. While GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body.
func (Instance) ReverbBusAmount ¶
func (Instance) ReverbBusEnabled ¶
func (Instance) ReverbBusName ¶
func (Instance) ReverbBusUniformity ¶
func (Instance) SetAngularDamp ¶
func (Instance) SetAngularDampSpaceOverride ¶
func (self Instance) SetAngularDampSpaceOverride(value SpaceOverride)
func (Instance) SetAudioBusName ¶
func (Instance) SetAudioBusOverride ¶
func (Instance) SetGravity ¶
func (Instance) SetGravityDirection ¶
func (Instance) SetGravityPoint ¶
func (Instance) SetGravityPointCenter ¶
func (Instance) SetGravityPointUnitDistance ¶
func (Instance) SetGravitySpaceOverride ¶
func (self Instance) SetGravitySpaceOverride(value SpaceOverride)
func (Instance) SetLinearDamp ¶
func (Instance) SetLinearDampSpaceOverride ¶
func (self Instance) SetLinearDampSpaceOverride(value SpaceOverride)
func (Instance) SetMonitorable ¶
func (Instance) SetMonitoring ¶
func (Instance) SetPriority ¶
func (Instance) SetReverbBusAmount ¶
func (Instance) SetReverbBusEnabled ¶
func (Instance) SetReverbBusName ¶
func (Instance) SetReverbBusUniformity ¶
func (Instance) SetWindAttenuationFactor ¶
func (Instance) SetWindForceMagnitude ¶
func (Instance) SetWindSourcePath ¶
func (Instance) WindAttenuationFactor ¶
func (Instance) WindForceMagnitude ¶
func (Instance) WindSourcePath ¶
type SpaceOverride ¶
type SpaceOverride int //gd:Area3D.SpaceOverride
const ( // This area does not affect gravity/damping. SpaceOverrideDisabled SpaceOverride = 0 // This area adds its gravity/damping values to whatever has been calculated so far (in [Instance.Priority] order). SpaceOverrideCombine SpaceOverride = 1 // This area adds its gravity/damping values to whatever has been calculated so far (in [Instance.Priority] order), ignoring any lower priority areas. SpaceOverrideCombineReplace SpaceOverride = 2 // This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. SpaceOverrideReplace SpaceOverride = 3 // This area replaces any gravity/damping calculated so far (in [Instance.Priority] order), but keeps calculating the rest of the areas. SpaceOverrideReplaceCombine SpaceOverride = 4 )
Source Files