Class

PlacementCostProvider

Generated GDScript class reference for GridPlacement.PlacementCostProvider.

Status: Draft
Version: v6.0
Updated: Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Typed view over a game-owned cost provider (inventory, wallet, stockpile). Grid Placement does not own inventory and cannot see its boundary. Any [Object] implementing this id-keyed protocol works as a provider:[br] [code]get_count_by_id(id: StringName) -> int[/code][br] [code]try_remove_by_id(id: StringName, amount: int) -> int[/code][br] [code]try_add_by_id(id: StringName, amount: int) -> int[/code][br][br] This wrapper is the one place that probes for those methods, so [SpendCostRuleBase] and [RefundCalculator] call a typed API. See the placement rules guide for the limits of spending through the plugin.

Source: addons/grid_placement/placement/placement_rules/template_rules/placement_cost_provider.gd

Syntax

class PlacementCostProvider extends RefCounted

Members

Name	Kind	Summary
`METHOD_COUNT`	Field
`METHOD_REMOVE`	Field
`METHOD_ADD`	Field
`is_bound`	Method
`can_count`	Method
`can_remove`	Method
`can_add`	Method
`get_missing_methods`	Method
`get_target_class`	Method
`count`	Method
`remove`	Method
`add`	Method