Space Station 13 - Modules - TypesVar Details - Proc Details

objective

Vars

antag_menu_nameThis name displays in antag menu
check_cryoIf the objective goes cryo, do we check for a new objective or ignore it
completedIf the objective has been completed.
explanation_textWhat the owner is supposed to do to complete the objective.
martyr_compatibleIf the objective is compatible with martyr objective, i.e. if you can still do it while dead.
nameProper name of the objective. Not player facing, only shown to admins when adding objectives. Leave as null (or override to null) if you don't want admins to see that objective as a viable one to add (such as the mindslave objective).
needs_targetIf the objective should have find_target() called for it.
ownerOwner of the objective. Note that it's fine to set this directly, but when needing to check completion of the objective or otherwise check conditions on the owner of the objective, always use get_owners(), and check against ALL the owners. get_owners() accounts for objectives that may be team based and therefore have multiple owners.
targetThe target of the objective.
target_amountIf they are focused on a particular number. Steal objectives have their own counter.
teamThe team the objective belongs to, if any.

Procs

existing_targets_blacklistProc that forms a list of targets that are already exist for objective owners.
get_ownersGet all owners of the objective, including ones from the objective's team, if it has one.
is_special_deadBorgs, brains, AIs, etc count as dead for traitor objectives
on_target_cryoCalled when the objective's target goes to cryo.
post_target_cryoCalled a tick after when the objective's target goes to cryo.

Var Details

antag_menu_name

This name displays in antag menu

check_cryo

If the objective goes cryo, do we check for a new objective or ignore it

completed

If the objective has been completed.

explanation_text

What the owner is supposed to do to complete the objective.

martyr_compatible

If the objective is compatible with martyr objective, i.e. if you can still do it while dead.

name

Proper name of the objective. Not player facing, only shown to admins when adding objectives. Leave as null (or override to null) if you don't want admins to see that objective as a viable one to add (such as the mindslave objective).

needs_target

If the objective should have find_target() called for it.

owner

Owner of the objective. Note that it's fine to set this directly, but when needing to check completion of the objective or otherwise check conditions on the owner of the objective, always use get_owners(), and check against ALL the owners. get_owners() accounts for objectives that may be team based and therefore have multiple owners.

target

The target of the objective.

target_amount

If they are focused on a particular number. Steal objectives have their own counter.

team

The team the objective belongs to, if any.

Proc Details

existing_targets_blacklist

Proc that forms a list of targets that are already exist for objective owners.

get_owners

Get all owners of the objective, including ones from the objective's team, if it has one.

Use this over directly referencing owner in most cases.

is_special_dead

Borgs, brains, AIs, etc count as dead for traitor objectives

on_target_cryo

Called when the objective's target goes to cryo.

post_target_cryo

Called a tick after when the objective's target goes to cryo.