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

Experiment Handler

This is the component for interacting with experiments from a connected techweb. It is generic and should be set-up to automatically work on any class it is attached to without outside code (Excluding potential callbacks)

Vars

allowed_experimentsHolds the list of types of experiments that this experiment_handler can interact with
blacklisted_experimentsHolds the list of types of experiments that this experimennt_handler should NOT interact with
config_flagsAdditional configuration flags for how the experiment_handler operates
disallowed_traitsA set of optional experiment traits (see defines) that are disallowed for any experiments
linked_webHolds the currently linked techweb to get experiments from
selected_experimentHolds the currently selected experiment
start_experiment_callbackCallback that, when supplied, can be called from the UI

Procs

InitializeInitializes a new instance of the experiment_handler component
action_experimentAttempts to perform the selected experiment given some arguments
announce_messageAnnounces a message to this experiment handler
announce_message_to_allAnnounces a message to all experiment handlers
can_select_experimentChecks if an experiment is valid to be selected by this handler
configure_experimentAttempts to show the user the experiment configuration panel
configure_experiment_clickAttempts to show the user the experiment configuration panel
get_available_serversAttempts to get rnd servers on the same z-level as a provided turf
ignored_handheld_experiment_attemptProvides feedback when an item isn't related to an experiment, and has fully passed the attack chain
link_experimentAttempts to link this experiment_handler to a provided experiment
link_techwebAttempts to link this experiment_handler to a provided techweb
should_run_handheld_experimentChecks that an experiment can be run using the provided target, used for preventing the cancellation of the attack chain inappropriately
try_run_destructive_experimentHooks on destructive scans to try and run an experiment (When using a handheld handler)
try_run_doppler_experimentHooks on successful explosions on the doppler array this is attached to
try_run_handheld_experimentHooks on attack to try and run an experiment (When using a handheld handler)
try_run_handheld_experiment_asyncThis proc exists because Jared Fogle really likes async
ui_handle_experimentHook for handling UI interaction via signals
unlink_experimentUnlinks this handler from the selected experiment
unlink_techwebUnlinks this handler from the selected techweb

Var Details

allowed_experiments

Holds the list of types of experiments that this experiment_handler can interact with

blacklisted_experiments

Holds the list of types of experiments that this experimennt_handler should NOT interact with

config_flags

Additional configuration flags for how the experiment_handler operates

disallowed_traits

A set of optional experiment traits (see defines) that are disallowed for any experiments

linked_web

Holds the currently linked techweb to get experiments from

selected_experiment

Holds the currently selected experiment

start_experiment_callback

Callback that, when supplied, can be called from the UI

Proc Details

Initialize

Initializes a new instance of the experiment_handler component

Arguments:

action_experiment

Attempts to perform the selected experiment given some arguments

announce_message

Announces a message to this experiment handler

Arguments:

announce_message_to_all

Announces a message to all experiment handlers

Arguments:

can_select_experiment

Checks if an experiment is valid to be selected by this handler

Arguments:

configure_experiment

Attempts to show the user the experiment configuration panel

Arguments:

configure_experiment_click

Attempts to show the user the experiment configuration panel

Arguments:

get_available_servers

Attempts to get rnd servers on the same z-level as a provided turf

Arguments:

ignored_handheld_experiment_attempt

Provides feedback when an item isn't related to an experiment, and has fully passed the attack chain

Attempts to link this experiment_handler to a provided experiment

Arguments:

Attempts to link this experiment_handler to a provided techweb

This proc attempts to link the handler to a provided techweb, overriding the existing techweb if relevant

Arguments:

should_run_handheld_experiment

Checks that an experiment can be run using the provided target, used for preventing the cancellation of the attack chain inappropriately

try_run_destructive_experiment

Hooks on destructive scans to try and run an experiment (When using a handheld handler)

try_run_doppler_experiment

Hooks on successful explosions on the doppler array this is attached to

try_run_handheld_experiment

Hooks on attack to try and run an experiment (When using a handheld handler)

try_run_handheld_experiment_async

This proc exists because Jared Fogle really likes async

ui_handle_experiment

Hook for handling UI interaction via signals

Unlinks this handler from the selected experiment

Unlinks this handler from the selected techweb