Area2D class

Inheritance
Available extensions

Constructors

Area2D()
Area2D.withNonNullOwner(Pointer<Void> owner)

Properties

areaEntered Signal1<Area2D?>
latefinal
areaExited Signal1<Area2D?>
latefinal
areaShapeEntered Signal4<RID, Area2D?, int, int>
latefinal
areaShapeExited Signal4<RID, Area2D?, int, int>
latefinal
bodyEntered Signal1<Node2D?>
latefinal
bodyExited Signal1<Node2D?>
latefinal
bodyShapeEntered Signal4<RID, Node2D?, int, int>
latefinal
bodyShapeExited Signal4<RID, Node2D?, int, int>
latefinal
childEnteredTree Signal1<Node?>
latefinalinherited
childExitingTree Signal1<Node?>
latefinalinherited
childOrderChanged Signal0
latefinalinherited
draw Signal0
latefinalinherited
editorDescriptionChanged Signal1<Node?>
latefinalinherited
hashCode int
The hash code for this object.
no setterinherited
hidden Signal0
latefinalinherited
inputEvent Signal3<Node?, InputEvent?, int>
latefinalinherited
itemRectChanged Signal0
latefinalinherited
mouseEntered Signal0
latefinalinherited
mouseExited Signal0
latefinalinherited
mouseShapeEntered Signal1<int>
latefinalinherited
mouseShapeExited Signal1<int>
latefinalinherited
nativePointerAddress int
Since Pointer.address isn's tagged 'vm:entry-point', supply an entry point that can get the raw pointer address for this object
no setterinherited
nativePtr → GDExtensionObjectPtr
no setterinherited
propertyListChanged Signal0
latefinalinherited
ready Signal0
latefinalinherited
renamed Signal0
latefinalinherited
replacingBy Signal1<Node?>
latefinalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scriptChanged Signal0
latefinalinherited
treeEntered Signal0
latefinalinherited
treeExited Signal0
latefinalinherited
treeExiting Signal0
latefinalinherited
typeInfo ExtensionTypeInfo<Area2D>
no setteroverride
visibilityChanged Signal0
latefinalinherited

Methods

addChild(Node? node, {bool forceReadableName = false, NodeInternalMode? internal}) → void
inherited
addSibling(Node? sibling, {bool forceReadableName = false}) → void
inherited
addToGroup(String group, {bool persistent = false}) → void
inherited
addUserSignal(String signal, {Array? arguments}) → void
inherited
applyScale(Vector2 ratio) → void
inherited
as<T>() → T?

Available on GodotObject, provided by the GodotObjectCast extension

