Show / Hide Table of Contents

Class SharedElectrocutionSystem

Inheritance
System.Object
SharedElectrocutionSystem
ElectrocutionSystem
ElectrocutionSystem
Namespace: Content.Shared.Electrocution
Assembly: Content.Shared.dll
Syntax
public abstract class SharedElectrocutionSystem : EntitySystem

Methods

| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
| Improve this Doc View Source

SetInsulatedSiemensCoefficient(EntityUid, Single, InsulatedComponent)

Declaration
public void SetInsulatedSiemensCoefficient(EntityUid uid, float siemensCoefficient, InsulatedComponent insulated = null)
Parameters
Type Name Description
EntityUid uid
System.Single siemensCoefficient
InsulatedComponent insulated
| Improve this Doc View Source

TryDoElectrocution(EntityUid, Nullable<EntityUid>, Int32, TimeSpan, Boolean, Single, StatusEffectsComponent, Boolean)

Declaration
public virtual bool TryDoElectrocution(EntityUid uid, EntityUid? sourceUid, int shockDamage, TimeSpan time, bool refresh, float siemensCoefficient = 1F, StatusEffectsComponent statusEffects = null, bool ignoreInsulation = false)
Parameters
Type Name Description
EntityUid uid

Entity being electrocuted.

System.Nullable<EntityUid> sourceUid

Source entity of the electrocution.

System.Int32 shockDamage

How much shock damage the entity takes.

TimeSpan time

How long the entity will be stunned.

System.Boolean refresh

Should be refreshed (instead of accumilated) if the entity is already electrocuted?

System.Single siemensCoefficient

How insulated the entity is from the shock. 0 means completely insulated, and 1 means no insulation.

StatusEffectsComponent statusEffects

Status effects to apply to the entity.

System.Boolean ignoreInsulation

Should the electrocution bypass the Insulated component?

Returns
Type Description
System.Boolean

Whether the entity was stunned by the shock.

  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