Area3D

Documentation

Overview

Package Area3D provides methods for working with Area3D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AngularDamp() Float.X
  • func (self Instance) AngularDampSpaceOverride() gdclass.Area3DSpaceOverride
  • 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() [][1]gdclass.Area3D
  • func (self Instance) GetOverlappingBodies() [][1]gdclass.Node3D
  • 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() gdclass.Area3DSpaceOverride
  • func (self Instance) HasOverlappingAreas() bool
  • func (self Instance) HasOverlappingBodies() bool
  • func (self Instance) LinearDamp() Float.X
  • func (self Instance) LinearDampSpaceOverride() gdclass.Area3DSpaceOverride
  • func (self Instance) Monitorable() bool
  • func (self Instance) Monitoring() bool
  • func (self Instance) OnAreaEntered(cb func(area [1]gdclass.Area3D))
  • func (self Instance) OnAreaExited(cb func(area [1]gdclass.Area3D))
  • func (self Instance) OnAreaShapeEntered(cb func(area_rid RID.Any, area [1]gdclass.Area3D, area_shape_index int, ...))
  • func (self Instance) OnAreaShapeExited(cb func(area_rid RID.Any, area [1]gdclass.Area3D, area_shape_index int, ...))
  • func (self Instance) OnBodyEntered(cb func(body [1]gdclass.Node3D))
  • func (self Instance) OnBodyExited(cb func(body [1]gdclass.Node3D))
  • func (self Instance) OnBodyShapeEntered(cb func(body_rid RID.Any, body [1]gdclass.Node3D, body_shape_index int, ...))
  • func (self Instance) OnBodyShapeExited(cb func(body_rid RID.Any, body [1]gdclass.Node3D, body_shape_index int, ...))
  • func (self Instance) OverlapsArea(area [1]gdclass.Node) bool
  • func (self Instance) OverlapsBody(body [1]gdclass.Node) 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 gdclass.Area3DSpaceOverride)
  • 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 gdclass.Area3DSpaceOverride)
  • func (self Instance) SetLinearDamp(value Float.X)
  • func (self Instance) SetLinearDampSpaceOverride(value gdclass.Area3DSpaceOverride)
  • func (self Instance) SetMonitorable(value bool)
  • func (self Instance) SetMonitoring(value 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) UnsafePointer() unsafe.Pointer
  • 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

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

type Instance

type Instance [1]gdclass.Area3D

[Area3D] is a region of 3D space defined by one or multiple [CollisionShape3D] or [CollisionPolygon3D] child nodes. It detects when other [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. [b]Note:[/b] Areas and bodies created with [PhysicsServer3D] might not interact as expected with [Area3D]s, and might not emit signals or track objects correctly. [b]Warning:[/b] Using a [ConcavePolygonShape3D] inside a [CollisionShape3D] child of this node (created e.g. by using the [b]Create Trimesh Collision Sibling[/b] option in the [b]Mesh[/b] menu that appears when selecting a [MeshInstance3D] node) may give unexpected results, since this collision shape is hollow. If this is not desired, it has to be split into multiple [ConvexPolygonShape3D]s or primitive shapes like [BoxShape3D], or in some cases it may be replaceable by a [CollisionPolygon3D].

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AngularDamp

func (self Instance) AngularDamp() Float.X

func (Instance) AngularDampSpaceOverride

func (self Instance) AngularDampSpaceOverride() gdclass.Area3DSpaceOverride

func (Instance) AsArea3D

func (self Instance) AsArea3D() Instance

func (Instance) AsCollisionObject3D

func (self Instance) AsCollisionObject3D() CollisionObject3D.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) AudioBusName

func (self Instance) AudioBusName() string

func (Instance) AudioBusOverride

func (self Instance) AudioBusOverride() bool

func (Instance) GetOverlappingAreas

func (self Instance) GetOverlappingAreas() [][1]gdclass.Area3D

Returns a list of intersecting [Area3D]s. The overlapping area's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] 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

func (self Instance) GetOverlappingBodies() [][1]gdclass.Node3D

Returns a list of intersecting [PhysicsBody3D]s and [GridMap]s. The overlapping body's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] 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) Gravity

func (self Instance) Gravity() Float.X

func (Instance) GravityDirection

func (self Instance) GravityDirection() Vector3.XYZ

func (Instance) GravityPoint

func (self Instance) GravityPoint() bool

func (Instance) GravityPointCenter

func (self Instance) GravityPointCenter() Vector3.XYZ

func (Instance) GravityPointUnitDistance

func (self Instance) GravityPointUnitDistance() Float.X

func (Instance) GravitySpaceOverride

func (self Instance) GravitySpaceOverride() gdclass.Area3DSpaceOverride

func (Instance) HasOverlappingAreas

func (self Instance) HasOverlappingAreas() bool

Returns [code]true[/code] if intersecting any [Area3D]s, otherwise returns [code]false[/code]. The overlapping area's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] 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

func (self Instance) HasOverlappingBodies() bool

Returns [code]true[/code] if intersecting any [PhysicsBody3D]s or [GridMap]s, otherwise returns [code]false[/code]. The overlapping body's [member CollisionObject3D.collision_layer] must be part of this area's [member CollisionObject3D.collision_mask] 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 (self Instance) LinearDamp() Float.X