atr(String message, {String context = ''}) String
inherited
atrN(String message, String pluralMessage, int n, {String context = ''}) String
inherited
attachSignal(SignalCallable signal) → void
inherited
call(String method, {List<Variant> vargs = const []}) Variant
inherited
callDeferred(String method, {List<Variant> vargs = const []}) Variant
inherited
callDeferredThreadGroup(String method, {List<Variant> vargs = const []}) Variant
inherited
callThreadSafe(String method, {List<Variant> vargs = const []}) Variant
inherited
callv(String method, Array argArray) Variant
inherited
cancelFree() → void
inherited
canProcess() bool
inherited
canTranslateMessages() bool
inherited
connect(String signal, Callable callable, {int flags = 0}) GDError
inherited
createShapeOwner(GodotObject? owner) int
inherited
createTween() Tween?
inherited
detachSignal(SignalCallable signal) → void
inherited
disconnect(String signal, Callable callable) → void
inherited
drawAnimationSlice(double animationLength, double sliceBegin, double sliceEnd, {double offset = 0.0}) → void
inherited
drawArc(Vector2 center, double radius, double startAngle, double endAngle, int pointCount, Color color, {double width = -1.0, bool antialiased = false}) → void
inherited
drawChar(Font? font, Vector2 pos, String char, {int fontSize = 16, Color? modulate}) → void
inherited
drawCharOutline(Font? font, Vector2 pos, String char, {int fontSize = 16, int size = -1, Color? modulate}) → void
inherited
drawCircle(Vector2 position, double radius, Color color, {bool filled = true, double width = -1.0, bool antialiased = false}) → void
inherited
drawColoredPolygon(PackedVector2Array points, Color color, {PackedVector2Array? uvs, Texture2D? texture}) → void
inherited
drawDashedLine(Vector2 from, Vector2 to, Color color, {double width = -1.0, double dash = 2.0, bool aligned = true, bool antialiased = false}) → void
inherited
drawEndAnimation() → void
inherited
drawLcdTextureRectRegion(Texture2D? texture, Rect2 rect, Rect2 srcRect, {Color? modulate}) → void
inherited
drawLine(Vector2 from, Vector2 to, Color color, {double width = -1.0, bool antialiased = false}) → void
inherited
drawMesh(Mesh? mesh, Texture2D? texture, {Transform2D? transform, Color? modulate}) → void
inherited
drawMsdfTextureRectRegion(Texture2D? texture, Rect2 rect, Rect2 srcRect, {Color? modulate, double outline = 0.0, double pixelRange = 4.0, double scale = 1.0}) → void
inherited
drawMultiline(PackedVector2Array points, Color color, {double width = -1.0, bool antialiased = false}) → void
inherited
drawMultilineColors(PackedVector2Array points, PackedColorArray colors, {double width = -1.0, bool antialiased = false}) → void
inherited
drawMultilineString(Font? font, Vector2 pos, String text, {HorizontalAlignment? alignment, double width = -1, int fontSize = 16, int maxLines = -1, Color? modulate, int brkFlags = 3, int justificationFlags = 3, TextServerDirection? direction, TextServerOrientation? orientation}) → void
inherited
drawMultilineStringOutline(Font? font, Vector2 pos, String text, {HorizontalAlignment? alignment, double width = -1, int fontSize = 16, int maxLines = -1, int size = 1, Color? modulate, int brkFlags = 3, int justificationFlags = 3, TextServerDirection? direction, TextServerOrientation? orientation}) → void
inherited
drawMultimesh(MultiMesh? multimesh, Texture2D? texture) → void
inherited
drawPolygon(PackedVector2Array points, PackedColorArray colors, {PackedVector2Array? uvs, Texture2D? texture}) → void
inherited
drawPolyline(PackedVector2Array points, Color color, {double width = -1.0, bool antialiased = false}) → void
inherited
drawPolylineColors(PackedVector2Array points, PackedColorArray colors, {double width = -1.0, bool antialiased = false}) → void
inherited
drawPrimitive(PackedVector2Array points, PackedColorArray colors, PackedVector2Array uvs, {Texture2D? texture}) → void
inherited
drawRect(Rect2 rect, Color color, {bool filled = true, double width = -1.0, bool antialiased = false}) → void
inherited
drawSetTransform(Vector2 position, {double rotation = 0.0, Vector2? scale}) → void
inherited
drawSetTransformMatrix(Transform2D xform) → void
inherited
drawString(Font? font, Vector2 pos, String text, {HorizontalAlignment? alignment, double width = -1, int fontSize = 16, Color? modulate, int justificationFlags = 3, TextServerDirection? direction, TextServerOrientation? orientation}) → void
inherited
drawStringOutline(Font? font, Vector2 pos, String text, {HorizontalAlignment? alignment, double width = -1, int fontSize = 16, int size = 1, Color? modulate, int justificationFlags = 3, TextServerDirection? direction, TextServerOrientation? orientation}) → void
inherited
drawStyleBox(StyleBox? styleBox, Rect2 rect) → void
inherited
drawTexture(Texture2D? texture, Vector2 position, {Color? modulate}) → void
inherited
drawTextureRect(Texture2D? texture, Rect2 rect, bool tile, {Color? modulate, bool transpose = false}) → void
inherited
drawTextureRectRegion(Texture2D? texture, Rect2 rect, Rect2 srcRect, {Color? modulate, bool transpose = false, bool clipUv = true}) → void
inherited
duplicate({int flags = 15}) Node?
inherited
emitSignal(String signal, {List<Variant> vargs = const []}) GDError
inherited
findChild(String pattern, {bool recursive = true, bool owned = true}) Node?
inherited
findChildren(String pattern, {String type = '', bool recursive = true, bool owned = true}) → TypedArray<Node>
inherited
findParent(String pattern) Node?
inherited
forceUpdateTransform() → void
inherited
get(String property) Variant
inherited
getAngleTo(Vector2 point) double
inherited
getAngularDamp() double
getAngularDampSpaceOverrideMode() Area2DSpaceOverride
getAudioBusName() String
getAutoTranslateMode() NodeAutoTranslateMode
inherited
getCanvas() RID
inherited
getCanvasItem() RID
inherited
getCanvasLayerNode() CanvasLayer?
inherited
getCanvasTransform() Transform2D
inherited
getChild(int idx, {bool includeInternal = false}) Node?
inherited
getChildCount({bool includeInternal = false}) int
inherited
getChildren({bool includeInternal = false}) → TypedArray<Node>
inherited
getClass() String
inherited
getClipChildrenMode() CanvasItemClipChildrenMode
inherited
getCollisionLayer() int
inherited
getCollisionLayerValue(int layerNumber) bool
inherited
getCollisionMask() int
inherited
getCollisionMaskValue(int layerNumber) bool
inherited
getCollisionPriority() double
inherited
getDisableMode() CollisionObject2DDisableMode
inherited
getEditorDescription() String
inherited
getGlobalMousePosition() Vector2
inherited
getGlobalPosition() Vector2
inherited
getGlobalRotation() double
inherited
getGlobalRotationDegrees() double
inherited
getGlobalScale() Vector2
inherited
getGlobalSkew() double
inherited
getGlobalTransform() Transform2D
inherited
getGlobalTransformWithCanvas() Transform2D
inherited
getGravity() double
getGravityDirection() Vector2
getGravityPointCenter() Vector2
getGravityPointUnitDistance() double
getGravitySpaceOverrideMode() Area2DSpaceOverride
getGroups() → TypedArray<StringName>
inherited
getIncomingConnections() → TypedArray<Dictionary>
inherited
getIndex({bool includeInternal = false}) int
inherited
getIndexed(NodePath propertyPath) Variant
inherited
getInstanceId() int
inherited
getLastExclusiveWindow() Window?
inherited
getLightMask() int
inherited
getLinearDamp() double
getLinearDampSpaceOverrideMode() Area2DSpaceOverride
getLocalMousePosition() Vector2
inherited
getMaterial() Material?
inherited
getMeta(String name, {Variant? defaultval}) Variant
inherited
getMetaList() → TypedArray<StringName>
inherited
getMethodArgumentCount(String method) int
inherited
getMethodList() → TypedArray<Dictionary>
inherited
getModulate() Color
inherited
getMultiplayer() MultiplayerAPI?
inherited
getMultiplayerAuthority() int
inherited
getName() String
inherited
getNode(NodePath path) Node?
inherited
getNodeAndResource(NodePath path) Array
inherited
getNodeOrNull(NodePath path) Node?
inherited
getNodeT<T>([String? path]) → T?

