artifact_effect

Vars
activated	is our artifact is processing
activation_aura_cost	activation cost for aura cast
activation_pulse_cost	activation cost for pulse cast
activation_touch_cost	activation cost for touch cast
artifact_id	used in radiocarbon_spectrometer
current_charge	current ammount of charges
holder	where are we
log_name	used for logs and science tool
maximum_charges	maximum ammount of charges
range	our effect range
recharge_speed	our recharge speed, process in artifact
release_method	what is our energy release method
trigger	our trigger to become activated
type_name	purely used for get_description
Procs
ToggleActivate	Invokes async toggle artifact
create_artifact_type	Picks artifact type. Chance is picked by weight
do_effect_aura	Tries to drain charge returns true if charge was drained, otherwise returns false
do_effect_destroy	Only called in artifact_unknown code on qdel
do_effect_pulse	Tries to drain charge returns true if charge was drained, otherwise returns false
do_effect_touch	Checks for a user, anomaly protection, tries to drain artifact charg returns true if charge was drained, otherwise returns false
get_description	Returns type effect used in artifact analyser
toggle_artifact_effect	Stops/starts processing, updates artifact icon, displays visible_message
try_drain_charge	Tries to subtract given number from current_charge returns true if the result above zero, returns false otherwise
turn_effect_off	Turns effect off, no icon update, doesnt display message
update_move	Updates effect on /move

Var Details

var
activated
–

is our artifact is processing

var
activation_aura_cost
–

activation cost for aura cast

var
activation_pulse_cost
–

activation cost for pulse cast

var
activation_touch_cost
–

activation cost for touch cast

var
artifact_id
–

used in radiocarbon_spectrometer

var
current_charge
–

current ammount of charges

var
holder
– /atom

where are we

var
log_name
–

used for logs and science tool

var
maximum_charges
–

maximum ammount of charges

var
range
–

our effect range

var
recharge_speed
–

our recharge speed, process in artifact

var
release_method
–

what is our energy release method

var
trigger
–

our trigger to become activated

var
type_name
–

purely used for get_description

Proc Details

proc
ToggleActivate
(reveal_toggle)

Invokes async toggle artifact

proc
create_artifact_type
(chance_small, chance_medium, chance_large)

Picks artifact type. Chance is picked by weight

Arguments:

chance_small - chance to pick small power
chance_medium - chance to pick medium power
chance_large - chance to pick large power

proc
do_effect_aura
(seconds_per_tick)

Tries to drain charge returns true if charge was drained, otherwise returns false

proc
do_effect_destroy
()

Only called in artifact_unknown code on qdel

proc
do_effect_pulse
(seconds_per_tick)

Tries to drain charge returns true if charge was drained, otherwise returns false

proc
do_effect_touch
(/mob/user)

Checks for a user, anomaly protection, tries to drain artifact charg returns true if charge was drained, otherwise returns false

Arguments:

user - mob, who touched the artifact

proc
get_description
()

Returns type effect used in artifact analyser

proc
toggle_artifact_effect
(reveal_toggle)

Stops/starts processing, updates artifact icon, displays visible_message

Arguments:

reveal_toggle - should we send the activation message to nearby mobs

proc
try_drain_charge
(charges_drained)

Tries to subtract given number from current_charge returns true if the result above zero, returns false otherwise

Arguments:

charges_drained - how much charges we try to drain

proc
turn_effect_off
()

Turns effect off, no icon update, doesnt display message

proc
update_move
()

Updates effect on /move

artifact_effect /datum/artifact_effect

Vars

Procs

Var Details

var activated –

var activation_aura_cost –

var activation_pulse_cost –

var activation_touch_cost –

var artifact_id –

var current_charge –

var holder – /atom

var log_name –

var maximum_charges –

var range –

var recharge_speed –

var release_method –

var trigger –

var type_name –

Proc Details

proc ToggleActivate(reveal_toggle)

proc create_artifact_type(chance_small, chance_medium, chance_large)

proc do_effect_aura(seconds_per_tick)

proc do_effect_destroy()

proc do_effect_pulse(seconds_per_tick)

proc do_effect_touch(/mob/user)

proc get_description()

proc toggle_artifact_effect(reveal_toggle)

proc try_drain_charge(charges_drained)

proc turn_effect_off()

proc update_move()

artifact_effect
/datum/artifact_effect

var
activated
–

var
activation_aura_cost
–

var
activation_pulse_cost
–

var
activation_touch_cost
–

var
artifact_id
–

var
current_charge
–

var
holder
– /atom

var
log_name
–

var
maximum_charges
–

var
range
–

var
recharge_speed
–

var
release_method
–

var
trigger
–

var
type_name
–

proc
ToggleActivate
(reveal_toggle)

proc
create_artifact_type
(chance_small, chance_medium, chance_large)

proc
do_effect_aura
(seconds_per_tick)

proc
do_effect_destroy
()

proc
do_effect_pulse
(seconds_per_tick)

proc
do_effect_touch
(/mob/user)

proc
get_description
()

proc
toggle_artifact_effect
(reveal_toggle)

proc
try_drain_charge
(charges_drained)

proc
turn_effect_off
()

proc
update_move
()