Skip to content

Class

PlacementProfile

Generated GDScript class reference for GridPlacement.PlacementProfile.

Status
Current
Version
v6.3.0
Source updated
2026-10-29
Generated on
2026-10-29

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

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 Resource

Members

NameKindSummary
descriptionPropertyDescription shown in the UI. Supports BBCode.
display_namePropertyName shown in the UI.
iconPropertyIcon shown in the UI, such as on the category tab.
tooltipPropertyTooltip for the category tab. Most useful when the tab shows only an icon, so players can still see what the category holds.
placement_rulesPropertyRules checked for every entry with this profile, after the base rules and before the entry's own rules.
ignore_base_rulesPropertyWhen 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_toolsPropertyPlacement 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_rulesMethod
collect_supported_toolsMethod