TileGhostPrototype - Prototype Docs

Home / Prototypes / TileGhostPrototype><

TileGhostPrototype 'tile-ghost' Example code

The entity used for tile ghosts.

Inherits from EntityPrototype « Prototype « PrototypeBase

Properties

default

sorted

No new properties

Inherited from EntityPrototype

icons optional	:: array[IconData]	This will be used in the electric network statistics, editor building selection, and the bonus gui. [...]
This will be used in the electric network statistics, editor building selection, and the bonus gui. [...]
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
collision_box optional	:: BoundingBox	Specification of the entity collision boundaries. [...]
Specification of the entity collision boundaries. [...]
collision_mask optional	:: CollisionMaskConnector	Defaults to the mask from UtilityConstants::default_collision_masks when indexed by the entity type.
Defaults to the mask from UtilityConstants::default_collision_masks when indexed by the entity type.
map_generator_bounding_box optional	:: BoundingBox	Used instead of the collision box during map generation. [...]
Used instead of the collision box during map generation. [...]
selection_box optional	:: BoundingBox	Specification of the entity selection area. [...]
Specification of the entity selection area. [...]
drawing_box_vertical_extension optional	:: double	Specification of extra vertical space needed to see the whole entity in GUIs. [...]
Specification of extra vertical space needed to see the whole entity in GUIs. [...]
sticker_box optional	:: BoundingBox	Used to specify the area where the sticker animation can appear for entities that can have stickers on them.
Used to specify the area where the sticker animation can appear for entities that can have stickers on them.
hit_visualization_box optional	:: BoundingBox	Where beams should hit the entity. [...]
Where beams should hit the entity. [...]
trigger_target_mask optional	:: TriggerTargetMask	Defaults to the mask from UtilityConstants::default_trigger_target_mask_by_type.
Defaults to the mask from UtilityConstants::default_trigger_target_mask_by_type.
flags optional	:: EntityPrototypeFlags
tile_buildability_rules optional	:: array[TileBuildabilityRule]
minable optional	:: MinableProperties	The item given to the player when they mine the entity and other properties relevant to mining this entity.
The item given to the player when they mine the entity and other properties relevant to mining this entity.
surface_conditions optional	:: array[SurfaceCondition]
deconstruction_alternative optional	:: EntityID	Used to merge multiple entities into one entry in the deconstruction planner.
Used to merge multiple entities into one entry in the deconstruction planner.
selection_priority optional	:: uint8	The entity with the higher number is selectable before the entity with the lower number. [...]
The entity with the higher number is selectable before the entity with the lower number. [...]
build_grid_size optional	:: uint8	Supported values are 1 (for 1x1 grid) and 2 (for 2x2 grid, like rails). [...]
Supported values are 1 (for 1x1 grid) and 2 (for 2x2 grid, like rails). [...]
remove_decoratives optional	:: `"automatic"` or `"true"` or `"false"`	Whether this entity should remove decoratives that collide with it when this entity is built. [...]
Whether this entity should remove decoratives that collide with it when this entity is built. [...]
emissions_per_second optional	:: dictionary[AirbornePollutantID → double]	Amount of emissions created (positive number) or cleaned (negative number) every second by the entity. [...]
Amount of emissions created (positive number) or cleaned (negative number) every second by the entity. [...]
shooting_cursor_size optional	:: double	The cursor size used when shooting at this entity.
The cursor size used when shooting at this entity.
created_smoke optional	:: CreateTrivialSmokeEffectItem	The smoke that is shown when the entity is placed.
The smoke that is shown when the entity is placed.
working_sound optional	:: WorkingSound	Will also work on entities that don't actually do work.
Will also work on entities that don't actually do work.
created_effect optional	:: Trigger	The effect/trigger that happens when the entity is placed.
The effect/trigger that happens when the entity is placed.
build_sound optional	:: Sound
mined_sound optional	:: Sound
mining_sound optional	:: Sound
rotated_sound optional	:: Sound
impact_category optional	:: string	Name of a ImpactCategory.
Name of a ImpactCategory.
open_sound optional	:: Sound
close_sound optional	:: Sound
placeable_position_visualization optional	:: Sprite
radius_visualisation_specification optional	:: RadiusVisualisationSpecification
stateless_visualisation optional	:: StatelessVisualisation or array[StatelessVisualisation]
draw_stateless_visualisations_in_ghost optional	:: boolean
build_base_evolution_requirement optional	:: double
alert_icon_shift optional	:: Vector
alert_icon_scale optional	:: float
fast_replaceable_group optional	:: string	This allows you to replace an entity that's already placed, with a different one in your inventory. [...]
This allows you to replace an entity that's already placed, with a different one in your inventory. [...]
next_upgrade optional	:: EntityID	Name of the entity that will be automatically selected as the upgrade of this entity when using the upgrade planner without configuration. [...]
Name of the entity that will be automatically selected as the upgrade of this entity when using the upgrade planner without configuration. [...]
protected_from_tile_building optional	:: boolean	When this is true, this entity prototype should be included during tile collision checks with tiles that have TilePrototype::check_collision_with_entities set to true.
When this is true, this entity prototype should be included during tile collision checks with tiles that have TilePrototype::check_collision_with_entities set to true.
heating_energy optional	:: Energy	This entity can freeze if heating_energy is larger than zero.
This entity can freeze if heating_energy is larger than zero.
allow_copy_paste optional	:: boolean
selectable_in_game optional	:: boolean
placeable_by optional	:: ItemToPlace or array[ItemToPlace]	Item that when placed creates this entity. [...]
Item that when placed creates this entity. [...]
remains_when_mined optional	:: EntityID or array[EntityID]	The entity that remains when this one is mined, deconstructed or fast-replaced. [...]
The entity that remains when this one is mined, deconstructed or fast-replaced. [...]
additional_pastable_entities optional	:: array[EntityID]	Names of the entity prototypes this entity prototype can be pasted on to in addition to the standard supported types. [...]
Names of the entity prototypes this entity prototype can be pasted on to in addition to the standard supported types. [...]
tile_width optional	:: int32	Used to determine how the center of the entity should be positioned when building (unless the off-grid flag is specified). [...]
Used to determine how the center of the entity should be positioned when building (unless the off-grid flag is specified). [...]
tile_height optional	:: int32
diagonal_tile_grid_size optional	:: TilePosition
autoplace optional	:: AutoplaceSpecification	Used to specify the rules for placing this entity during map generation.
Used to specify the rules for placing this entity during map generation.
map_color optional	:: Color
friendly_map_color optional	:: Color
enemy_map_color optional	:: Color
water_reflection optional	:: WaterReflectionDefinition	May also be defined inside `graphics_set` instead of directly in the entity prototype. [...]
May also be defined inside `graphics_set` instead of directly in the entity prototype. [...]
ambient_sounds_group optional	:: EntityID
ambient_sounds optional	:: WorldAmbientSoundDefinition or array[WorldAmbientSoundDefinition]
icon_draw_specification optional	:: IconDrawSpecification	Used to specify where and how the alt-mode icons should be drawn.
Used to specify where and how the alt-mode icons should be drawn.
icons_positioning optional	:: array[IconSequencePositioning]

Inherited from Prototype

factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]
custom_tooltip_fields optional	:: array[CustomTooltipField]	Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.

Inherited from PrototypeBase

type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_description optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden optional	:: boolean
hidden_in_factoriopedia optional	:: boolean
parameter optional	:: boolean	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulation optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

Example

{
  type = "tile-ghost",
  name = "tile-ghost",
  flags = {"not-on-map"},
  minable = { mining_time = 0, results={}},
  collision_box = {{-0.5, -0.5}, {0.5, 0.5}},
  selection_priority = 45
}

Factorio Prototype Docs Version 2.0.75

TileGhostPrototype 'tile-ghost' Example code

Properties

Example

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.0.75

TileGhostPrototype 'tile-ghost' Example code

Properties

Example

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.75