Object rule: checks for physics collisions on each tile the object covers. By default the space must be clear. Turn on pass_on_collision to require an overlap instead.
Source: addons/grid_placement/placement/placement_rules/template_rules/collisions_check_rule.gd
Syntax
class CollisionsCheckRule extends TileCheckRuleMembers
| Name | Kind | Summary |
|---|---|---|
pass_on_collision | Property | Off (default): the rule passes when nothing is in the way, as for normal buildings. On: the rule passes only when something is there, as for pieces that must attach to an existing structure. |
collision_mask | Property | Physics layers to check. |
messages | Property | Messages shown when the rule fails. Uses defaults when empty. |
get_debug_identifier | Method | |
setup | Method | |
validate_placement | Method | |
validate_placement_fast | Method | |
get_failing_indicators | Method | |
get_editor_issues | Method | |
get_runtime_issues | Method |
Guides that use this class
Tutorials built on Grid Placement
- Godot multiplayer grid placement: one host, four sessions
- Godot 2D grid building system: paint, place, save
- Godot 3D grid building system: the runtime loop
- Godot 4 grid-building plugins: build mode vs editor tools
- 3D room placement in Godot: build rooms and stack storeys
- 3D grid placement in Godot 4: full setup tutorial
- Snap to a TileMap in Godot: 2D grid placement
- How to make a farming system in Godot
- How to snap objects to a 3D grid in Godot