experiment

This is the base datum for experiments, storing the base definition.

This class should be subclassed for producing actual experiments. The proc stubs should be implemented in whole.

Vars
allowed_experimentors	A list of types that are allowed to experiment with this dastum
completed	Whether the experiment has been completed
description	A brief description of the experiment to be shown as details
exp_tag	A descriptive tag used on UI elements to denote 'types' of experiments
name	Name that distinguishes the experiment
performance_hint	A textual hint shown on the UI in a tooltip to help a user determine how to perform the experiment
points_reward	If set, these techweb points will be rewarded for completing the experiment. Useful for those loose ends not tied to any specific node discount or requirement.
traits	Traits related to the experiment
Procs
New	Performs any necessary initialization of tags and other variables
actionable	Gets if the experiment is actionable provided some arguments
check_progress	Gets the current progress towards the goal of the experiment
finish_experiment	Called when you complete an experiment, makes sure the techwebs knows the experiment was finished, and tells everyone it happend, yay!
is_complete	Checks if the experiment is complete
on_selected	Called when the experiment is selected by an experiment handler, for specific signals and the such.
on_unselected	Called when the opposite happens.
perform_experiment	Proc that tries to perform the experiment, and then checks if its completed.
perform_experiment_actions	Attempts to perform the experiment provided some arguments

Var Details

var
allowed_experimentors
– /list

A list of types that are allowed to experiment with this dastum

var
completed
–

Whether the experiment has been completed

var
description
–

A brief description of the experiment to be shown as details

var
exp_tag
–

A descriptive tag used on UI elements to denote 'types' of experiments

var
name
–

Name that distinguishes the experiment

var
performance_hint
–

A textual hint shown on the UI in a tooltip to help a user determine how to perform the experiment

var
points_reward
– /list

If set, these techweb points will be rewarded for completing the experiment. Useful for those loose ends not tied to any specific node discount or requirement.

var
traits
–

Traits related to the experiment

Proc Details

New
(/datum/techweb/techweb)

Performs any necessary initialization of tags and other variables

proc
actionable
(...)

Gets if the experiment is actionable provided some arguments

This proc should be overridden such that the return value is a boolean value representing if the experiment could be actioned with the provided arguments.

proc
check_progress
()

Gets the current progress towards the goal of the experiment

This proc should be overridden such that the return value is a list of lists, wherein each inner list represents a stage. Stages have types, see _DEFINES/experisci.dm. Each stage should be constructed using one of several available macros in that file.

proc
finish_experiment
(/datum/component/experiment_handler/experiment_handler)

Called when you complete an experiment, makes sure the techwebs knows the experiment was finished, and tells everyone it happend, yay!

proc
is_complete
()

Checks if the experiment is complete

This proc should be overridden such that it returns TRUE/FALSE to state if the experiment is complete or not.

proc
on_selected
(/datum/component/experiment_handler/experiment_handler)

Called when the experiment is selected by an experiment handler, for specific signals and the such.

proc
on_unselected
(/datum/component/experiment_handler/experiment_handler)

Called when the opposite happens.

proc
perform_experiment
(/datum/component/experiment_handler/experiment_handler, ...)

Proc that tries to perform the experiment, and then checks if its completed.

proc
perform_experiment_actions
(/datum/component/experiment_handler/experiment_handler, ...)

Attempts to perform the experiment provided some arguments

This proc should be overridden such that the experiment will be actioned with some defined arguments

Experiment /datum/experiment

Vars

Procs

Var Details

var allowed_experimentors – /list

var completed –

var description –

var exp_tag –

var name –

var performance_hint –

var points_reward – /list

var traits –

Proc Details

New(/datum/techweb/techweb)

proc actionable(...)

proc check_progress()

proc finish_experiment(/datum/component/experiment_handler/experiment_handler)

proc is_complete()

proc on_selected(/datum/component/experiment_handler/experiment_handler)

proc on_unselected(/datum/component/experiment_handler/experiment_handler)

proc perform_experiment(/datum/component/experiment_handler/experiment_handler, ...)

proc perform_experiment_actions(/datum/component/experiment_handler/experiment_handler, ...)