Placeable

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: systems/placement/data/placeable/placeable.gd

Version: 5.1

class_name: Placeable extends: GBResource

Summary

Object that can be placed into the game world by instancing the packed_scene.

Signals

(none)

Exports

• display_name
  • Display name for in-game reading.
• icon
  • Texture icon for UI elements.
• packed_scene
  • Scene to instance when placed.
• tags
  • Category tags for grouping placeables.
• placement_rules
  • Placement rules specific to this placeable. If [member ignore_base_rules] is [code]false[/code], these rules are combined with base rules from [member GBSettings.placement_rules].
• ignore_base_rules
  • When [code]true[/code], skips base placement rules from [member GBSettings.placement_rules] and uses ONLY the rules defined in [member placement_rules].

Use cases:

• [code]false[/code] (default): Inherit common rules + add object-specific rules
• [code]true[/code]: Completely custom validation (e.g., special objects with unique placement logic)

Methods

• _init()
• get_load_data()
  • Gets a serialized reference to the placeable for both the FILE_PATH and the file path as a backup
• get_packed_root_name()
  • Gets the name of the root node in the packed_scene
• get_editor_issues()
  • Returns an array of issues that were found in the placeable
• get_runtime_issues()
  • Returns all found runtime issues including the editor issues as a baseline.
• _validate_property()
  • In editor validation