Prototype/ResourceEntity

Basics

A mineable/gatherable entity. An extension of Prototype/Entity.

Properties

infinite

Type: Types/bool

Default: false

If the ore is infinitely minable, or if it will eventually run out of resource.

highlight

Type: Types/bool

Default: false

If the ore appears on the map overview separately from large ore veins, or not.

minimum

Type: Types/uint

Default: 0

normal

Type: Types/uint

Default: 1

infinite_depletion_amount

Type: Types/uint

Default: 1

Every time an infinite-type resource "ticks" lower it's lowered by that amount. -- Rseding91

stages

Type: Types/AnimationVariations

Entity's graphics, using a graphic sheet, with variation and depletion.

category

Type: Types/string

Default: basic-solid

The category for the resource. Available categories in vanilla can be found here: Data.raw#resource-category

map_grid

Type: Types/bool

Default: true

resource_patch_search_radius

Type: Types/uint

Default: 3

When hovering over this resource in the map view: How far to search for other resource patches of this type to display as one (summing amount, white outline).

stages_effect

Type: Types/AnimationVariations

effect_animation_period

Type: Types/float

Default: 0.0

effect_animation_period_deviation

Type: Types/float

Default: 0.0

effect_darkness_multiplier

Type: Types/float

Default: 1.0

min_effect_alpha

Type: Types/float

Default: 0.0

max_effect_alpha

Type: Types/float

Default: 1.0

tree_removal_probability

Type: Types/double

Default: 0

tree_removal_max_distance

Type: Types/double

Default: 0

stage_counts

Type: Types/table of Types/uint

Number of stages the animation has.

Example

{
  {
  type = "resource",
  name = "crude-oil",
  icon = "__base__/graphics/icons/crude-oil.png",
  flags = {"placeable-neutral"},
  category = "basic-fluid",
  order="a-b-a",
  infinite = true,
  highlight = true,
  minimum = 60000,
  normal = 300000,
  infinite_depletion_amount = 10,
  resource_patch_search_radius = 12,
  minable =
  {
    hardness = 1,
    mining_time = 1,
    results =
    {
      {
        type = "fluid",
        name = "crude-oil",
        amount_min = 10,
        amount_max = 10,
        probability = 1
      }
    }
  },
  collision_box = {{ -1.4, -1.4}, {1.4, 1.4}},
  selection_box = {{ -0.5, -0.5}, {0.5, 0.5}},
  autoplace =
  {
    control = "crude-oil",
    sharpness = 0.99,
    max_probability = 0.02,
    richness_base = 240000,
    richness_multiplier = 300000,
    richness_multiplier_distance_bonus = 3000,
    coverage = 0.02, -- Cover on average 2% of surface area.
    peaks =
    {
      {
        noise_layer = "crude-oil",
        noise_octaves_difference = -1,
        noise_persistence = 0.4,
      }
    }
  },
  stage_counts = {0},
  stages =
  {
    sheet =
    {
      filename = "__base__/graphics/entity/crude-oil/crude-oil.png",
      priority = "extra-high",
      width = 75,
      height = 61,
      frame_count = 4,
      variation_count = 1
    }
  },
  map_color = {r=0.78, g=0.2, b=0.77},
  map_grid = false
},