Class AutoTranslatePayload

An SeString Payload containing an auto-translation/completion chat message.

Inheritance
System.Object
Payload
AutoTranslatePayload
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Dalamud.Game.Text.SeStringHandling.Payloads
Assembly: Dalamud.dll
Syntax
public class AutoTranslatePayload : Payload, ITextProvider

Constructors

| Improve this Doc View Source

AutoTranslatePayload(UInt32, UInt32)

Initializes a new instance of the AutoTranslatePayload class. Creates a new auto-translate payload.

Declaration
public AutoTranslatePayload(uint group, uint key)
Parameters
Type Name Description
System.UInt32 group

The group id for this message.
System.UInt32 key

The key/row id for this message. Which table this is in depends on the group id and details the Completion table.
Remarks

This table is somewhat complicated in structure, and so using this constructor may not be very nice. There is probably little use to create one of these, however.

Properties

| Improve this Doc View Source

Text

Gets the actual text displayed in-game for this payload.

Declaration
public string Text { get; }
Property Value
Type Description
System.String
Remarks

Value is evaluated lazily and cached.

| Improve this Doc View Source

Type

Gets the type of this payload.

Declaration
public override PayloadType Type { get; }
Property Value
Type Description
PayloadType
Overrides

Methods

| Improve this Doc View Source

DecodeImpl(BinaryReader, Int64)

Decodes a byte stream from the game into a payload object.

Declaration
protected override void DecodeImpl(BinaryReader reader, long endOfStream)
Parameters
Type Name Description
System.IO.BinaryReader reader

A BinaryReader containing at least all the data for this payload.
System.Int64 endOfStream

The location holding the end of the data for this payload.
Overrides
| Improve this Doc View Source

EncodeImpl()

Encodes the internal state of this payload into a byte[] suitable for sending to in-game handlers such as the chat log.

Declaration
protected override byte[] EncodeImpl()
Returns
Type Description
System.Byte[]

Encoded binary payload data suitable for use with in-game handlers.
Overrides
| Improve this Doc View Source

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
System.String

A string that represents the current object.
Overrides
System.Object.ToString()

Implements