/tg/ Station 13 - Modules - TypesVar Details - Proc Details

ghost_role

Vars

cached_announcement_chanceA stored value of the event's announcement chance. Cached and not immediately used to prevent announcements for a failed event roll.
minimum_requiredThe minimum number of signups required for the event to continue past the polling period
role_nameThe name of the role, to be displayed in logs/polls/etc.
spawned_mobsA list of mobs generated by this event.
statusUsed to communicate the progress of the event firing, and whether or not the event was successfuly run.

Procs

spawn_rolePerforms the spawning of our role. Entirely specific to the event itself.
try_spawningAttempts to spawn the role, and cancels the event if it fails.

Var Details

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

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.

Proc Details

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.

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.