PlaceableSequence

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

Groups multiple placeable variants under a single selectable slot for UI selection.

Source File: addons/grid_building/placeables/placeable_sequence.gd

Extends: GBResource

Exported Properties

  • Property: display_name: String = "Sequence"
  • Property: placeables: Array[Placeable] = [] # Ordered variants
  • Property: icon: Texture2D # Optional representative icon (fallback to first variant's icon)

Public Methods

count

1

count() -> int

Returns the total number of placeable variants in this sequence. Used by UI components to determine if variant cycling controls should be displayed. [return] Number of placeable variants (0 if empty)

get_variant

1

get_variant(index: int) -> Resource

Retrieves a specific placeable variant by its index position. index Zero-based index of the variant to retrieve [return] Placeable resource at the specified index, or null if index is out of bounds

variant_display_name

1

variant_display_name(index: int) -> String

Gets the display name for a specific variant, with fallback handling. index Zero-based index of the variant to get the name for [return] Display name of the variant, or fallback “Variant N” if unavailable

get_editor_issues

1

get_editor_issues() -> Array[String]

Validates the sequence configuration and returns any editor-time issues found. Performs sequence-level validation and delegates individual placeable validation to each Placeable object for proper separation of concerns. [return] Array of validation issue descriptions, empty if no issues found

get_runtime_issues

1

get_runtime_issues() -> Array[String]

Validates the sequence for runtime usage and returns any issues found. Includes sequence-level validation plus comprehensive placeable validation. Note: Individual placeable.get_runtime_issues() calls already include their editor issues, preventing duplication while ensuring complete coverage. [return] Array of validation issue descriptions, empty if no issues found