Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Prototype Docs Version 2.0.77

# RadiusVisualisationSpecification - Prototype Docs

## RadiusVisualisationSpecification :: struct Example code

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

## Properties

- default
- sorted

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 optional | :: double | Must be greater than or equal to 0. [...]
Must be greater than or equal to 0. [...]
draw_in_cursor optional | :: boolean |
draw_on_selection optional | :: boolean |
offset optional | :: Vector | Offset of the sprite from the position of the entity. [...]
Offset of the sprite from the position of the entity. [...]
sprite optional | :: Sprite | The sprite to show. [...]
The sprite to show. [...]

## 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, 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`

## 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