Table of Contents

Class PlayerDamaged

Namespace
Uncreated.Warfare.Events.Models.Players
Assembly
Uncreated.Warfare.dll

Invoked after a player takes damage, including the hit that kills them.

[EventModel(EventSynchronizationContext.Pure)]
public class PlayerDamaged : PlayerEvent, IPlayerEvent, IActionLoggableEvent
Inheritance
PlayerDamaged
Implements
Inherited Members

Constructors

PlayerDamaged(in DamagePlayerParameters)

public PlayerDamaged(in DamagePlayerParameters parameters)

Parameters

parameters DamagePlayerParameters

Properties

Instigator

Player who caused the damage.

public required WarfarePlayer? Instigator { get; init; }

Property Value

WarfarePlayer

IsDeath

If this damage killed the player.

public bool IsDeath { get; set; }

Property Value

bool

IsInjure

If this damage injured the player.

public bool IsInjure { get; set; }

Property Value

bool

Parameters

Properties for how players are damaged.

public ref readonly DamagePlayerParameters Parameters { get; }

Property Value

DamagePlayerParameters

Methods

GetActionLogEntry(IServiceProvider, ref ActionLogEntry[]?)

public ActionLogEntry GetActionLogEntry(IServiceProvider serviceProvider, ref ActionLogEntry[]? multipleEntries)

Parameters

serviceProvider IServiceProvider
multipleEntries ActionLogEntry[]

Returns

ActionLogEntry