Class TextPayload
An SeString Payload representing a plain text string.
Assembly: Dalamud.dll
Declaration
public class TextPayload : Payload, ITextProvider
Inheritance: System.Object -> Dalamud.Game.Text.SeStringHandling.Payload
Implements:
Dalamud.Game.Text.SeStringHandling.ITextProvider
Properties
Type
Gets the type of this payload.
Declaration
public override PayloadType Type { get; }
Text
Gets or sets the text contained in this payload. This may contain SE's special unicode characters.
Declaration
[JsonIgnore]
public string? Text { get; set; }
Methods
ToString()
Declaration
public override string ToString()
Returns
System.String
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
System.Byte[]: Encoded binary payload data suitable for use with in-game handlers.
DecodeImpl(BinaryReader, long)
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. |