RadiusVisualisationSpecification - Prototype Docs

RadiusVisualisationSpecification :: struct changedExample code

Sprite to be shown around the entity when it is selected/held in the cursor.

Properties

sprite optional	:: Sprite	The sprite to show. [...]
The sprite to show. [...]
distance optional	:: double	Must be greater than or equal to 0. [...]
Must be greater than or equal to 0. [...]
offset optional	:: Vector	Offset of the sprite from the position of the entity. [...]
Offset of the sprite from the position of the entity. [...]
draw_in_cursor optional	:: boolean
draw_on_selection optional	:: boolean
distance_quality_multipliernew optional	:: dictionary[QualityID → double]	Each value must be >= 0.01. [...]
Each value must be >= 0.01. [...]

Properties

sprite :: Sprite optional

The sprite to show.

This sprite is silently overwritten by prototypes with a custom radius picture: AgriculturalTowerPrototype::radius_visualisation_picture, AsteroidCollectorPrototype::radius_visualisation_picture, BeaconPrototype::radius_visualisation_picture, CargoLandingPadPrototype::radius_visualisation_picture, ElectricPolePrototype::radius_visualisation_picture, MiningDrillPrototype::radius_visualisation_picture.

distance :: double optional

Default: 0

Must be greater than or equal to 0.

This distance is silently overwritten by prototypes with a custom distance: AgriculturalTowerPrototype::radius, AsteroidCollectorPrototype::collection_radius, BeaconPrototype::supply_area_distance, ElectricPolePrototype::supply_area_distance, MiningDrillPrototype::resource_searching_radius.

offset :: Vector optional

Offset of the sprite from the position of the entity. The offset is rotated by the entity's current direction.

This offset is silently overwritten by prototypes with a custom offset: MiningDrillPrototype::resource_searching_offset.

draw_in_cursor :: boolean optional

Default: true

draw_on_selection :: boolean optional

Default: true

distance_quality_multiplier :: dictionary[QualityID → double] optional new

Each value must be >= 0.01.

If value is not provided for a quality, then 1 will be used as a multiplier instead.

This does not affect the visualisation of prototypes with a custom distance specification because their distance automatically scales based on quality: agricultural tower (no quality scaling), asteroid collector, beacon, cargo landing pad (no quality scaling), electric pole, and mining drill.

Example

radius_visualisation_specification =
{
  sprite =
  {
    filename = "__base__/graphics/entity/electric-mining-drill/electric-mining-drill-radius-visualization.png",
    size = 10
  },
  distance = 5,
  offset = {0, -5}
}

Type used in

EntityPrototype::radius_visualisation_specification

Factorio Prototype Docs Version 2.1.9

RadiusVisualisationSpecification - Prototype Docs

RadiusVisualisationSpecification :: struct changedExample code

Properties

Properties

sprite :: Sprite optional

distance :: double optional

offset :: Vector optional

draw_in_cursor :: boolean optional

draw_on_selection :: boolean optional

distance_quality_multiplier :: dictionary[QualityID → double] optional new

Example

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.1.9

RadiusVisualisationSpecification - Prototype Docs

RadiusVisualisationSpecification :: struct changedExample code

Properties

Properties

sprite :: Sprite optional

distance :: double optional

offset :: Vector optional

draw_in_cursor :: boolean optional

draw_on_selection :: boolean optional

distance_quality_multiplier :: dictionary[QualityID → double] optional new

Example

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.1.9