Skip to content

Class

BuildCost

Generated GDScript class reference for GridPlacement.BuildCost.

Status
Current
Version
v6.3.0
Source updated
2026-10-29
Generated on
2026-10-29

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

What was paid to build an object, so it can be refunded on demolish. Your game stores it on the placed Manipulatable as metadata under META_KEY when the object is built. A Refunder reads it back when the object is demolished (see ManipulationState.pre_demolish). Costs are keyed by id; your inventory decides what each id means. See the refund-on-demolish guide.

Source: addons/grid_placement/resources/build_cost.gd

Syntax

class BuildCost extends Resource

Members

NameKindSummary
META_KEYFieldMetadata key the cost is stored under on the Manipulatable. Use this constant instead of typing the string.
entriesPropertyItems paid. Each dictionary has an id (StringName) and a quantity ([int]).
currencyPropertyCurrency paid, as currency id (StringName) mapped to amount.
source_resourcePropertyOptional. The resource this cost came from, such as the ScenePlacementEntry. For reference only; refunds do not use it.
resolve_forMethod
from_costsMethod
from_pairsMethod
is_valid_quantityMethod
multipliedMethod