Collider2D

Vaelis 1.0.0 Collider2D component reference: fields, script API, behavior and examples.

#What it does

Physics collision shape and contact filtering. A Collider2D is also required for accurate pointer/touch hit tests.

#How to add and use Collider2D

Editor path: Select the target entity in the Hierarchy (left side) → look at the Inspector (right side) → click Add Component at the bottom of the Inspector → search for Collider2D → click the component row. The Add Component picker is a centered modal with a search box; it only lists components not already attached.

For components with a dedicated editor tool, the tool is opened or activated from the location described below. Do not assume that adding the component alone activates its editor; some systems require a separate window, panel, or viewport tool.

#Component setup & editor tools

• Select entity → Inspector → Add Component → Collider 2D. After adding it, edit Shape, dimensions, Offset, Trigger, Friction, Restitution, Density, Layer, and Mask in the Collider2D section. The viewport Collider gizmo shows the collision shape.

#What you should see after adding it

The component appears as its own section in the Inspector. Its serialized settings are listed in the Component data table below. If a field is conditional, it appears only when the relevant mode/type is selected. If a field is a runtime state field (for example grounded or resolved velocity), treat it as read-only diagnostic state unless the API reference explicitly documents it as writable.

#How to read the settings

For every setting below, the documentation distinguishes type, default, meaning, and tuning direction where behavior is known. When a value represents a direction, use the engine's coordinate convention documented in Coordinate system; do not substitute Unity/Godot conventions.

#Component data

#Tuning behavior

These are the practical direction-of-change rules for the most important controls on this component.

#Script API

#Notes & behavior

• Collision layers use 16 membership layers (0-15). The mask determines which layers the collider can interact with.
• One-way platforms are intended to block from one side while allowing traversal from the non-blocking side.

#Examples

this.collider.isTrigger = true;

this.collider.layer = 2;

this.collider.mask = 0xFFFF;