BandaStation - Modules - Types — Var Details - Proc Details

round_event_control

Vars

admin_disabledIf TRUE, the event won't run naturally/randomly. Toggled by admins.
admin_setupDatum that will handle admin options for forcing the event. If there are no options, just leave it as an empty list.
alert_observersShould we let the ghosts know this event is firing?
categoryThe category of the event
descriptionThe description of the event
earliest_startThe earliest world.time that an event can start (round-duration in deciseconds) default: 20 mins
holidayIDString which should be in the SSeventss.holidays list if you wish this event to be holiday-specific Anything with a (non-null) holidayID which does not match holiday, cannot run.
map_flagsFlags dictating whether this event should be run on certain kinds of map
max_occurrencesThe maximum number of times this event can occur (naturally), it can still be forced. Setting this to 0 effectively disables the event.
max_wizard_trigger_potencyMaximum wizard rituals at which to trigger this event, inclusive
min_playersThe minimum amount of alive, non-AFK human players on server required to start the event.
min_wizard_trigger_potencyMinimum wizard rituals at which to trigger this event, inclusive
nameThe human-readable name of the event
occurrencesHow many times this event has occurred This is incremented even if the event if forced
typepathThe typepath of the event datum /datum/round_event
weightThe weight this event has in the random-selection process. Higher weights are more likely to be picked. 10 is the default weight. 20 is twice more likely; 5 is half as likely as this default. 0 here does NOT disable the event, it just makes it extremely unlikely.
wizardeventWhether it's a "summon events" wizard event

Procs

valid_for_mapReturns true if event can run in current map

Var Details

admin_disabled

If TRUE, the event won't run naturally/randomly. Toggled by admins.

admin_setup

Datum that will handle admin options for forcing the event. If there are no options, just leave it as an empty list.

alert_observers

Should we let the ghosts know this event is firing?

category

The category of the event

description

The description of the event

earliest_start

The earliest world.time that an event can start (round-duration in deciseconds) default: 20 mins

holidayID

String which should be in the SSeventss.holidays list if you wish this event to be holiday-specific Anything with a (non-null) holidayID which does not match holiday, cannot run.

map_flags

Flags dictating whether this event should be run on certain kinds of map

max_occurrences

The maximum number of times this event can occur (naturally), it can still be forced. Setting this to 0 effectively disables the event.

max_wizard_trigger_potency

Maximum wizard rituals at which to trigger this event, inclusive

min_players

The minimum amount of alive, non-AFK human players on server required to start the event.

min_wizard_trigger_potency

Minimum wizard rituals at which to trigger this event, inclusive

name

The human-readable name of the event

occurrences

How many times this event has occurred This is incremented even if the event if forced

typepath

The typepath of the event datum /datum/round_event

weight

The weight this event has in the random-selection process. Higher weights are more likely to be picked. 10 is the default weight. 20 is twice more likely; 5 is half as likely as this default. 0 here does NOT disable the event, it just makes it extremely unlikely.

wizardevent

Whether it's a "summon events" wizard event

Proc Details

valid_for_map

Returns true if event can run in current map