ghost_role

Vars
cached_announcement_chance	A stored value of the event's announcement chance. Cached and not immediately used to prevent announcements for a failed event roll.
minimum_required	The minimum number of signups required for the event to continue past the polling period
priority_candidates	Members of this list will be placed at the front of the candicacy list, in front of the (shuffled) normal candidates.
role_name	The name of the role, to be displayed in logs/polls/etc.
spawned_mobs	A list of mobs generated by this event.
status	Used to communicate the progress of the event firing, and whether or not the event was successfuly run.
Procs
get_candidates	Gathers the candidates to select our ghost roles from.
spawn_role	Performs the spawning of our role. Entirely specific to the event itself.
try_spawning	Attempts to spawn the role, and cancels the event if it fails.

Var Details

var
cached_announcement_chance
–

A stored value of the event's announcement chance. Cached and not immediately used to prevent announcements for a failed event roll.

var
minimum_required
–

The minimum number of signups required for the event to continue past the polling period

var
priority_candidates
– /list

Members of this list will be placed at the front of the candicacy list, in front of the (shuffled) normal candidates.

var
role_name
–

The name of the role, to be displayed in logs/polls/etc.

var
spawned_mobs
– /list

A list of mobs generated by this event.

var
status
–

Used to communicate the progress of the event firing, and whether or not the event was successfuly run.

Proc Details

proc
get_candidates
(jobban, be_special)

Gathers the candidates to select our ghost roles from.

Returns a list of candidates in priority order, with candidates from priority_candidates first, and ghost roles randomly shuffled and appended after.

jobban - The jobban flag to exclude players from the polling pool with. be_special - The "special role" flag for the ghost candidacy poll.

proc
spawn_role
()

Performs the spawning of our role. Entirely specific to the event itself.

Should return SUCCESSFUL_SPAWN if role was successfully spawned, return NOT_ENOUGH_PLAYERS if less than mimimum_required was found, and return MAP_ERROR if a spawn location could not be found.

proc
try_spawning
()

Attempts to spawn the role, and cancels the event if it fails.

Pauses the event right as it begins, and waits for setup/polling to end. If successful, continues running the rest of the event and notifies ghosts.

ghost_role /datum/round_event/ghost_role

Vars

Procs

Var Details

var cached_announcement_chance –

var minimum_required –

var priority_candidates – /list

var role_name –

var spawned_mobs – /list

var status –