func (Instance) LinearDampSpaceOverride

func (self Instance) LinearDampSpaceOverride() gdclass.Area3DSpaceOverride

func (Instance) Monitorable

func (self Instance) Monitorable() bool

func (Instance) Monitoring

func (self Instance) Monitoring() bool

func (Instance) OnAreaEntered

func (self Instance) OnAreaEntered(cb func(area [1]gdclass.Area3D))

func (Instance) OnAreaExited

func (self Instance) OnAreaExited(cb func(area [1]gdclass.Area3D))

func (Instance) OnAreaShapeEntered

func (self Instance) OnAreaShapeEntered(cb func(area_rid RID.Any, area [1]gdclass.Area3D, area_shape_index int, local_shape_index int))

func (Instance) OnAreaShapeExited

func (self Instance) OnAreaShapeExited(cb func(area_rid RID.Any, area [1]gdclass.Area3D, area_shape_index int, local_shape_index int))

func (Instance) OnBodyEntered

func (self Instance) OnBodyEntered(cb func(body [1]gdclass.Node3D))

func (Instance) OnBodyExited

func (self Instance) OnBodyExited(cb func(body [1]gdclass.Node3D))

func (Instance) OnBodyShapeEntered

func (self Instance) OnBodyShapeEntered(cb func(body_rid RID.Any, body [1]gdclass.Node3D, body_shape_index int, local_shape_index int))

func (Instance) OnBodyShapeExited

func (self Instance) OnBodyShapeExited(cb func(body_rid RID.Any, body [1]gdclass.Node3D, body_shape_index int, local_shape_index int))

func (Instance) OverlapsArea

func (self Instance) OverlapsArea(area [1]gdclass.Node) bool

Returns [code]true[/code] if the given [Area3D] intersects or overlaps this [Area3D], [code]false[/code] otherwise. [b]Note:[/b] 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

func (self Instance) OverlapsBody(body [1]gdclass.Node) bool

Returns [code]true[/code] if the given physics body intersects or overlaps this [Area3D], [code]false[/code] otherwise. [b]Note:[/b] 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 [param body] argument can either be a [PhysicsBody3D] or a [GridMap] instance. While GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body.

func (Instance) Priority

func (self Instance) Priority() int

func (Instance) ReverbBusAmount

func (self Instance) ReverbBusAmount() Float.X

func (Instance) ReverbBusEnabled

func (self Instance) ReverbBusEnabled() bool

func (Instance) ReverbBusName

func (self Instance) ReverbBusName() string

func (Instance) ReverbBusUniformity

func (self Instance) ReverbBusUniformity() Float.X

func (Instance) SetAngularDamp

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

func (Instance) SetAngularDampSpaceOverride

func (self Instance) SetAngularDampSpaceOverride(value gdclass.Area3DSpaceOverride)

func (Instance) SetAudioBusName

func (self Instance) SetAudioBusName(value string)

func (Instance) SetAudioBusOverride

func (self Instance) SetAudioBusOverride(value bool)

func (Instance) SetGravity

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

func (Instance) SetGravityDirection

func (self Instance) SetGravityDirection(value Vector3.XYZ)

func (Instance) SetGravityPoint

func (self Instance) SetGravityPoint(value bool)

func (Instance) SetGravityPointCenter

func (self Instance) SetGravityPointCenter(value Vector3.XYZ)

func (Instance) SetGravityPointUnitDistance

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

func (Instance) SetGravitySpaceOverride

func (self Instance) SetGravitySpaceOverride(value gdclass.Area3DSpaceOverride)

func (Instance) SetLinearDamp

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

func (Instance) SetLinearDampSpaceOverride

func (self Instance) SetLinearDampSpaceOverride(value gdclass.Area3DSpaceOverride)

func (Instance) SetMonitorable

func (self Instance) SetMonitorable(value bool)

func (Instance) SetMonitoring

func (self Instance) SetMonitoring(value bool)

func (Instance) SetPriority

func (self Instance) SetPriority(value int)

func (Instance) SetReverbBusAmount

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

func (Instance) SetReverbBusEnabled

func (self Instance) SetReverbBusEnabled(value bool)

func (Instance) SetReverbBusName

func (self Instance) SetReverbBusName(value string)

func (Instance) SetReverbBusUniformity

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

func (Instance) SetWindAttenuationFactor

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

func (Instance) SetWindForceMagnitude

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

func (Instance) SetWindSourcePath

func (self Instance) SetWindSourcePath(value string)

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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

func (Instance) WindAttenuationFactor

func (self Instance) WindAttenuationFactor() Float.X

func (Instance) WindForceMagnitude

func (self Instance) WindForceMagnitude() Float.X

func (Instance) WindSourcePath

func (self Instance) WindSourcePath() string

type SpaceOverride

type SpaceOverride = gdclass.Area3DSpaceOverride //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 [member priority] order).*/
	SpaceOverrideCombine SpaceOverride = 1
	/*This area adds its gravity/damping values to whatever has been calculated so far (in [member 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 [member priority] order), but keeps calculating the rest of the areas.*/
	SpaceOverrideReplaceCombine SpaceOverride = 4
)