Grid Placement

Placeable

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: placement/placeable/placeable.gd

Version: 5.0

class_name: Placeable extends: GBResource

Signals

(none)

Exports

  • display_name
    • 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
    • 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
  • tags
    • 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

    • 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 = 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_packed_scene: PackedScene = null, p_placement_rules: Array)
  • get_load_data(p_include_uid: bool) -> Dictionary
  • load_resource(p_load_data: Dictionary) -> Placeable
  • get_packed_root_name -> StringName
  • get_editor_issues -> Array
  • get_runtime_issues -> Array
  • _validate_property(property: Dictionary)