BuildingSettings

BuildingSettings

Configuration settings for GridBuilding system Provides centralized configuration management for building placement, validation, and behavior

Project: GridPlacement v6.0
Layer: Core
Source: Core/_incomplete/Systems/Configuration/BuildingSettings.cs
Namespace: GridBuilding.Core.Systems.Configuration
Kind: class

Parsing Method: AST-based (Roslyn) - NOT regex

⚠️ IMPORTANT: This documentation was generated using AST parsing, not regex.

Properties

BuildingId

Unique identifier for this building configuration

DisplayName

Display name for the building

Description

Description of the building

BuildingType

Type/category of the building

Size

Size of the building in grid units

IsMultiTile

Whether this building occupies multiple tiles

CanRotate

Whether this building can be rotated

CanFlip

Whether this building can be flipped

CanDemolish

Whether this building can be demolished

IsEnabled

Whether this building is enabled

IsValid

Configuration validity

Tags

Tags for placement filtering and validation

PlacementRules

Placement rules that must be satisfied

RequiredLocationTags

Required tags for placement location

ForbiddenLocationTags

Forbidden tags for placement location

MinimumDistanceFromOthers

Minimum distance from other buildings

MaximumDistanceFromTypes

Maximum distance from specific building types

RequiresRoadAccess

Whether this building requires road access

MaximumRoadDistance

Maximum road distance for placement

PlacementCost

Cost to place this building

DemolishRefund

Resources refunded when demolishing this building

MaintenanceCost

Maintenance cost per time unit

Production

Resources produced per time unit

StorageCapacity

Storage capacity for resources

ScenePath

Path to the building’s scene file

IconPath

Path to the building’s icon texture

PreviewPath

Path to the building’s preview texture

TintColor

CoreColor tint for the building

Modulation

Modulation for the building

ZIndex

Z-index for rendering order

CastsShadow

Whether this building casts shadows

IsActiveByDefault

Whether this building is active by default

CanUpgrade

Whether this building can be upgraded

MaxUpgradeLevel

Maximum upgrade level

CanConnect

Whether this building can be connected to others

ConnectionTypes

Connection types this building supports

HasAreaEffect

Whether this building affects nearby buildings

AreaEffectRadius

Area effect radius

Methods

Validate

Validates the building configuration

Returns: GridBuilding.Core.Results.ValidationResult

Clone

Creates a copy of this building configuration

Returns: BuildingSettings

GetTotalPlacementCost

Gets the total placement cost

Returns: int

GetTotalDemolishRefund

Gets the total demolish refund

Returns: int

HasTag

Checks if the building has a specific tag

Returns: bool

Parameters:

  • string tag

SupportsConnection

Checks if the building supports a specific connection type

Returns: bool

Parameters:

  • string connectionType

GetResourceCost

Gets the cost for a specific resource

Returns: int

Parameters:

  • string resourceType

CreateDefault

Creates a default building configuration

Returns: BuildingSettings

Parameters:

  • string buildingId

CreateResidential

Creates a residential building configuration

Returns: BuildingSettings

Parameters:

  • string buildingId

CreateCommercial

Creates a commercial building configuration

Returns: BuildingSettings

Parameters:

  • string buildingId