/tg/ Station 13 - Modules - Types — Var Details - Proc Details

station_trait

Base class of station traits. These are used to influence rounds in one way or the other by influencing the levers of the station.

Vars

abstract_typeTrait should not be instantiated in a round if its type matches this type
blacklistWhat traits are incompatible with this one?
can_revertWhether or not this trait can be reverted by an admin
costThe cost of the trait, which is removed from the budget.
dynamic_threat_idThe ID that we look for in dynamic.json. Not synced with 'name' because I can already see this go wrong
forceWhether this trait is always enabled; generally used for debugging
nameName of the trait
report_messageWhat message to show in the centcom report?
show_in_reportDoes this trait show in the centcom report?
sign_up_buttonIf set to true we'll show a button on the lobby to notify people about this trait
trait_flagsExtra flags for station traits such as it being abstract, planetary or space only
trait_processesWhether or not this trait uses process()
trait_to_giveWhat code-trait does this station trait give? gives none if null
trait_typeThe type of this trait. Used to classify how this trait influences the station
weightChance relative to other traits of its type to be picked

Procs

can_display_lobby_buttonReturn TRUE if we want to show a lobby button, by default we assume we don't want it after the round begins
get_decal_colorReturn a color for the decals, if any
get_lobby_descriptionReturns the tooltip text for this trait's lobby button
get_lobby_icon_stateReturns the icon state for this trait's lobby button for a given player
get_lobby_overlay_statesReturns a list of overlay icon states to layer on top of the lobby button
get_pulsar_messageCalled when overriding a pulsar star command report message.
get_reportReturns the type of info the centcom report has on this trait, if any.
on_lobby_button_clickCalled when a player clicks this trait's lobby button. Return a string to show as feedback in the lobby UI.
on_round_startProc ran when round starts. Use this for roundstart effects.
revertWill attempt to revert the station trait, used by admins.

Var Details

abstract_type

Trait should not be instantiated in a round if its type matches this type

blacklist

What traits are incompatible with this one?

can_revert

Whether or not this trait can be reverted by an admin

cost

The cost of the trait, which is removed from the budget.

dynamic_threat_id

The ID that we look for in dynamic.json. Not synced with 'name' because I can already see this go wrong

force

Whether this trait is always enabled; generally used for debugging

name

Name of the trait

report_message

What message to show in the centcom report?

show_in_report

Does this trait show in the centcom report?

sign_up_button

If set to true we'll show a button on the lobby to notify people about this trait

trait_flags

Extra flags for station traits such as it being abstract, planetary or space only

trait_processes

Whether or not this trait uses process()

trait_to_give

What code-trait does this station trait give? gives none if null

trait_type

The type of this trait. Used to classify how this trait influences the station

weight

Chance relative to other traits of its type to be picked

Proc Details

can_display_lobby_button

Return TRUE if we want to show a lobby button, by default we assume we don't want it after the round begins

get_decal_color

Return a color for the decals, if any

get_lobby_description

Returns the tooltip text for this trait's lobby button

get_lobby_icon_state

Returns the icon state for this trait's lobby button for a given player

get_lobby_overlay_states

Returns a list of overlay icon states to layer on top of the lobby button

get_pulsar_message

Called when overriding a pulsar star command report message.

get_report

Returns the type of info the centcom report has on this trait, if any.

on_lobby_button_click

Called when a player clicks this trait's lobby button. Return a string to show as feedback in the lobby UI.

on_round_start

Proc ran when round starts. Use this for roundstart effects.

revert

Will attempt to revert the station trait, used by admins.