Prototype/ResourceEntity
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/ResourceEntityPrototype.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/ResourceEntity
A mineable/gatherable entity. Its collision_mask must contain "resource-layer" if it should be minable with a Prototype/MiningDrill.
Mandatory properties
This prototype inherits all the properties from Prototype/Entity.
stages
Type: AnimationVariations
Entity's graphics, using a graphic sheet, with variation and depletion. At least one stage must be defined.
When using Types/AnimationVariations#sheet, frame_count is the amount of frames per row in the spritesheet. variation_count is the amount of rows in the spritesheet. Each row in the spritesheet is one stage of the animation.
stage_counts
Type: table of uint32
Number of stages the animation has.
Optional properties
infinite
Type: bool
Default: false
If the ore is infinitely minable, or if it will eventually run out of resource.
highlight
Type: bool
Default: false
If the resource should be highlighted when holding a mining drill that can mine it (holding a pumpjack highlights crude-oil in the base game).
randomize_visual_position
Type: bool
Default: true
If there is a slight offset to graphics of the resource. Used to make patches a little less uniform in appearance.
map_grid
Type: bool
Default: true
Whether the resource should have a grid pattern on the map instead of a solid map color.
minimum
Type: uint32
Default: 0
Must be not 0 when infinite = true.
normal
Type: uint32
Default: 1
Must be not 0 when infinite = true.
infinite_depletion_amount
Type: uint32
Default: 1
Every time an infinite-type resource "ticks" lower it's lowered by that amount. -- Rseding91
resource_patch_search_radius
Type: uint32
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).
category
Type: string
Default: "basic-solid"
The category for the resource. Available categories in vanilla can be found here: Data.raw#resource-category
walking_sound
Type: Sound
Sound played when the player walks over this resource.
stages_effect
Type: AnimationVariations
An effect that can be overlayed above the normal ore graphics. Used in the base game to make uranium ore glow.
effect_animation_period
Type: float
Default: 0.0
How long it takes stages_effect to go from min_effect_alpha to max_effect_alpha.
effect_animation_period_deviation
Type: float
Default: 0.0
How much effect_animation_period can deviate from its original value. Used to make the stages effect alpha change look less uniform.
effect_darkness_multiplier
Type: float
Default: 1.0
How much the surface darkness should affect the alpha of stages_effect.
min_effect_alpha
Type: float
Default: 0.0
Minimal alpha value of stages_effect.
max_effect_alpha
Type: float
Default: 1.0
Maximal alpha value of stages_effect.
tree_removal_probability
Type: double
Default: 0
Must be positive.
tree_removal_max_distance
Type: double
Default: 0
Must be positive when tree_removal_probability is set.
mining_visualisation_tint
Type: Color
Default: unset
Defaults to the resources map color if left unset and map color is set, otherwise defaults to white if left unset.
Example
{
type = "resource",
name = "crude-oil",
icon = "__base__/graphics/icons/crude-oil.png",
icon_size = 32,
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,
tree_removal_probability = 0.7,
tree_removal_max_distance = 32 * 32,
minable =
{
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 = resource_autoplace.resource_autoplace_settings{
name = "crude-oil",
order = "c", -- Other resources are "b"; oil won't get placed if something else is already there.
base_density = 8.2,
base_spots_per_km2 = 1.8,
random_probability = 1/48,
random_spot_size_minimum = 1,
random_spot_size_maximum = 1, -- don't randomize spot size
additional_richness = 220000, -- this increases the total everywhere, so base_density needs to be decreased to compensate
has_starting_area_placement = false,
resource_index = resource_autoplace.resource_indexes["crude-oil"],
regular_rq_factor_multiplier = 1
},
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
}