pathogen
Vars | |
affected_mob | The mob affected by this disease. Can be null. |
---|---|
affected_mob_is_only_carrier | If TRUE, the mob is a carrier only and does not feel the effects of the disease. |
bypasses_immunity | If TRUE, this disease can infact mobs that have the VIRUSIMMUNITY trait. |
contraction_chance_modifier | A modifier applied to contraction chance. |
copy_type | An optional typepath of disease to provide when Copy() is run. |
cure_chance | The probability of this infection being cured every second the cure is present |
cures | A list of reagent typepaths that are cures for the disease. |
infectable_biotypes | Biotypes that this pathogen can infect. |
infectivity | The probability of spreading through the air every second |
process_dead | If TRUE, stage_act() will be run even if the host is dead. |
required_organs | A list of organ and bodypart typepaths that are needed for this disease to be contracted. |
severity | The arbitrary severity of the disease |
stage_prob | The probability of this infection advancing a stage every second the cure is not present. |
viable_mobtypes | A list of mob typepaths that can carry this disease. |
Procs | |
admin_details | Return a string for admin logging uses, should describe the disease in detail |
airborne_spread | Attempt to spread to nearby mobs through the air. |
can_cure_affected | Returns TRUE if the affected mob can be cured. |
force_cure | Cure the disease and delete it. |
force_infect | Infect a mob with absolutely no safety checks. |
is_viable_mobtype | Checks the given typepath against the list of viable mobtypes. |
on_infect_mob | Called by force_infect() upon infecting a mob. |
on_process | Proc to process the disease and decide on whether to advance, cure or make the sympthoms appear. Returns a boolean on whether to continue acting on the symptoms or not. |
remove_disease_from_host | Removes the disease from the host mob. |
set_stage | Setter for the stage var, returns the old stage. |
try_infect | Attempt to infect a mob with this disease. Currently, only advance diseases can fail this. Returns TRUE on success. |
Var Details
affected_mob
The mob affected by this disease. Can be null.
affected_mob_is_only_carrier
If TRUE, the mob is a carrier only and does not feel the effects of the disease.
bypasses_immunity
If TRUE, this disease can infact mobs that have the VIRUSIMMUNITY trait.
contraction_chance_modifier
A modifier applied to contraction chance.
copy_type
An optional typepath of disease to provide when Copy() is run.
cure_chance
The probability of this infection being cured every second the cure is present
cures
A list of reagent typepaths that are cures for the disease.
infectable_biotypes
Biotypes that this pathogen can infect.
infectivity
The probability of spreading through the air every second
process_dead
If TRUE, stage_act() will be run even if the host is dead.
required_organs
A list of organ and bodypart typepaths that are needed for this disease to be contracted.
severity
The arbitrary severity of the disease
stage_prob
The probability of this infection advancing a stage every second the cure is not present.
viable_mobtypes
A list of mob typepaths that can carry this disease.
Proc Details
admin_details
Return a string for admin logging uses, should describe the disease in detail
airborne_spread
Attempt to spread to nearby mobs through the air.
can_cure_affected
Returns TRUE if the affected mob can be cured.
force_cure
Cure the disease and delete it.
force_infect
Infect a mob with absolutely no safety checks.
is_viable_mobtype
Checks the given typepath against the list of viable mobtypes.
Returns TRUE if the mob_type path is derived from of any entry in the viable_mobtypes list. Returns FALSE otherwise.
Arguments:
- mob_type - Type path to check against the viable_mobtypes list.
on_infect_mob
Called by force_infect() upon infecting a mob.
on_process
Proc to process the disease and decide on whether to advance, cure or make the sympthoms appear. Returns a boolean on whether to continue acting on the symptoms or not.
remove_disease_from_host
Removes the disease from the host mob.
set_stage
Setter for the stage var, returns the old stage.
try_infect
Attempt to infect a mob with this disease. Currently, only advance diseases can fail this. Returns TRUE on success.