Struct AttributePointsChangeInfo

Namespace

ElectricDrill.AstraRpgFramework.Attributes

Assembly

com.electricdrill.astra-rpg-framework.Runtime.dll

Immutable structure that contains information about an attribute-points budget change (available and/or total attribute points moving), raised whenever level points, bonus points, or per-attribute spend/refund alter the budget.

public readonly struct AttributePointsChangeInfo : IHasEntity, IHasTarget

Implements

IHasEntity

IHasTarget

Constructors

AttributePointsChangeInfo(EntityAttributes, int, int, int, int)

Initializes a new instance of the AttributePointsChangeInfo structure.

public AttributePointsChangeInfo(EntityAttributes entityAttributes, int previousAvailable, int newAvailable, int previousTotal, int newTotal)

Parameters

entityAttributes EntityAttributes

previousAvailable int

newAvailable int

previousTotal int

newTotal int

Properties

Entity

The primary EntityCore associated with this object. For entity components this is the owning entity; for context payloads this is the primary affected subject (e.g. the event target).

public EntityCore Entity { get; }

Property Value

EntityCore

EntityAttributes

Gets the EntityAttributes instance whose points budget changed.

public EntityAttributes EntityAttributes { get; }

Property Value

EntityAttributes

NewAvailable

Gets the number of points available to spend after the change.

public int NewAvailable { get; }

Property Value

int

NewSpent

Gets the number of points spent after the change.

public int NewSpent { get; }

Property Value

int

NewTotal

Gets the total point budget after the change.

public int NewTotal { get; }

Property Value

int

PreviousAvailable

Gets the number of points available to spend before the change.

public int PreviousAvailable { get; }

Property Value

int

PreviousSpent

Gets the number of points spent before the change.

public int PreviousSpent { get; }

Property Value

int

PreviousTotal

Gets the total point budget before the change.

public int PreviousTotal { get; }

Property Value

int

Target

public EntityCore Target { get; }

Property Value

EntityCore