Grid Placement

SpendMaterialsRuleGeneric

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: placement/placement_rules/template_rules/spend_materials_rule_generic.gd

Version: 5.0

class_name: SpendMaterialsRuleGeneric extends: PlacementRule

Signals

(none)

Exports

  • resource_stacks_to_spend
    • Used to find the inventory on the _owner_root passed in as a setup parameter
    • The target container to search for materials to spend
  • locator
    • The target container to search for materials to spend

Methods

  • _init(p_resource_stacks_to_spend: Array, p_locator: NodeLocator = NodeLocator.new()
  • setup(p_gts: GridTargetingState) -> Array
  • apply -> Array
  • tear_down
  • validate_placement -> RuleResult
    • Find the resource owning script and get the resource count for each type
  • check_missing_resources(p_owner_root_container) -> Array
  • _get_material_container_from_user(user: Node) -> Node
  • _get_pre_setup_issues(p_gts: GridTargetingState) -> Array
  • _get_post_setup_issues -> Array
  • _get_material_name(p_material: Resource) -> String