- _areaEnterTree
void _areaEnterTree(long id)
- _areaExitTree
void _areaExitTree(long id)
- _areaInout
void _areaInout(long arg0, RID arg1, long arg2, long arg3, long arg4)
- _bodyEnterTree
void _bodyEnterTree(long id)
- _bodyExitTree
void _bodyExitTree(long id)
- _bodyInout
void _bodyInout(long arg0, RID arg1, long arg2, long arg3, long arg4)
- getAngularDamp
double getAngularDamp()
- getAudioBus
String getAudioBus()
- getCollisionLayer
long getCollisionLayer()
- getCollisionLayerBit
bool getCollisionLayerBit(long bit)
Returns an individual bit on the layer mask.
- getCollisionMask
long getCollisionMask()
- getCollisionMaskBit
bool getCollisionMaskBit(long bit)
Returns an individual bit on the collision mask.
- getGravity
double getGravity()
- getGravityDistanceScale
double getGravityDistanceScale()
- getGravityVector
Vector3 getGravityVector()
- getLinearDamp
double getLinearDamp()
- getOverlappingAreas
Array getOverlappingAreas()
Returns a list of intersecting Areas. 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.
- getOverlappingBodies
Array getOverlappingBodies()
Returns a list of intersecting PhysicsBodys. 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.
- getPriority
double getPriority()
- getReverbAmount
double getReverbAmount()
- getReverbBus
String getReverbBus()
- getReverbUniformity
double getReverbUniformity()
- getSpaceOverrideMode
Area.SpaceOverride getSpaceOverrideMode()
- isGravityAPoint
bool isGravityAPoint()
- isMonitorable
bool isMonitorable()
- isMonitoring
bool isMonitoring()
- isOverridingAudioBus
bool isOverridingAudioBus()
- isUsingReverbBus
bool isUsingReverbBus()
- opAssign
Area opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
- opEquals
bool opEquals(Area other)
Undocumented in source. Be warned that the author may not have intended to support it.
- opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
- overlapsArea
bool overlapsArea(GodotObject area)
If true the given area overlaps the Area. Note that 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.
- overlapsBody
bool overlapsBody(GodotObject _body)
If true the given body overlaps the Area. Note that 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.
- setAngularDamp
void setAngularDamp(double angular_damp)
- setAudioBus
void setAudioBus(StringArg0 name)
- setAudioBusOverride
void setAudioBusOverride(bool enable)
- setCollisionLayer
void setCollisionLayer(long collision_layer)
- setCollisionLayerBit
void setCollisionLayerBit(long bit, bool value)
Set/clear individual bits on the layer mask. This simplifies editing this codeAreacode's layers.
- setCollisionMask
void setCollisionMask(long collision_mask)
- setCollisionMaskBit
void setCollisionMaskBit(long bit, bool value)
Set/clear individual bits on the collision mask. This simplifies editing which Area layers this Area scans.
- setGravity
void setGravity(double gravity)
- setGravityDistanceScale
void setGravityDistanceScale(double distance_scale)
- setGravityIsPoint
void setGravityIsPoint(bool enable)
- setGravityVector
void setGravityVector(Vector3 vector)
- setLinearDamp
void setLinearDamp(double linear_damp)
- setMonitorable
void setMonitorable(bool enable)
- setMonitoring
void setMonitoring(bool enable)
- setPriority
void setPriority(double priority)
- setReverbAmount
void setReverbAmount(double amount)
- setReverbBus
void setReverbBus(StringArg0 name)
- setReverbUniformity
void setReverbUniformity(double amount)
- setSpaceOverrideMode
void setSpaceOverrideMode(long enable)
- setUseReverbBus
void setUseReverbBus(bool enable)
- angularDamp
double angularDamp [@property getter]
double angularDamp [@property setter]
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from 0 (no damping) to 1 (full damping).
- audioBusName
String audioBusName [@property getter]
String audioBusName [@property setter]
The name of the area's audio bus.
- audioBusOverride
bool audioBusOverride [@property getter]
bool audioBusOverride [@property setter]
If true the area's audio bus overrides the default audio bus. Default value: false.
- collisionLayer
long collisionLayer [@property getter]
long collisionLayer [@property setter]
The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also collision_mask.
- collisionMask
long collisionMask [@property getter]
long collisionMask [@property setter]
The physics layers this area scans to determine collision detection.
- gravity
double gravity [@property getter]
double gravity [@property setter]
The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
- gravityDistanceScale
double gravityDistanceScale [@property getter]
double gravityDistanceScale [@property setter]
The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
- gravityPoint
bool gravityPoint [@property getter]
bool gravityPoint [@property setter]
If true gravity is calculated from a point (set via gravity_vec). Also see space_override. Default value: false.
- gravityVec
Vector3 gravityVec [@property getter]
Vector3 gravityVec [@property setter]
The area's gravity vector (not normalized). If gravity is a point (see isGravityAPoint), this will be the point of attraction.
- linearDamp
double linearDamp [@property getter]
double linearDamp [@property setter]
The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from 0 (no damping) to 1 (full damping).
- monitorable
bool monitorable [@property getter]
bool monitorable [@property setter]
If true other monitoring areas can detect this area. Default value: true.
- monitoring
bool monitoring [@property getter]
bool monitoring [@property setter]
If true the area detects bodies or areas entering and exiting it. Default value: true.
- priority
double priority [@property getter]
double priority [@property setter]
The area's priority. Higher priority areas are processed first. Default value: 0.
- reverbBusAmount
double reverbBusAmount [@property getter]
double reverbBusAmount [@property setter]
The degree to which this area applies reverb to its associated audio. Ranges from 0 to 1 with 0.1 precision.
- reverbBusEnable
bool reverbBusEnable [@property getter]
bool reverbBusEnable [@property setter]
If true the area applies reverb to its associated audio.
- reverbBusName
String reverbBusName [@property getter]
String reverbBusName [@property setter]
The reverb bus name to use for this area's associated audio.
- reverbBusUniformity
double reverbBusUniformity [@property getter]
double reverbBusUniformity [@property setter]
The degree to which this area's reverb is a uniform effect. Ranges from 0 to 1 with 0.1 precision.
- spaceOverride
Area.SpaceOverride spaceOverride [@property getter]
long spaceOverride [@property setter]
Override mode for gravity and damping calculations within this area. See the SPACE_OVERRIDE_* constants for values.
General purpose area node for detection and 3D physics influence.
3D area that detects CollisionObject nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping).