Grid Placement
Development ⚠️ GridPlacement 6.0 (GECS) is in active development. This is the GDScript ECS architecture.

ResourceConsumptionRuleSettings

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: rules/settings/resource_consumption_rule_settings.gd

Version: 6.0

class_name: ResourceConsumptionRuleSettings extends: Resource

Signals

(none)

Exports

  • _group
    • Message shown when all required resources are available
    • Player-friendly reason shown when resource validation succeeds
    • Message shown when resources are insufficient
    • Player-friendly reason shown when resource validation fails
    • Message shown when resource provider is not found
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • success_message: String = “All required resources available”
    • Player-friendly reason shown when resource validation succeeds
    • Message shown when resources are insufficient
    • Player-friendly reason shown when resource validation fails
    • Message shown when resource provider is not found
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • success_reason: String = “Can afford placement”
    • Message shown when resources are insufficient
    • Player-friendly reason shown when resource validation fails
    • Message shown when resource provider is not found
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • _group
    • Message shown when all required resources are available
    • Player-friendly reason shown when resource validation succeeds
    • Message shown when resources are insufficient
    • Player-friendly reason shown when resource validation fails
    • Message shown when resource provider is not found
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • fail_insufficient_message: String = “Insufficient resources”
    • Player-friendly reason shown when resource validation fails
    • Message shown when resource provider is not found
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • failure_reason: String = “Cannot afford placement”
    • Message shown when resource provider is not found
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • no_provider_message: String = “Resource system not available”
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • provider_not_ready_message: String = “Resource system not ready”
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • _group
    • Message shown when all required resources are available
    • Player-friendly reason shown when resource validation succeeds
    • Message shown when resources are insufficient
    • Player-friendly reason shown when resource validation fails
    • Message shown when resource provider is not found
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • show_resource_details: bool = true
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • show_resource_names: bool = true
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • show_resource_counts: bool = true
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • _group
    • Message shown when all required resources are available
    • Player-friendly reason shown when resource validation succeeds
    • Message shown when resources are insufficient
    • Player-friendly reason shown when resource validation fails
    • Message shown when resource provider is not found
    • Message shown when resource provider is not ready
    • Show detailed resource information in failure messages
    • Show resource names in messages (vs generic “resources”)
    • Show current vs required resource counts
    • Whether to consume resources on successful placement
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • consume_on_success: bool = true
    • Whether to allow placement when resources are insufficient (for testing)
    • Enable detailed resource tracking
    • Validate settings configuration
  • allow_insufficient: bool = false
    • Enable detailed resource tracking
    • Validate settings configuration
  • debug_mode: bool = false
    • Validate settings configuration

Methods

  • validate -> Array
  • get_formatted_insufficient_message(resource_infos: Array) -> String
  • get_success_message(resource_infos: Array) -> String
  • get_summary -> Dictionary