Class ReagentEffect

Reagent effects describe behavior that occurs when a reagent is ingested and metabolized by some organ. They only trigger when all of Conditions are satisfied.

Inheritance
System.Object
ReagentEffect
AdjustSolutionTemperatureEffect
AdjustSolutionThermalEnergyEffect
AreaReactionEffect
ChemCleanBloodstream
CreateEntityReactionEffect
EmpReactionEffect
ExplosionReactionEffect
SetSolutionTemperatureEffect
ActivateArtifact
AddToSolutionReaction
AdjustAlert
AdjustReagent
AdjustTemperature
CauseZombieInfection
ChemHealEyeDamage
ChemVomit
CreateGas
CureZombieInfection
Drunk
Electrocute
Emote
ExtinguishReaction
FlammableReaction
HealthChange
Ignite
MakeSentient
ModifyBleedAmount
ModifyBloodLevel
ModifyLungGas
MovespeedModifier
Oxygenate
Paralyze
PlantAdjustAttribute
PlantCryoxadone
PlantDiethylamine
PlantPhalanximine
RobustHarvest
Polymorph
PopupMessage
ResetNarcolepsy
SatiateHunger
SatiateThirst
GenericStatusEffect
Jitter
WashCreamPieReaction
Namespace: Content.Shared.Chemistry.Reagent
Assembly: Content.Shared.dll
Syntax
public abstract class ReagentEffect : object

Fields

| Improve this Doc View Source

Conditions

The list of conditions required for the effect to activate. Not required.

Declaration
public ReagentEffectCondition[] Conditions
Field Value
Type Description
ReagentEffectCondition[]
| Improve this Doc View Source

Probability

What's the chance, from 0 to 1, that this effect will occur?

Declaration
public float Probability
Field Value
Type Description
System.Single

Properties

| Improve this Doc View Source

LogImpact

Declaration
public virtual LogImpact LogImpact { get; }
Property Value
Type Description
Content.Shared.Database.LogImpact
| Improve this Doc View Source

ReagentEffectFormat

Declaration
public virtual string ReagentEffectFormat { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ShouldLog

Should this reagent effect log at all?

Declaration
public virtual bool ShouldLog { get; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

Effect(ReagentEffectArgs)

Declaration
public abstract void Effect(ReagentEffectArgs args)
Parameters
Type Name Description
Content.Shared.Chemistry.Reagent.ReagentEffectArgs args
| Improve this Doc View Source

GuidebookEffectDescription(IPrototypeManager, IEntitySystemManager)

Produces a localized, bbcode'd guidebook description for this effect.

Declaration
public string? GuidebookEffectDescription(IPrototypeManager prototype, IEntitySystemManager entSys)
Parameters
Type Name Description
Robust.Shared.Prototypes.IPrototypeManager prototype
IEntitySystemManager entSys
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

ReagentEffectGuidebookText(IPrototypeManager, IEntitySystemManager)

Declaration
protected abstract string? ReagentEffectGuidebookText(IPrototypeManager prototype, IEntitySystemManager entSys)
Parameters
Type Name Description
Robust.Shared.Prototypes.IPrototypeManager prototype
IEntitySystemManager entSys
Returns
Type Description
System.Nullable<System.String>

Extension Methods