Signal support.
class Signal2Use the connect(flags:_:) method to connect to the signal on the container object, and disconnect(_:) to drop the connection.
You can also await the emitted property for waiting for a single emission of the signal.
import SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
class Area3DA region of 3D space that detects other CollisionObject3Ds entering or exiting it.
@discardableResult func connect(flags: Object.ConnectFlags = [], _ callback: @escaping (_ bodyRid: RID, _ body: Node3D, _ bodyShapeIndex: Int64, _ localShapeIndex: Int64) -> ()) -> Object Connects the signal to the specified callback
func disconnect(_ token: Object) Disconnects a signal that was previously connected, the return value from calling connect(flags:_:)
var emitted: Void { get async }You can await this property to wait for the signal to be emitted once
override class var godotClassName: StringName { get }final var angularDamp: Double { get set }The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.
final var angularDampSpaceOverride: Area3D.SpaceOverride { get set }Override mode for angular damping calculations within this area. See SpaceOverride for possible values.
var areaEntered: Signal7 { get }Emitted when the received area enters this area. Requires monitoring to be set to true.
var areaExited: Signal8 { get }Emitted when the received area exits this area. Requires monitoring to be set to true.
var areaShapeEntered: Signal5 { get }Emitted when a Shape3D of the received area enters a shape of this area. Requires monitoring to be set to true.
var areaShapeExited: Signal6 { get }Emitted when a Shape3D of the received area exits a shape of this area. Requires monitoring to be set to true.
final var audioBusName: StringName { get set }The name of the area’s audio bus.
final var audioBusOverride: Bool { get set }If true, the area’s audio bus overrides the default audio bus.
var bodyEntered: Signal3 { get }Emitted when the received body enters this area. body can be a PhysicsBody3D or a GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires monitoring to be set to true.
var bodyExited: Signal4 { get }Emitted when the received body exits this area. body can be a PhysicsBody3D or a GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires monitoring to be set to true.
var bodyShapeEntered: Signal1 { get }Emitted when a Shape3D of the received body enters a shape of this area. body can be a PhysicsBody3D or a GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires monitoring to be set to true.
var bodyShapeExited: Signal2 { get }Emitted when a Shape3D of the received body exits a shape of this area. body can be a PhysicsBody3D or a GridMap. GridMaps are detected if their MeshLibrary has collision shapes configured. Requires monitoring to be set to true.
final var gravity: Double { get set }The area’s gravity intensity (in meters per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction.
final var gravityDirection: Vector3 { get set }The area’s gravity vector (not normalized).
final var gravityPoint: Bool { get set }If true, gravity is calculated from a point (set via gravityPointCenter). See also gravitySpaceOverride.
final var gravityPointCenter: Vector3 { get set }If gravity is a point (see gravityPoint), this will be the point of attraction.
final var gravityPointUnitDistance: Double { get set }The distance at which the gravity strength is equal to gravity. For example, on a planet 100 meters in radius with a surface gravity of 4.0 m/s², set the gravity to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 meters from the center the gravity will be 1.0 m/s² (twice the distance, 1/4th the gravity), at 50 meters it will be 16.0 m/s² (half the distance, 4x the gravity), and so on.
final var gravitySpaceOverride: Area3D.SpaceOverride { get set }Override mode for gravity calculations within this area. See SpaceOverride for possible values.
final var linearDamp: Double { get set }The rate at which objects stop moving in this area. Represents the linear velocity lost per second.
final var linearDampSpaceOverride: Area3D.SpaceOverride { get set }Override mode for linear damping calculations within this area. See SpaceOverride for possible values.
final var monitorable: Bool { get set }If true, other monitoring areas can detect this area.
final var monitoring: Bool { get set }If true, the area detects bodies or areas entering and exiting it.
final var priority: Int32 { get set }The area’s priority. Higher priority areas are processed first. The World3D’s physics is always processed last, after all areas.
final var reverbBusAmount: Double { get set }The degree to which this area applies reverb to its associated audio. Ranges from 0 to 1 with 0.1 precision.
final var reverbBusEnabled: Bool { get set }If true, the area applies reverb to its associated audio.
final var reverbBusName: StringName { get set }The name of the reverb bus to use for this area’s associated audio.
final var reverbBusUniformity: Double { get set }The degree to which this area’s reverb is a uniform effect. Ranges from 0 to 1 with 0.1 precision.
final var windAttenuationFactor: Double { get set }The exponential rate at which wind force decreases with distance from its origin.
final var windForceMagnitude: Double { get set }The magnitude of area-specific wind force.
final var windSourcePath: NodePath { get set }The Node3D which is used to specify the direction and origin of an area-specific wind force. The direction is opposite to the z-axis of the Node3D’s local transform, and its origin is the origin of the Node3D’s local transform.
final func getOverlappingAreas() -> ObjectCollection<Area3D> Returns a list of intersecting Area3Ds. The overlapping area’s collisionLayer must be part of this area’s collisionMask in order to be detected.
final func getOverlappingBodies() -> ObjectCollection<Node3D> Returns a list of intersecting PhysicsBody3Ds and GridMaps. The overlapping body’s collisionLayer must be part of this area’s collisionMask in order to be detected.
final func hasOverlappingAreas() -> Bool Returns true if intersecting any Area3Ds, otherwise returns false. The overlapping area’s collisionLayer must be part of this area’s collisionMask in order to be detected.
final func hasOverlappingBodies() -> Bool Returns true if intersecting any PhysicsBody3Ds or GridMaps, otherwise returns false. The overlapping body’s collisionLayer must be part of this area’s collisionMask in order to be detected.
final func overlapsArea(_ area: Node?) -> Bool Returns true if the given Area3D intersects or overlaps this Area3D, false otherwise.
final func overlapsBody(_ body: Node?) -> Bool Returns true if the given physics body intersects or overlaps this Area3D, false otherwise.
class Signal1Signal support.
class Signal3Signal support.
class Signal4Signal support.
class Signal5Signal support.
class Signal6Signal support.
class Signal7Signal support.
class Signal8Signal support.
enum SpaceOverride