BeaconPrototype

Entity with the ability to transfer module effects to its neighboring entities.

Parent

• EntityWithOwnerPrototype

Properties

energy_usage

• Type: Energy
• Optional: false
• Override: false

The constant power usage of this beacon.

Examples

energy_usage = "480kW"

energy_source

• Type: ElectricEnergySource | VoidEnergySource
• Optional: false
• Override: false

supply_area_distance

• Type: uint32
• Optional: false
• Override: false

The maximum distance that this beacon can supply its neighbors with its module's effects. Max distance is 64.

distribution_effectivity

• Type: double
• Optional: false
• Override: false

The multiplier of the module's effects, when shared between neighbors.

distribution_effectivity_bonus_per_quality_level

• Type: double
• Optional: true
• Override: false

Must be 0 or positive.

module_slots

• Type: ItemStackIndex
• Optional: false
• Override: false

The number of module slots in this beacon.

quality_affects_module_slots

• Type: boolean
• Optional: true
• Override: false

If set, QualityPrototype::beacon_module_slots_bonus will be added to module slots count.

quality_affects_supply_area_distance

• Type: boolean
• Optional: true
• Override: false

If set, QualityPrototype::beacon_supply_area_distance_bonus will be added to supply_area_distance. Total value will be clamped to be within range [0, 64].

graphics_set

• Type: BeaconGraphicsSet
• Optional: true
• Override: false

The graphics for the beacon.

animation

• Type: Animation
• Optional: true
• Override: false

Only loaded if graphics_set is not defined.

The animation for the beacon, when in use.

base_picture

• Type: Animation
• Optional: true
• Override: false

Only loaded if graphics_set is not defined.

The picture of the beacon when it is not on.

perceived_performance

• Type: PerceivedPerformance
• Optional: true
• Override: false

Affects animation speed.

radius_visualisation_picture

• Type: Sprite
• Optional: true
• Override: false

allowed_effects

• Type: EffectTypeLimitation
• Optional: true
• Override: false

The types of modules that a player can place inside of the beacon.

allowed_module_categories

• Type: Array<ModuleCategoryID>
• Optional: true
• Override: false

Sets the module categories that are allowed to be inserted into this machine.

profile

• Type: Array<double>
• Optional: true
• Override: false

Extra multiplier applied to the effects received from beacon by the effect receiver based on amount of beacons that are in range of that effect receiver.

If there are more beacons that reach the effect receiver than there are entries in this array, then the last entry in the array is used for the multiplier.

If this is not defined, then an implicit profile of {1} will be used.

Examples

profile = {1, 0} -- entities do not receive any effects when they are in range of more than one beacon

beacon_counter

• Type: "total" | "same_type"
• Optional: true
• Override: false

The beacon counter used by effect receiver when deciding which sample to take from profile.