objective
Vars | |
completed | If the objective has been completed. |
---|---|
delayed_objective_text | What is the text we show when our objective is delayed? |
explanation_text | What the owner is supposed to do to complete the objective. |
flags_target | Contains the flags needed to meet the conditions of a valid target, such as mindshielded or syndicate agent. |
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. |
steal_list | If set, steal targets will be pulled from this list |
target | The target of the objective. |
target_amount | If they are focused on a particular number. Steal objectives have their own counter. |
target_department | The department that'll be targeted by this objective. If set, fills target_jobs with jobs from that department. |
target_jobs | List of jobs that the objective will target if possible, any crew if not. |
team | The team the objective belongs to, if any. |
Procs | |
establish_signals | This is for objectives that need to register signals, so place them in here. |
get_owners | Get all owners of the objective, including ones from the objective's team, if it has one. |
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. |
update_explanation_text | This is for objectives that have reason to update their text, such as target changes. |
Var Details
completed
If the objective has been completed.
delayed_objective_text
What is the text we show when our objective is delayed?
explanation_text
What the owner is supposed to do to complete the objective.
flags_target
Contains the flags needed to meet the conditions of a valid target, such as mindshielded or syndicate agent.
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.
steal_list
If set, steal targets will be pulled from this list
target
The target of the objective.
target_amount
If they are focused on a particular number. Steal objectives have their own counter.
target_department
The department that'll be targeted by this objective. If set, fills target_jobs with jobs from that department.
target_jobs
List of jobs that the objective will target if possible, any crew if not.
team
The team the objective belongs to, if any.
Proc Details
establish_signals
This is for objectives that need to register signals, so place them in here.
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.
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.
update_explanation_text
This is for objectives that have reason to update their text, such as target changes.