Types/BeaconGraphicsSet

From Official Factorio Wiki
Revision as of 17:51, 16 August 2023 by BilkaBot (talk | contribs) (Migrated prototype doc to separate website)
Jump to navigation Jump to search

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/BeaconGraphicsSet.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.


Used by Prototype/Beacon. This is a Types/table with the below properties.

Optional properties

draw_animation_when_idle

Type: bool

Default: true

draw_light_when_idle

Type: bool

Default: false

random_animation_offset

Type: bool

Default: false

module_icons_suppressed

Type: bool

Default: false

base_layer

Type: RenderLayer

Default: "object"

animation_layer

Type: RenderLayer

Default: "object"

top_layer

Type: RenderLayer

Default: "object"

animation_progress

Type: float

Default: 1

min_animation_progress

Type: float

Default: 0

max_animation_progress

Type: float

Default: 1000

apply_module_tint

Type: string

Default: "none"

One of "primary", "secondary", "tertiary", "quaternary" or "none". Which tint set in Prototype/Module#beacon_tint should be applied to this, if any.

apply_module_tint_to_light

Type: string

Default: "none"

One of "primary", "secondary", "tertiary", "quaternary" or "none". Which tint set in Prototype/Module#beacon_tint should be applied to the light, if any.

no_modules_tint

Type: Color

Default: no color

animation_list

Type: table (array) of AnimationElement

light

Type: LightDefinition

module_visualisations

Type: table (array) of BeaconModuleVisualizations

The visualisations available for displaying the modules in the beacon. The visualisation is chosen based on art style, see Types/BeaconModuleVisualizations#art_style and Prototype/Module#art_style.

module_tint_mode

Type: string

Default: "single-module"

One of "single-module" or "mix".