Class StatusEffectState

Holds information about an active status effect.

Inheritance
System.Object
StatusEffectState
Namespace: Content.Shared.StatusEffect
Assembly: Content.Shared.dll
Syntax
public sealed class StatusEffectState : object

Constructors

| Improve this Doc View Source

StatusEffectState(StatusEffectState)

Declaration
public StatusEffectState(StatusEffectState toCopy)
Parameters
Type Name Description
StatusEffectState toCopy
| Improve this Doc View Source

StatusEffectState((TimeSpan, TimeSpan), Boolean, Nullable<String>)

Declaration
public StatusEffectState((TimeSpan, TimeSpan) cooldown, bool refresh, string? relevantComponent = null)
Parameters
Type Name Description
System.ValueTuple<TimeSpan, TimeSpan> cooldown
System.Boolean refresh
System.Nullable<System.String> relevantComponent

Fields

| Improve this Doc View Source

Cooldown

The start and end times of the status effect.

Declaration
public (TimeSpan, TimeSpan) Cooldown
Field Value
Type Description
System.ValueTuple<TimeSpan, TimeSpan>
| Improve this Doc View Source

CooldownRefresh

Specifies whether to refresh or accumulate the cooldown of the status effect. true - refresh time, false - accumulate time.

Declaration
public bool CooldownRefresh
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

RelevantComponent

The name of the relevant component that was added alongside the effect, if any.

Declaration
public string? RelevantComponent
Field Value
Type Description
System.Nullable<System.String>