ResourceEntityPrototype

A mineable/gatherable entity.

Parent

• EntityPrototype

Properties

stages

• Type: AnimationVariations
• Optional: true
• Override: false

Entity's graphics, using a graphic sheet, with variation and depletion. At least one stage must be defined.

When using 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: Array<uint32>
• Optional: false
• Override: false

Number of stages the animation has.

infinite

• Type: boolean
• Optional: true
• Override: false

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

highlight

• Type: boolean
• Optional: true
• Override: 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: boolean
• Optional: true
• Override: false

Whether there should be a slight offset to graphics of the resource. Used to make patches a little less uniform in appearance.

map_grid

• Type: boolean
• Optional: true
• Override: false

Whether the resource should have a grid pattern on the map instead of a solid map color.

draw_stateless_visualisation_under_building

• Type: boolean
• Optional: true
• Override: false

minimum

• Type: uint32
• Optional: true
• Override: false

Must be not 0 when infinite = true.

normal

• Type: uint32
• Optional: true
• Override: false

Must be not 0 when infinite = true.

infinite_depletion_amount

• Type: uint32
• Optional: true
• Override: false

Every time an infinite-type resource is decreased by mining, its current resource amount is lowered by this number.

resource_patch_search_radius

• Type: uint32
• Optional: true
• Override: false

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: ResourceCategoryID
• Optional: true
• Override: false

The category for the resource. Available categories in vanilla can be found here.

walking_sound

• Type: Sound
• Optional: true
• Override: false

Sound played when the player walks over this resource.

driving_sound

• Type: InterruptibleSound
• Optional: true
• Override: false

Sound played when a CarPrototype drives over this resource.

stages_effect

• Type: AnimationVariations
• Optional: true
• Override: false

An effect that can be overlaid above the normal ore graphics. Used in the base game to make uranium ore glow.

effect_animation_period

• Type: float
• Optional: true
• Override: false

How long it takes stages_effect to go from min_effect_alpha to max_effect_alpha.

effect_animation_period_deviation

• Type: float
• Optional: true
• Override: false

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
• Optional: true
• Override: false

How much the surface darkness should affect the alpha of stages_effect.

min_effect_alpha

• Type: float
• Optional: true
• Override: false

Minimal alpha value of stages_effect.

max_effect_alpha

• Type: float
• Optional: true
• Override: false

Maximal alpha value of stages_effect.

tree_removal_probability

• Type: double
• Optional: true
• Override: false

Must be greater than or equal to 0.

cliff_removal_probability

• Type: double
• Optional: true
• Override: false

Must be greater than or equal to 0.

tree_removal_max_distance

• Type: double
• Optional: true
• Override: false

Must be positive when tree_removal_probability is set.

mining_visualisation_tint

• Type: Color
• Optional: true
• Override: false

Defaults to the resources map color if left unset and map color is set, otherwise defaults to white if left unset.