Placeable

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: resources/placeables/placeable.gd

Version: 6.0

class_name: Placeable extends: GPSettings

Signals

(none)

Exports

• display_name: StringName
  • Texture icon for UI elements.
  • Scene to instance when placed.
  • Category tags for grouping placeables.
  • 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].
  • 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)
• icon: Texture2D
  • Scene to instance when placed.
  • Category tags for grouping placeables.
  • 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].
  • 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)
• packed_scene: PackedScene
• tags: Array
  • 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].
  • 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)

• placement_rules: Array = []

  • 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)
• ignore_base_rules: bool = false
  • base rules from [member GBSettings.placement_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(p_file_path: String = "", p_uid: String = "")
• has_uid -> bool
• from_placeable(p_placeable: Placeable, p_include_uid: bool) -> LoadData
• to_dict -> Dictionary
• from_dict(p_dict: Dictionary) -> LoadData
• _init(p_packed_scene: PackedScene = null, p_placement_rules: Array)
• get_load_data(p_include_uid: bool) -> LoadData
• load_resource(p_load_data: Variant) -> Placeable
• get_packed_root_name -> StringName
• get_editor_issues -> Array
• get_runtime_issues -> Array
• has_tag(tag: StringName) -> bool
• has_any_tag(tag_names: Array) -> bool
• get_rich_tag(tag_prefix: StringName) -> PlaceableTag
• get_unique_tags -> Array
• get_all_tags -> Array
• validate -> Dictionary
• validate_property(property_data) -> Dictionary
• _validate_property(property: Dictionary, Variant]) -> void