Available on Node, provided by the TNode extension

getOverlappingAreas() → TypedArray<Area2D>
getOverlappingBodies() → TypedArray<Node2D>
getOwner() Node?
inherited
getParent() Node?
inherited
getPath() NodePath
inherited
getPathTo(Node? node, {bool useUniquePath = false}) NodePath
inherited
getPhysicsInterpolationMode() NodePhysicsInterpolationMode
inherited
getPhysicsProcessDeltaTime() double
inherited
getPhysicsProcessPriority() int
inherited
getPosition() Vector2
inherited
getPriority() int
getProcessDeltaTime() double
inherited
getProcessMode() NodeProcessMode
inherited
getProcessPriority() int
inherited
getProcessThreadGroup() NodeProcessThreadGroup
inherited
getProcessThreadGroupOrder() int
inherited
getProcessThreadMessages() int
inherited
getPropertyList() → TypedArray<Dictionary>
inherited
getRelativeTransformToParent(Node? parent) Transform2D
inherited
getRid() RID
inherited
getRotation() double
inherited
getRotationDegrees() double
inherited
getScale() Vector2
inherited
getSceneFilePath() String
inherited
getSceneInstanceLoadPlaceholder() bool
inherited
getScreenTransform() Transform2D
inherited
getScript() Variant
inherited
getSelfModulate() Color
inherited
getShapeOwnerOneWayCollisionMargin(int ownerId) double
inherited
getShapeOwners() PackedInt32Array
inherited
getSignalConnectionList(String signal) → TypedArray<Dictionary>
inherited
getSignalList() → TypedArray<Dictionary>
inherited
getSkew() double
inherited
getTextureFilter() CanvasItemTextureFilter
inherited
getTextureRepeat() CanvasItemTextureRepeat
inherited
getTransform() Transform2D
inherited
getTree() SceneTree?
inherited
getTreeString() String
inherited
getTreeStringPretty() String
inherited
getUseParentMaterial() bool
inherited
getViewport() Viewport?
inherited
getViewportRect() Rect2
inherited
getViewportTransform() Transform2D
inherited
getVisibilityLayer() int
inherited
getVisibilityLayerBit(int layer) bool
inherited
getWindow() Window?
inherited
getWorld_2d() World2D?
inherited
getZIndex() int
inherited
globalTranslate(Vector2 offset) → void
inherited
hasMeta(String name) bool
inherited
hasMethod(String method) bool
inherited
hasNode(NodePath path) bool
inherited
hasNodeAndResource(NodePath path) bool
inherited
hasOverlappingAreas() bool
hasOverlappingBodies() bool
hasSignal(String signal) bool
inherited
hasUserSignal(String signal) bool
inherited
hide() → void
inherited
isAncestorOf(Node? node) bool
inherited
isBlockingSignals() bool
inherited
isClass(String klass) bool
inherited
isConnected(String signal, Callable callable) bool
inherited
isDisplayedFolded() bool
inherited
isDrawBehindParentEnabled() bool
inherited
isEditableInstance(Node? node) bool
inherited
isGravityAPoint() bool
isGreaterThan(Node? node) bool
inherited
isInGroup(String group) bool
inherited
isInsideTree() bool
inherited
isLocalTransformNotificationEnabled() bool
inherited
isMonitorable() bool
isMonitoring() bool
isMultiplayerAuthority() bool
inherited
isNodeReady() bool
inherited
isOverridingAudioBus() bool
isPartOfEditedScene() bool
inherited
isPhysicsInterpolated() bool
inherited
isPhysicsInterpolatedAndEnabled() bool
inherited
isPhysicsProcessing() bool
inherited
isPhysicsProcessingInternal() bool
inherited
isPickable() bool
inherited
isProcessing() bool
inherited
isProcessingInput() bool
inherited
isProcessingInternal() bool
inherited
isProcessingShortcutInput() bool
inherited
isProcessingUnhandledInput() bool
inherited
isProcessingUnhandledKeyInput() bool
inherited
isQueuedForDeletion() bool
inherited
isSetAsTopLevel() bool
inherited
isShapeOwnerDisabled(int ownerId) bool
inherited
isShapeOwnerOneWayCollisionEnabled(int ownerId) bool
inherited
isTransformNotificationEnabled() bool
inherited
isUniqueNameInOwner() bool
inherited
isVisible() bool
inherited
isVisibleInTree() bool
inherited
isYSortEnabled() bool
inherited
isZRelative() bool
inherited
lookAt(Vector2 point) → void
inherited
makeCanvasPositionLocal(Vector2 screenPoint) Vector2
inherited
makeInputLocal(InputEvent? event) InputEvent?
inherited
moveChild(Node? childNode, int toIndex) → void
inherited
moveLocalX(double delta, {bool scaled = false}) → void
inherited
moveLocalY(double delta, {bool scaled = false}) → void
inherited
moveToFront() → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notification(int what, {bool reversed = false}) → void
inherited
notifyDeferredThreadGroup(int what) → void
inherited
notifyPropertyListChanged() → void
inherited
notifyThreadSafe(int what) → void
inherited
overlapsArea(Node? area) bool
overlapsBody(Node? body) bool
printTree() → void
inherited
printTreePretty() → void
inherited
propagateCall(String method, {Array? argsparam, bool parentFirst = false}) → void
inherited
propagateNotification(int what) → void
inherited
propertyCanRevert(String property) bool
inherited
propertyGetRevert(String property) Variant
inherited
queueFree() → void
inherited
queueRedraw() → void
inherited
removeChild(Node? node) → void
inherited
removeFromGroup(String group) → void
inherited
removeMeta(String name) → void
inherited
removeShapeOwner(int ownerId) → void
inherited
removeUserSignal(String signal) → void
inherited
reparent(Node? newParent, {bool keepGlobalTransform = true}) → void
inherited
replaceBy(Node? node, {bool keepGroups = false}) → void
inherited
requestReady() → void
inherited
resetPhysicsInterpolation() → void
inherited
rotate(double radians) → void
inherited
rpc(String method, {List<Variant> vargs = const []}) GDError
inherited
rpcConfig(String method, Variant config) → void
inherited
rpcId(int peerId, String method, {List<Variant> vargs = const []}) GDError
inherited
set(String property, Variant value) → void
inherited
setAngularDamp(double angularDamp) → void
setAngularDampSpaceOverrideMode(Area2DSpaceOverride spaceOverrideMode) → void
setAsTopLevel(bool enable) → void
inherited
setAudioBusName(String name) → void
setAudioBusOverride(bool enable) → void
setAutoTranslateMode(NodeAutoTranslateMode mode) → void
inherited
setBlockSignals(bool enable) → void
inherited
setClipChildrenMode(CanvasItemClipChildrenMode mode) → void
inherited
setCollisionLayer(int layer) → void
inherited
setCollisionLayerValue(int layerNumber, bool value) → void
inherited
setCollisionMask(int mask) → void
inherited
setCollisionMaskValue(int layerNumber, bool value) → void
inherited
setCollisionPriority(double priority) → void
inherited
setDeferred(String property, Variant value) → void
inherited
setDeferredThreadGroup(String property, Variant value) → void
inherited
setDisableMode(CollisionObject2DDisableMode mode) → void
inherited
setDisplayFolded(bool fold) → void
inherited
setDrawBehindParent(bool enable) → void
inherited
setEditableInstance(Node? node, bool isEditable) → void
inherited
setEditorDescription(String editorDescription) → void
inherited
setGlobalPosition(Vector2 position) → void
inherited
setGlobalRotation(double radians) → void
inherited
setGlobalRotationDegrees(double degrees) → void
inherited
setGlobalScale(Vector2 scale) → void
inherited
setGlobalSkew(double radians) → void
inherited
setGlobalTransform(Transform2D xform) → void
inherited
setGravity(double gravity) → void
setGravityDirection(Vector2 direction) → void
setGravityIsPoint(bool enable) → void
setGravityPointCenter(Vector2 center) → void
setGravityPointUnitDistance(double distanceScale) → void
setGravitySpaceOverrideMode(Area2DSpaceOverride spaceOverrideMode) → void
setIndexed(NodePath propertyPath, Variant value) → void
inherited
setLightMask(int lightMask) → void
inherited
setLinearDamp(double linearDamp) → void
setLinearDampSpaceOverrideMode(Area2DSpaceOverride spaceOverrideMode) → void
setMaterial(Material? material) → void
inherited
setMessageTranslation(bool enable) → void
inherited
setMeta(String name, Variant value) → void
inherited
setModulate(Color modulate) → void
inherited
setMonitorable(bool enable) → void
setMonitoring(bool enable) → void
setMultiplayerAuthority(int id, {bool recursive = true}) → void
inherited
setName(String name) → void
inherited
setNotifyLocalTransform(bool enable) → void
inherited
setNotifyTransform(bool enable) → void
inherited
setOwner(Node? owner) → void
inherited
setPhysicsInterpolationMode(NodePhysicsInterpolationMode mode) → void
inherited
setPhysicsProcess(bool enable) → void
inherited
setPhysicsProcessInternal(bool enable) → void
inherited
setPhysicsProcessPriority(int priority) → void
inherited
setPickable(bool enabled) → void
inherited
setPosition(Vector2 position) → void
inherited
setPriority(int priority) → void
setProcess(bool enable) → void
inherited
setProcessInput(bool enable) → void
inherited
setProcessInternal(bool enable) → void
inherited
setProcessMode(NodeProcessMode mode) → void
inherited
setProcessPriority(int priority) → void
inherited
setProcessShortcutInput(bool enable) → void
inherited
setProcessThreadGroup(NodeProcessThreadGroup mode) → void
inherited
setProcessThreadGroupOrder(int order) → void
inherited
setProcessThreadMessages(int flags) → void
inherited
setProcessUnhandledInput(bool enable) → void
inherited
setProcessUnhandledKeyInput(bool enable) → void
inherited
setRotation(double radians) → void
inherited
setRotationDegrees(double degrees) → void
inherited
setScale(Vector2 scale) → void
inherited
setSceneFilePath(String sceneFilePath) → void
inherited
setSceneInstanceLoadPlaceholder(bool loadPlaceholder) → void
inherited
setScript(Variant script) → void
inherited
setSelfModulate(Color selfModulate) → void
inherited
setSkew(double radians) → void
inherited
setTextureFilter(CanvasItemTextureFilter mode) → void
inherited
setTextureRepeat(CanvasItemTextureRepeat mode) → void
inherited
setThreadSafe(String property, Variant value) → void
inherited
setTransform(Transform2D xform) → void
inherited
setUniqueNameInOwner(bool enable) → void
inherited
setUseParentMaterial(bool enable) → void
inherited
setVisibilityLayer(int layer) → void
inherited
setVisibilityLayerBit(int layer, bool enabled) → void
inherited
setVisible(bool visible) → void
inherited
setYSortEnabled(bool enabled) → void
inherited
setZAsRelative(bool enable) → void
inherited
setZIndex(int zIndex) → void
inherited
shapeFindOwner(int shapeIndex) int
inherited
shapeOwnerAddShape(int ownerId, Shape2D? shape) → void
inherited
shapeOwnerClearShapes(int ownerId) → void
inherited
shapeOwnerGetOwner(int ownerId) GodotObject?
inherited
shapeOwnerGetShape(int ownerId, int shapeId) Shape2D?
inherited
shapeOwnerGetShapeCount(int ownerId) int
inherited
shapeOwnerGetShapeIndex(int ownerId, int shapeId) int
inherited
shapeOwnerGetTransform(int ownerId) Transform2D
inherited
shapeOwnerRemoveShape(int ownerId, int shapeId) → void
inherited
shapeOwnerSetDisabled(int ownerId, bool disabled) → void
inherited
shapeOwnerSetOneWayCollision(int ownerId, bool enable) → void
inherited
shapeOwnerSetOneWayCollisionMargin(int ownerId, double margin) → void
inherited
shapeOwnerSetTransform(int ownerId, Transform2D transform) → void
inherited
show() → void
inherited
toGlobal(Vector2 localPoint) Vector2
inherited
toLocal(Vector2 globalPoint) Vector2
inherited
toString() String
A string representation of this object.
inherited
tr(String message, {String context = ''}) String
inherited
translate(Vector2 offset) → void
inherited
trN(String message, String pluralMessage, int n, {String context = ''}) String
inherited
updateConfigurationWarnings() → void
inherited
vDraw() → void
inherited
vEnterTree() → void
inherited
vExitTree() → void
inherited
vGetConfigurationWarnings() PackedStringArray
inherited
vInput(InputEvent? event) → void
inherited
vInputEvent(Viewport? viewport, InputEvent? event, int shapeIdx) → void
inherited
vMouseEnter() → void
inherited
vMouseExit() → void
inherited
vMouseShapeEnter(int shapeIdx) → void
inherited
vMouseShapeExit(int shapeIdx) → void
inherited
vPhysicsProcess(double delta) → void
inherited
vProcess(double delta) → void
inherited
vReady() → void
inherited
vShortcutInput(InputEvent? event) → void
inherited
vUnhandledInput(InputEvent? event) → void
inherited
vUnhandledKeyInput(InputEvent? event) → void
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

sTypeInfo ExtensionTypeInfo<Area2D>
no setter

Constants

nativeTypeName → const String