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_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_category	Which ruleset flags to allow dynamic to use. NONE to disregard
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
lobby_buttons	Lobby buttons controlled by this trait
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
threat_reduction	If ran during dynamic, do we reduce the total threat? Will be overridden by config if set
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
Procs
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
destroy_lobby_buttons	Remove all of our active lobby buttons
get_decal_color	Return a color for the decals, if any
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 our lobby button is clicked on
on_lobby_button_destroyed	Don't hold references to deleted buttons
on_lobby_button_update_icon	Called when our lobby button tries to update its appearance
on_round_start	Proc ran when round starts. Use this for roundstart effects. By default we clean up our buttons here.
revert	Will attempt to revert the station trait, used by admins.
setup_lobby_button	Apply any additional handling we need to our lobby button

Var Details

var
abstract_type
–

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

var
blacklist
–

What traits are incompatible with this one?

var
can_revert
–

Whether or not this trait can be reverted by an admin

var
cost
–

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

var
dynamic_category
–

Which ruleset flags to allow dynamic to use. NONE to disregard

var
dynamic_threat_id
–

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

var
force
–

Whether this trait is always enabled; generally used for debugging

var
lobby_buttons
– /list

Lobby buttons controlled by this trait

var
name
–

Name of the trait

var
report_message
–

What message to show in the centcom report?

var
show_in_report
–

Does this trait show in the centcom report?

var
sign_up_button
–

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

var
threat_reduction
–

If ran during dynamic, do we reduce the total threat? Will be overridden by config if set

var
trait_flags
–

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

var
trait_processes
–

Whether or not this trait uses process()

var
trait_to_give
–

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

var
trait_type
–

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

var
weight
–

Chance relative to other traits of its type to be picked

Proc Details

proc
can_display_lobby_button
(/client/player)

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

proc
destroy_lobby_buttons
()

Remove all of our active lobby buttons

proc
get_decal_color
(thing_to_color, pattern)

Return a color for the decals, if any

proc
get_pulsar_message
()

Called when overriding a pulsar star command report message.

proc
get_report
()

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

proc
on_lobby_button_click
(/atom/movable/screen/lobby/button/sign_up/lobby_button, location, control, params, /mob/dead/new_player/user)

Called when our lobby button is clicked on

proc
on_lobby_button_destroyed
(/atom/movable/screen/lobby/button/sign_up/lobby_button)

Don't hold references to deleted buttons

proc
on_lobby_button_update_icon
(/atom/movable/screen/lobby/button/sign_up/lobby_button, updates)

Called when our lobby button tries to update its appearance

proc
on_round_start
()

Proc ran when round starts. Use this for roundstart effects. By default we clean up our buttons here.

proc
revert
()

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

proc
setup_lobby_button
(/atom/movable/screen/lobby/button/sign_up/lobby_button)

Apply any additional handling we need to our lobby button

station_trait /datum/station_trait

Vars

Procs

Var Details

var abstract_type –

var blacklist –

var can_revert –

var cost –

var dynamic_category –

var dynamic_threat_id –

var force –

var lobby_buttons – /list

var name –

var report_message –

var show_in_report –

var sign_up_button –

var threat_reduction –

var trait_flags –

var trait_processes –

var trait_to_give –

var trait_type –

var weight –