/tg/ Station 13 - Modules - TypesVar Details - Proc Details

clockwork_research

Vars

area_blacklistAreas where you can't be tasked to start a ritual.
area_whitelistValid areas where a research ritual may happen
descDesc of the research
loreExtra fluff text for your research, moreso lore bits
nameName of the research node
researchedIf this has been researched
selected_areaA typepath of the area that this research's ritual must be done in.
startingIf this is a starting research
tierWhat tier this is
time_to_researchHow long this research's ritual will take to complete
unlocked_recipesList of tinker cache items it unlocks
unlocked_scripturesList of scriptures this unlocks

Procs

check_is_place_goodMakes sure the area that the atom is attempting to research, is the correct area as specified by the datum. Returns FALSE otherwise
on_researchCalled when a research datum is fully researched
set_new_areaPick an an area for this research to take place in
validate_areaMakes sure the selected area is correct, and regenerates it if not. Only gets one reattempt before defaulting to the base station area (allowing it to happen anywhere).

Var Details

area_blacklist

Areas where you can't be tasked to start a ritual.

area_whitelist

Valid areas where a research ritual may happen

desc

Desc of the research

lore

Extra fluff text for your research, moreso lore bits

name

Name of the research node

researched

If this has been researched

selected_area

A typepath of the area that this research's ritual must be done in.

starting

If this is a starting research

tier

What tier this is

time_to_research

How long this research's ritual will take to complete

unlocked_recipes

List of tinker cache items it unlocks

unlocked_scriptures

List of scriptures this unlocks

Proc Details

check_is_place_good

Makes sure the area that the atom is attempting to research, is the correct area as specified by the datum. Returns FALSE otherwise

on_research

Called when a research datum is fully researched

set_new_area

Pick an an area for this research to take place in

validate_area

Makes sure the selected area is correct, and regenerates it if not. Only gets one reattempt before defaulting to the base station area (allowing it to happen anywhere).