PlacementRuleTestFactory

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

Source File: /addons/grid_building/test/factories/placement_rule_test_factory.gd

Extends: RefCounted

Constants

  • Constant: DEFAULT_COLLISION_LAYER: int = 1

    PlacementRule Test Factory Centralized creation of placement rules for testing Following GdUnit best practices: DRY principle, centralize common object creation Standard collision layer and mask constants for consistency

  • Constant: DEFAULT_COLLISION_MASK: int = 1

Public Methods

create_collision_rule_with_settings

1
2
3
4
5

create_collision_rule_with_settings(
    apply_mask: int,
    collision_mask: int,
    pass_on_collision: bool = true
) -> CollisionsCheckRule

Flags: static

Creates a CollisionsCheckRule with standard test configuration.

@param apply_mask: Objects mask to apply rule to @param collision_mask: Collision mask for detection @param pass_on_collision: Collision validation mode:

  • false: Rule PASSES when clear (placement needs empty space)
  • true: Rule PASSES when collision detected (placement needs overlap)

create_valid_tile_rule

1
2
3

create_valid_tile_rule(
    apply_mask: int = DEFAULT_COLLISION_LAYER
) -> ValidPlacementTileRule

Flags: static

Creates a ValidPlacementTileRule with standard test configuration @param apply_mask: Objects mask to apply rule to

create_default_collision_rule

1

create_default_collision_rule() -> CollisionsCheckRule

Flags: static

Creates a default collision rule with standard test settings Default behavior: fail on collision (pass_on_collision = false)

create_standard_placement_rules

1

create_standard_placement_rules(include_tile_rule: bool = true) -> Array[PlacementRule]

Flags: static

Creates a set of standard placement rules for testing @param include_tile_rule: Whether to include ValidPlacementTileRule

create_rules_from_templates

1
2
3
4

create_rules_from_templates(
    base_collision_rule: CollisionsCheckRule = null,
    base_tile_rule: TileCheckRule = null
) -> Array[PlacementRule]

Flags: static

Creates placement rules from existing rule templates @param base_collision_rule: Template collision rule to copy settings from @param base_tile_rule: Template tile rule to copy settings from

Grid Building v5.0.8 | Generated 24/05/2026