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

ghost_role

these mob spawn subtypes do not trigger until attacked by a ghost.

Vars

ckeys_trying_to_spawnA list of the ckeys that currently are trying to access this spawner, so that they can't try to spawn more than once (in case there's sleeps). Static because you only really want to be able to spawn in one spawner at a time, obviously.
deletes_on_zero_uses_leftDoes the spawner delete itself when it runs out of uses?
flavour_textThis should be the actual instructions/description/context to the ghost role. This should be the really long explainy bit, basically.
important_textThis is critical non-policy information about the ghost role. Shown in the spawner menu and after spawning last.
prompt_ghostif false, you won't prompt for this role. best used for replacing the prompt system with something else like a radial, or something.
prompt_namea short, lowercase name for the mob used in possession prompt that pops up on ghost attacks. must be set.
role_ban/bans and policy which role to check for a job ban (ROLE_LAVALAND is the default ghost role ban)
show_flavorShow these on spawn? Usually used for hardcoded special flavor
spawner_job_pathTypepath indicating the kind of job datum this ghost role will have. PLEASE inherit this with a new job datum, it's not hard. jobs come with policy configs.
useshow many times this spawner can be used (it won't delete unless it's out of uses and the var to delete itself is set)
you_are_text/descriptions This should be the declaration of what the ghost role is, and maybe a short blurb after if you want. Shown in the spawner menu and after spawning first.

Procs

allow_spawnoverride this to add special spawn conditions to a ghost role
check_usesChecks if the spawner has zero uses left, if so, delete yourself... NOW!
create_from_ghostUses a use and creates a mob from a passed ghost

Var Details

ckeys_trying_to_spawn

A list of the ckeys that currently are trying to access this spawner, so that they can't try to spawn more than once (in case there's sleeps). Static because you only really want to be able to spawn in one spawner at a time, obviously.

deletes_on_zero_uses_left

Does the spawner delete itself when it runs out of uses?

flavour_text

This should be the actual instructions/description/context to the ghost role. This should be the really long explainy bit, basically.

important_text

This is critical non-policy information about the ghost role. Shown in the spawner menu and after spawning last.

prompt_ghost

if false, you won't prompt for this role. best used for replacing the prompt system with something else like a radial, or something.

prompt_name

a short, lowercase name for the mob used in possession prompt that pops up on ghost attacks. must be set.

role_ban

/bans and policy which role to check for a job ban (ROLE_LAVALAND is the default ghost role ban)

show_flavor

Show these on spawn? Usually used for hardcoded special flavor

spawner_job_path

Typepath indicating the kind of job datum this ghost role will have. PLEASE inherit this with a new job datum, it's not hard. jobs come with policy configs.

uses

how many times this spawner can be used (it won't delete unless it's out of uses and the var to delete itself is set)

you_are_text

/descriptions This should be the declaration of what the ghost role is, and maybe a short blurb after if you want. Shown in the spawner menu and after spawning first.

Proc Details

allow_spawn

override this to add special spawn conditions to a ghost role

check_uses

Checks if the spawner has zero uses left, if so, delete yourself... NOW!

create_from_ghost

Uses a use and creates a mob from a passed ghost

Does NOT validate that the spawn is possible or valid - assumes this has been done already!

If you are manually forcing a player into this mob spawn, you should be using this and not directly calling [proc/create].