Area

A shape that notices other areas overlapping it, for triggers, pickups, hitboxes and hurtboxes. A script with an Area base hears them enter and leave.

On this page

Add it
From a script
Fields

Guides

Add it

+ Add node → Area, Audio Zone, Effector creates a node with it already on. Already have a node for it? Add component → AreaComponent.

From a script

A script on the same node writes these fields by name. AreaComponent is the name to pass.

rgs

set_text("AreaComponent", "track", "");

Fields

Field Script name Kind Default What it does

Shape shape section — The shape this area covers. Always non-solid — a solid shape is a Collider instead.

Field Script name Kind Default What it does

Kind kind one of Rectangle, Circle, Capsule Rectangle Which shape.

Size size two numbers (x, y) (64, 64) Size in local units.

Polygon

Outline polygon section empty Points replace the box; empty leaves the box alone.

Step polygon_step number, at least 0 32 u How long each collision box is where a slanted outline, or a solid circle or capsule, is cut into boxes: in the node's own units, or the world's on a turned node. Shorter follows the curve more closely and costs more boxes; zero cuts nothing, so a round solid is about its box again.

Offset offset two numbers (x, y) (0, 0) Offset from the node origin.

Solid solid checkbox off Whether this blocks movement. Off, it stops nothing and notices nothing: an Area is what notices bodies.

One Way one_way checkbox off Only stops a body falling onto it from above.

Layer layer number 1 Which collision layers this is on: what the collision matrix, casts and queries go by.

Include Layers include_layers number 0 A body on one of these layers meets this whatever the collision matrix says. It is not put on them. Exclude Layers beats it.

Exclude Layers exclude_layers number 0 A body on one of these layers passes through this. It stays on its Layer. Beats Include Layers.

Material material section none Friction and bounce; empty stops a body dead.

Field	Script name	Kind	Default	What it does
Friction	`friction`	number, at least 0, step 0.05	none	0 is ice, 1 is ordinary ground.
Bounce	`bounce`	number, 0 to 1, step 0.05	none	0 stops dead, 1 is elastic.

Layer layer number 1 Which layers this area is on.

Mask mask number 1 Which layers this area looks for.

Track track text empty Animation event track that enables this area; empty is always on.