Struct CharacterMailAttachmentData

Namespace

FishMMO.Database.Data

Assembly

FishMMO-DB.dll

The attachment taken off one mail by a successful claim.

public struct CharacterMailAttachmentData

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Returned by ICharacterMailService.ClaimAttachmentAsync, which reads and clears the attachment columns in a single statement. These are the values as they stood before the clear — the whole point of the call, since after it the row holds zeroes.

A claim that finds nothing to take returns no data at all rather than a zeroed instance, so "there was an attachment worth nothing" and "there was no attachment" cannot be confused.

Constructors

CharacterMailAttachmentData(int, int, uint, int)

Initializes a claimed attachment.

public CharacterMailAttachmentData(int itemTemplateID, int itemSeed, uint itemAmount, int currencyAmount)

Parameters

itemTemplateID int

Template ID of the attached item.

itemSeed int

Generation seed of the attached item.

itemAmount uint

Stack size of the attached item.

currencyAmount int

Currency attached to the mail.

Fields

CurrencyAmount

Currency attached to the mail.

public readonly int CurrencyAmount

Field Value

int

ItemAmount

Stack size of the attached item.

public readonly uint ItemAmount

Field Value

uint

ItemSeed

Generation seed of the attached item.

public readonly int ItemSeed

Field Value

int

ItemTemplateID

Template ID of the attached item, or 0 when only currency was attached.

public readonly int ItemTemplateID

Field Value

int

Properties

HasAnything

True when this attachment carries an item or any currency.

public bool HasAnything { get; }

Property Value

bool