Placeable
Summary
Section titled “Summary”Display name for in-game reading.
Properties
Section titled “Properties”display_name: StringNameDisplay name for in-game reading.
icon: Texture2DTexture icon for UI elements.
packed_scene: PackedSceneScene to instance when placed.
Category tags for grouping placeables.
placement_rules: Array[PlacementRule] = []Placement rules specific to this placeable. If [member ignore_base_rules] is
false, these rules are combined with base rules from [member GBSettings.placement_rules].ignore_base_rules = falseWhen
true, skips base placement rules from [member GBSettings.placement_rules] and uses ONLY the rules defined in [member placement_rules].Use cases: -
false(default): Inherit common rules + add object-specific rules -true: Completely custom validation (e.g., special objects with unique placement logic)
Methods
Section titled “Methods”func _init( p_packed_scene: PackedScene, p_placement_rules: Array[PlacementRule] )func get_load_data( p_include_uid: bool ) -> DictionaryGets a serialized reference to the placeable for both the FILE_PATH and the file path as a backup
static func load_resource( p_load_data: Dictionary ) -> PlaceableFunction to help location the placeable using FILE_PATH or file path as backup and returning it
func get_packed_root_name( ) -> StringNameGets the name of the root node in the packed_scene
func get_editor_issues( ) -> Array[String]Returns an array of issues that were found in the placeable
func get_runtime_issues( ) -> Array[String]Returns all found runtime issues including the editor issues as a baseline.
func _validate_property( property: Dictionary )In editor validation
Source
Section titled “Source”addons/grid_building/placement/placeable/placeable.gd
This API reference is automatically generated from the plugin source code. For implementation examples and usage guides, see the guides section.