Class ReceivedHealContext

Namespace

ElectricDrill.AstraHealth.Heal

Assembly

com.electricdrill.astra-health.Runtime.dll

Immutable result of a heal operation as actually received by the target. Contains the resolved heal amount, source, involved entities and whether it was critical.

public sealed class ReceivedHealContext : IHasEntity, IHasTarget, IHasPerformer, IHasAmount, IHasInstigator, IReactable

Inheritance

object

ReceivedHealContext

Implements

IHasEntity

IHasTarget

IHasPerformer

IHasAmount

IHasInstigator

IReactable

Constructors

ReceivedHealContext(HealAmountContext, PreHealContext, EntityCore)

Create a ReceivedHealContext from the computed heal amount and the pre-heal context.

public ReceivedHealContext(HealAmountContext healAmount, PreHealContext preHealContext, EntityCore target)

Parameters

healAmount HealAmountContext

Resolved heal amount information.

preHealContext PreHealContext

Pre-heal context that produced metadata such as source and healer.

target EntityCore

Entity that will receive the heal.

Properties

Builder

Entry point to build a ReceivedHealContext using a step builder.

public static ReceivedHealContext.HealInfoAmount Builder { get; }

Property Value

ReceivedHealContext.HealInfoAmount

Entity

The entity that received the healing. Same as Target in this case.

public EntityCore Entity { get; }

Property Value

EntityCore

HealAmount

The calculated heal amount that will be applied to the target.

public HealAmountContext HealAmount { get; }

Property Value

HealAmountContext

HealSource

The HealSource that produced this heal.

public HealSourceSO HealSource { get; }

Property Value

HealSourceSO

Instigator

The specific thing that caused this heal — propagated from the originating PreHealContext. May be null if unspecified.

public IEffectInstigator Instigator { get; }

Property Value

IEffectInstigator

IsCritical

True if the heal was a critical heal.

public bool IsCritical { get; }

Property Value

bool

IsReactable

Propagated from IsReactable. When false, reactive systems should not respond to this heal event.

public bool IsReactable { get; }

Property Value

bool

Outcome

The overall result of this heal attempt. Prevented when the heal was ignored (e.g. a listener set Ignore to true); Applied otherwise.

public HealOutcome Outcome { get; }

Property Value

HealOutcome

Performer

The entity that performed the heal (may be null for system heals).

public EntityCore Performer { get; }

Property Value

EntityCore

Target

The entity that received the healing.

public EntityCore Target { get; }

Property Value

EntityCore