Prototype/HighlightBoxEntity: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Description extension for purpose and collision box)
mNo edit summary
Line 2: Line 2:
Used to attach graphics for [[Types/CursorBoxType|cursor boxes]] to entities during runtime. See [https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity LuaSurface.create_entity] for the available options for type "highlight-box".
Used to attach graphics for [[Types/CursorBoxType|cursor boxes]] to entities during runtime. See [https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity LuaSurface.create_entity] for the available options for type "highlight-box".


The <code>[[Prototype/Entity#collision_box|collision_box]]</code> of the highlight box prototype is ignored during runtime, instead the bounding_box given in create_entity or the selection box of the target entity is used.
The <code>[[Prototype/Entity#collision_box|collision_box]]</code> of the highlight box prototype is ignored during runtime, instead the "bounding_box" given in create_entity or the selection box of the target entity is used.


{{Prototype TOC|highlight-box|no-properties=true}}
{{Prototype TOC|highlight-box|no-properties=true}}

Revision as of 10:58, 27 April 2021

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/HighlightBoxEntity


Used to attach graphics for cursor boxes to entities during runtime. See LuaSurface.create_entity for the available options for type "highlight-box".

The collision_box of the highlight box prototype is ignored during runtime, instead the "bounding_box" given in create_entity or the selection box of the target entity is used.


Prototype/HighlightBoxEntity — highlight-box
No new properties
Inherited from Prototype/Entity
icons, icon, icon_size (IconSpecification)::IconSpecification
additional_pastable_entities::table of string (optional)
alert_icon_scale::float (optional)
alert_icon_shift::vector (optional)
allow_copy_paste::bool (optional)
autoplace::AutoplaceSpecification (optional)
build_base_evolution_requirement::double (optional)
build_grid_size::uint8 (optional)
build_sound::Sound (optional)
close_sound::Sound (optional)
collision_box::BoundingBox (optional)
collision_mask::CollisionMask (optional)
created_effect::Trigger (optional)
created_smoke::CreateTrivialSmokeEffectItem (optional)
drawing_box::BoundingBox (optional)
emissions_per_second::double (optional)
enemy_map_color::Color (optional)
fast_replaceable_group::string (optional)
flags::EntityPrototypeFlags (optional)
friendly_map_color::Color (optional)
hit_visualization_box::BoundingBox (optional)
map_color::Color (optional)
map_generator_bounding_box::BoundingBox (optional)
minable::MinableProperties (optional)
mined_sound::Sound (optional)
mining_sound::Sound (optional)
next_upgrade::string (optional)
open_sound::Sound (optional)
placeable_by::ItemToPlace or table of ItemToPlace (optional)
protected_from_tile_building::bool (optional)
radius_visualisation_specification::RadiusVisualisationSpecification (optional)
remains_when_mined::string or table of string (optional)
remove_decoratives::string (optional)
rotated_sound::Sound (optional)
selectable_in_game::bool (optional)
selection_box::BoundingBox (optional)
selection_priority::uint8 (optional)
shooting_cursor_size::double (optional)
sticker_box::BoundingBox (optional)
subgroup::string (optional)
tile_height::uint32 (optional)
tile_width::uint32 (optional)
trigger_target_mask::TriggerTargetMask (optional)
vehicle_impact_sound::Sound (optional)
water_reflection::WaterReflectionDefinition (optional)
working_sound::WorkingSound (optional)
Inherited from PrototypeBase
name::string
type::string
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)