Reusable placement rules, tools, and a catalog category shared by scene entries. Assign profiles in ScenePlacementEntry.profiles. Replaces CategoricalTag from 5.x; see the 6.0 migration guide. A profile adds its rules and tools to every entry that uses it, and also acts as a category tab in SceneEntrySelectionUI. Rules run after base rules and before the entry's own rules.
Source: addons/grid_placement/placement/scene_entry/placement_profile.gd
Syntax
class PlacementProfile extends ResourceMembers
| Name | Kind | Summary |
|---|---|---|
description | Property | Description shown in the UI. Supports BBCode. |
display_name | Property | Name shown in the UI. |
icon | Property | Icon shown in the UI, such as on the category tab. |
tooltip | Property | Tooltip for the category tab. Most useful when the tab shows only an icon, so players can still see what the category holds. |
placement_rules | Property | Rules checked for every entry with this profile, after the base rules and before the entry's own rules. |
ignore_base_rules | Property | When on, entries with this profile skip the base rules. Rules from their other profiles and their own rules still apply. To drop every inherited rule for one entry, use ScenePlacementEntry.ignore_base_rules. |
supported_object_tools | Property | Placement tools (single, line, rectangle) allowed for entries with this profile. Tools from all of an entry's profiles are combined; the entry can change the result with ScenePlacementEntry.tool_override_mode. |
resolve_category_rules | Method | |
collect_supported_tools | 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