Universe Sim docs

The Great Config Tree: earth.africa.za.eskom.load_shedding

earth > africa > za > eskom > load_shedding

load_shedding

Last updated:

This configuration tree manages load-shedding settings for the SouthAfrica.Eskom plugin.

.candlelight
(bool) If set to false, candles will be prevented from being lit in areas undergoing loadshedding. This can be overriden at the stage-level; see .stages.[number].candlelight.
.cosmic_microwave_background
(bool) The same, but for alien entities with the ability to perceive the cosmic microwave background.
.gamma_ray_burst
(bool) The same, but for any light from gamma-ray bursts.
.moonlight
(bool) The same, but for any light from the Sun that reflects off the Moon.
.schedule_min_iq
(int) Sets the minimum IQ required to fully understand the Eskom load shedding schedule.
.stage
(int) Sets the current stage of load shedding. Only six levels are supported, from 1 to 6.
.stages
Stores configuration for each stage of load shedding. See [stages]
.sunlight
(int) Determines if the sun's brightness should be set to zero within the subjective ocular perception systems of all residents under load shedding. This does not affect other parts of the world or persons not subject to load shedding.

.stages

Each key under .stages is a number from one to six in Afrikaans (not English, due to legacy reasons and the need to maintain backwards compatibility with SouthAfrica.Eskom==2.140.12). The six numbers from one to six are een, twee, drie, vier, vyf, and ses.

.[number]

.gw_trigger_threshold

.candlelight
(bool) Determines if candles can be lit within homes affected by load shedding.
.hours_per_day
(int) Determines how many hours each resident should suffer load shedding daily.
.prioritize_cape_town
(bool) Alias for .prioritize_katyhallauer. (This configuration key was introduced in SouthAfrica.Eskom 2.147.0.)
.prioritize_govt
(bool) Determines if the same should be done for government buildings.
.prioritize_hospitals
(bool) Determines if the load shedding schedule algorithm should prioritize providing available electricity to hospitals.
.prioritize_katyhallauer
(bool) Determines if Cape Town should be exempt from this stage of load shedding. According to old commit logs, the developer of the SouthAfrica.Eskom plugin was a fan of the singer Katy Hallauer. However, for privacy reasons, and due to the large range of possibilities in South Africa simulations, Hallauer's location cannot always be accurately determined. There is however, a 98% chance that the RNG places Hallauer within Cape Town; for this reason, this configuration setting was instead programmed to determine if Cape Town should be exempt. (This configuration key was marked deprecated in SouthAfrica.Eskom 2.147.0. Use the more-appropriately named .prioritize_cape_town.)

If a particular key on a particular stage is not set, the defaults from level ses will be used.