ghost_role

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

Vars
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.
computer_area	For figuring out where the local cryopod computer is. Must be set for cryo computer announcements.
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.
loadout_enabled	Can we use our loadout for this role?
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.
quirks_enabled	Can we use our quirks for this role?
random_appearance	Do we use a random appearance for this ghost role?
restricted_species	Are we limited to a certain species type? LISTED TYPE
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.
temp_body	Whether this offers a temporary body or not. Essentially, you'll be able to reenter your body after using this spawner.
use_outfit_name	set this to make the spawner use the outfit.name instead of its name var for things like cryo announcements and ghost records modifying the actual name during the game will cause issues with the GLOB.mob_spawners associative list
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.
Procs
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
get_spawner_outfit_name	Returns the the alt name for this spawner, which is 'outfit.name'.

Var Details

var
ckeys_trying_to_spawn
– /static/list

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.

var
computer_area
– /area

For figuring out where the local cryopod computer is. Must be set for cryo computer announcements.

var
deletes_on_zero_uses_left
–

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

var
flavour_text
–

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

var
important_text
–

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

var
loadout_enabled
–

Can we use our loadout for this role?

var
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.

var
prompt_name
–

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

var
quirks_enabled
–

Can we use our quirks for this role?

var
random_appearance
–

Do we use a random appearance for this ghost role?

var
restricted_species
–

Are we limited to a certain species type? LISTED TYPE

var
role_ban
–

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

var
show_flavor
–

Show these on spawn? Usually used for hardcoded special flavor

var
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.

var
temp_body
–

Whether this offers a temporary body or not. Essentially, you'll be able to reenter your body after using this spawner.

var
use_outfit_name
–

set this to make the spawner use the outfit.name instead of its name var for things like cryo announcements and ghost records modifying the actual name during the game will cause issues with the GLOB.mob_spawners associative list

var
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)

var
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

proc
allow_spawn
(/mob/user, silent)

override this to add special spawn conditions to a ghost role

proc
check_uses
()

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

proc
create_from_ghost
(/mob/dead/user)

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].

proc
get_spawner_outfit_name
()

Returns the the alt name for this spawner, which is 'outfit.name'.

For when you might want to use that for things instead of the name var. example: the DS2 spawners, which have a number of different types of spawner with the same name.

ghost_role /obj/effect/mob_spawn/ghost_role

Vars

Procs

Var Details

var ckeys_trying_to_spawn – /static/list

var computer_area – /area

var deletes_on_zero_uses_left –

var flavour_text –

var important_text –

var loadout_enabled –

var prompt_ghost –

var prompt_name –

var quirks_enabled –

var random_appearance –

var restricted_species –

var role_ban –

var show_flavor –

var spawner_job_path –

var temp_body –

var use_outfit_name –

var uses –

var you_are_text –