Grid Placement

ValidPlacementTileRule

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: placement/placement_rules/template_rules/valid_placement_tile_rule.gd

Version: 5.0

class_name: ValidPlacementTileRule extends: TileCheckRule

Signals

(none)

Exports

  • expected_tile_custom_data =

    • Usage:
      • Assign this rule to a GBCompositionContainer for context wide injection or to a Placeable for placeable specific rule evaluation
      • The rule will fail if the tile at the indicator’s position does not contain all the required custom data or if any values do not match.
  • settings

Methods

  • _init(p_expected_tile_data: Dictionary = {})
  • _ensure_settings -> ValidPlacementRuleSettings
  • setup(p_gts: GridTargetingState) -> Array
    • Delegate to base PlacementRule.setup for initializing _grid_targeting_state and readiness state
  • validate_placement -> RuleResult
  • _get_failing_indicators(p_indicators: Array) -> Array
  • tear_down
  • does_tile_have_valid_data(p_indicator: RuleCheckIndicator, p_maps: Array) -> bool
    • Validate input parameter
  • _get_tile_position(map: Node2D, indicator: RuleCheckIndicator) -> Vector2i
  • _tile_has_matching_data(map: Node2D, tile_pos: Vector2i) -> bool
    • Make sure the tile data has the custom_data requirements
  • _test_tile_data_for_all_matches(p_tile_data: TileData, p_required_custom_data: Dictionary) -> bool
  • _post_setup_validation -> Array