Prototype/HighlightBoxEntity: Difference between revisions
(Description extension for purpose and collision box) |
(Updated styling of prototype doc migration note) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/HighlightBoxEntityPrototype.html https://lua-api.factorio.com/latest/prototypes/HighlightBoxEntityPrototype.html] | |||
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | |||
{{Prototype parent|Prototype/Entity}} | {{Prototype parent|Prototype/Entity}} | ||
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. HighlightBoxEntity can also be independent from entities so it is simply drawn somewhere in the world. 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}} | ||
Latest revision as of 10:43, 21 September 2023
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/HighlightBoxEntityPrototype.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/HighlightBoxEntity
Used to attach graphics for cursor boxes to entities during runtime. HighlightBoxEntity can also be independent from entities so it is simply drawn somewhere in the world. 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.