Types/WorkingVisualisation: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (apply_tint formatting)
(Removed old prototype docs)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Used by crafting machines to display different graphics when the machine is running.
<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/types/WorkingVisualisation.html https://lua-api.factorio.com/latest/types/WorkingVisualisation.html]


== Optional properties ==
</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>
 
=== render_layer ===
'''Type''': [[Types/RenderLayer]]
 
'''Default''': "object"
 
=== fadeout ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== synced_fadeout ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== constant_speed ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
Whether the animations are always played at the same speed, not adjusted to the machine speed.
 
=== always_draw ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== animated_shift ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== align_to_waypoint ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== secondary_draw_order ===
'''Type''': [[Types/int8]]
 
Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.
 
=== draw_as_sprite ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== draw_as_light ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== light ===
'''Type''': [[Types/LightDefinition]]
 
=== effect ===
'''Type''': [[Types/string]]
 
Either "flicker", "uranium-glow" or "none".
 
=== apply_recipe_tint ===
'''Type''': [[Types/string]]
 
Either "primary", "secondary", "tertiary", "quaternary" or "none". Used by [[Prototype/CraftingMachine]].
 
=== apply_tint ===
'''Type''': [[Types/string]]
 
Either "resource-color", "input-fluid-base-color", "input-fluid-flow-color", "status" or "none". Used by [[Prototype/CraftingMachine]] ("status" only) and [[Prototype/MiningDrill]].
 
* For "status" on CraftingMachine, the colors are specified via [[Prototype/CraftingMachine#status_colors]].
* For "status" on MiningDrill, the colors are specified via [[Types/MiningDrillGraphicsSet#status_colors]].
* For "resource-color", the colors are specified via [[Prototype/ResourceEntity#mining_visualisation_tint]].
 
=== north_animation ===
'''Type''': [[Types/Animation]]
 
Either these animations for the directions are loaded (though they are still optional), or <code>animation</code> is loaded.
 
=== west_animation ===
'''Type''': [[Types/Animation]]
 
Either these animations for the directions are loaded (though they are still optional), or <code>animation</code> is loaded.
 
=== south_animation ===
'''Type''': [[Types/Animation]]
 
Either these animations for the directions are loaded (though they are still optional), or <code>animation</code> is loaded.
 
=== east_animation ===
'''Type''': [[Types/Animation]]
 
Either these animations for the directions are loaded (though they are still optional), or <code>animation</code> is loaded.
 
=== animation ===
'''Type''': [[Types/Animation]]
 
If this is present, this is loaded, otherwise the animation properties for each direction are loaded.
 
=== north_position ===
'''Type''': [[Types/vector]]
 
=== west_position ===
'''Type''': [[Types/vector]]
 
=== south_position ===
'''Type''': [[Types/vector]]
 
=== east_position ===
'''Type''': [[Types/vector]]

Latest revision as of 14:32, 25 October 2024

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/types/WorkingVisualisation.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.