diff --git a/Dalamud/Interface/UiBuilder.cs b/Dalamud/Interface/UiBuilder.cs index fb61890f4..b6e4e0914 100644 --- a/Dalamud/Interface/UiBuilder.cs +++ b/Dalamud/Interface/UiBuilder.cs @@ -21,7 +21,7 @@ namespace Dalamud.Interface /// public static ImFontPtr DefaultFont => InterfaceManager.DefaultFont; /// - /// The default Dalamud icon font based on FontAwesome 5 Free solid in 20pt. + /// The default Dalamud icon font based on FontAwesome 5 Free solid in 17pt. /// public static ImFontPtr IconFont => InterfaceManager.IconFont; diff --git a/docs/api/Dalamud.Data.DataManager.html b/docs/api/Dalamud.Data.DataManager.html index e79294589..e68ba8d7a 100644 --- a/docs/api/Dalamud.Data.DataManager.html +++ b/docs/api/Dalamud.Data.DataManager.html @@ -118,7 +118,7 @@ Improve this Doc - View Source + View Source

DataManager(ClientLanguage)

@@ -147,12 +147,43 @@

Properties

+ + | + Improve this Doc + + + View Source + + +

ClientOpCodes

+

OpCodes sent by the client to the server.

+
+
+
Declaration
+
+
public ReadOnlyDictionary<string, ushort> ClientOpCodes { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Collections.ObjectModel.ReadOnlyDictionary<System.String, System.UInt16>
| Improve this Doc - View Source + View Source

Excel

@@ -183,7 +214,7 @@ Improve this Doc - View Source + View Source

IsDataReady

@@ -214,11 +245,12 @@ Improve this Doc - View Source + View Source

ServerOpCodes

-
+

OpCodes sent by the server to the client.

+
Declaration
@@ -246,7 +278,7 @@ Improve this Doc - View Source + View Source

GetExcelSheet<T>()

@@ -295,7 +327,7 @@ Improve this Doc - View Source + View Source

GetFile(String)

@@ -345,7 +377,7 @@ Improve this Doc - View Source + View Source

GetFile<T>(String)

@@ -412,7 +444,7 @@ Improve this Doc - View Source + View Source

GetIcon(ClientLanguage, Int32)

@@ -468,7 +500,7 @@ Improve this Doc - View Source + View Source

GetIcon(Int32)

@@ -518,7 +550,7 @@ Improve this Doc - View Source + View Source

GetIcon(String, Int32)

@@ -574,7 +606,7 @@ Improve this Doc - View Source + View Source

Initialize(String)

diff --git a/docs/api/Dalamud.Data.TransientSheet.Completion.html b/docs/api/Dalamud.Data.TransientSheet.Completion.html new file mode 100644 index 000000000..319dcf452 --- /dev/null +++ b/docs/api/Dalamud.Data.TransientSheet.Completion.html @@ -0,0 +1,411 @@ + + + + + + + + Class Completion + + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/docs/api/Dalamud.Data.TransientSheet.PetMirage.html b/docs/api/Dalamud.Data.TransientSheet.PetMirage.html new file mode 100644 index 000000000..ffe994c5f --- /dev/null +++ b/docs/api/Dalamud.Data.TransientSheet.PetMirage.html @@ -0,0 +1,2093 @@ + + + + + + + + Class PetMirage + + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/docs/api/Dalamud.Data.TransientSheet.html b/docs/api/Dalamud.Data.TransientSheet.html index c80364185..bd43fe6d5 100644 --- a/docs/api/Dalamud.Data.TransientSheet.html +++ b/docs/api/Dalamud.Data.TransientSheet.html @@ -77,10 +77,14 @@

Classes

+

Completion

+

ContentFinderCondition

Item

+

PetMirage

+
diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.EmbeddedInfoType.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.EmbeddedInfoType.html index 33635bbd5..061effaf2 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.EmbeddedInfoType.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.EmbeddedInfoType.html @@ -128,7 +128,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.IntegerType.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.IntegerType.html index bb32d7ca8..aaeb15869 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.IntegerType.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.IntegerType.html @@ -144,7 +144,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.SeStringChunkType.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.SeStringChunkType.html index 794cd8ed6..cdf0896f5 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.SeStringChunkType.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.SeStringChunkType.html @@ -95,6 +95,10 @@ AutoTranslateKey + + EmphasisItalic + + Interactable @@ -124,7 +128,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.html index e1b26e528..423b7a36b 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payload.html @@ -81,6 +81,7 @@
    System.Object
    Payload
    AutoTranslatePayload
    +
    EmphasisItalicPayload
    ItemPayload
    MapLinkPayload
    PlayerPayload
    @@ -120,14 +121,61 @@
    public abstract class Payload
    +

    Constructors +

    + + | + Improve this Doc + + + View Source + + +

    Payload()

    +
    +
    +
    Declaration
    +
    +
    protected Payload()
    +

    Fields

    + + | + Improve this Doc + + + View Source + +

    dataResolver

    +

    The Lumina instance to use for any necessary data lookups.

    +
    +
    +
    Declaration
    +
    +
    protected DataManager dataResolver
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    DataManager
    | Improve this Doc - View Source + View Source

    END_BYTE

    @@ -156,7 +204,7 @@ Improve this Doc - View Source + View Source

    START_BYTE

    @@ -182,16 +230,48 @@

    Properties

    + + | + Improve this Doc + + + View Source + + +

    Dirty

    +

    Whether this payload has been modified since the last Encode().

    +
    +
    +
    Declaration
    +
    +
    public bool Dirty { get; protected set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Boolean
    | Improve this Doc - View Source + View Source

    Type

    -
    +

    The type of this payload.

    +
    Declaration
    @@ -216,18 +296,160 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    -
    + +

    Decode(BinaryReader)

    +

    Decodes a binary representation of a payload into its corresponding nice object payload.

    +
    Declaration
    -
    public abstract byte[] Encode()
    +
    public static Payload Decode(BinaryReader reader)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.IO.BinaryReaderreader

    A reader positioned at the start of the payload, and containing at least one entire payload.

    +
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    Payload

    The constructed Payload-derived object that was decoded from the binary data.

    +
    + + | + Improve this Doc + + + View Source + + +

    DecodeImpl(BinaryReader, Int64)

    +

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

    +
    +
    +
    Declaration
    +
    +
    protected abstract void DecodeImpl(BinaryReader reader, long endOfStream)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.IO.BinaryReaderreader

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

    +
    System.Int64endOfStream

    The location holding the end of the data for this payload.

    +
    + + | + Improve this Doc + + + View Source + + +

    Encode(Boolean)

    +

    Encode this payload object into a byte[] useable in-game for things like the chat log.

    +
    +
    +
    Declaration
    +
    +
    public byte[] Encode(bool force = false)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.Booleanforce

    If true, ignores any cached value and forcibly reencodes the payload from its internal representation.

    +
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte[]

    A byte[] suitable for use with in-game handlers such as the chat log.

    +
    + + | + 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 abstract byte[] EncodeImpl()
    Returns
    @@ -240,7 +462,8 @@ - +
    System.Byte[]

    Encoded binary payload data suitable for use with in-game handlers.

    +
    @@ -249,7 +472,7 @@ Improve this Doc - View Source + View Source

    GetInteger(BinaryReader)

    @@ -296,7 +519,7 @@ Improve this Doc - View Source + View Source

    GetMarkerForIntegerBytes(Byte[])

    @@ -343,7 +566,7 @@ Improve this Doc - View Source + View Source

    GetMarkerForPackedIntegerBytes(Byte[])

    @@ -390,7 +613,7 @@ Improve this Doc - View Source + View Source

    GetPackedIntegers(BinaryReader)

    @@ -437,7 +660,7 @@ Improve this Doc - View Source + View Source

    MakeInteger(UInt32, Boolean, Boolean)

    @@ -494,7 +717,7 @@ Improve this Doc - View Source + View Source

    MakePackedInteger(UInt32, UInt32, Boolean)

    @@ -546,105 +769,6 @@ - - | - Improve this Doc - - - View Source - - -

    Process(BinaryReader)

    -
    -
    -
    Declaration
    -
    -
    public static Payload Process(BinaryReader reader)
    -
    -
    Parameters
    - - - - - - - - - - - - - - - -
    TypeNameDescription
    System.IO.BinaryReaderreader
    -
    Returns
    - - - - - - - - - - - - - -
    TypeDescription
    Payload
    - - | - Improve this Doc - - - View Source - - -

    ProcessChunkImpl(BinaryReader, Int64)

    -
    -
    -
    Declaration
    -
    -
    protected abstract void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    -
    -
    Parameters
    - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescription
    System.IO.BinaryReaderreader
    System.Int64endOfStream
    - - | - Improve this Doc - - - View Source - - -

    Resolve()

    -
    -
    -
    Declaration
    -
    -
    public abstract void Resolve()
    -
    @@ -656,7 +780,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.PayloadType.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.PayloadType.html index c79769c5a..83fd7be19 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.PayloadType.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.PayloadType.html @@ -95,6 +95,11 @@ AutoTranslateText

    An SeString payload representing an auto-translate dictionary entry.

    + + + + EmphasisItalic +

    An SeString payload representing italic emphasis formatting on text.

    diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.AutoTranslatePayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.AutoTranslatePayload.html index fa9fbf50a..173cb9507 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.AutoTranslatePayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.AutoTranslatePayload.html @@ -73,7 +73,8 @@

    Class AutoTranslatePayload

    -
    +

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

    +
    Inheritance
    @@ -84,7 +85,16 @@
    Inherited Members
    - Payload.Process(BinaryReader) + Payload.Dirty +
    +
    + Payload.dataResolver +
    +
    + Payload.Encode(Boolean) +
    +
    + Payload.Decode(BinaryReader)
    Payload.START_BYTE @@ -133,84 +143,71 @@
    Assembly: Dalamud.dll
    Syntax
    -
    public class AutoTranslatePayload : Payload
    +
    public class AutoTranslatePayload : Payload, ITextProvider
    -

    Properties +

    Constructors

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Group

    -
    + +

    AutoTranslatePayload(UInt32, UInt32)

    +

    Creates a new auto-translate payload.

    +
    Declaration
    -
    public uint Group { get; set; }
    +
    public AutoTranslatePayload(uint group, uint key)
    -
    Property Value
    +
    Parameters
    + - + + - -
    TypeName Description
    System.UInt32group

    The group id for this message.

    +
    - - | - Improve this Doc - - - View Source - - -

    Key

    -
    -
    -
    Declaration
    -
    -
    public uint Key { get; set; }
    -
    -
    Property Value
    - - - - - - - - - + +
    TypeDescription
    System.UInt32key

    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 + View Source

    Text

    -
    +

    The actual text displayed in-game for this payload.

    +
    Declaration
    -
    public string Text { get; set; }
    +
    public string Text { get; }
    Property Value
    @@ -227,12 +224,15 @@
    +
    Remarks
    +

    Value is evaluated lazily and cached.

    +
    | Improve this Doc - View Source + View Source

    Type

    @@ -263,50 +263,18 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    public override byte[] Encode()
    -
    -
    Returns
    - - - - - - - - - - - - - -
    TypeDescription
    System.Byte[]
    -
    Overrides
    -
    Payload.Encode()
    - - | - Improve this Doc - - - View Source - - -

    ProcessChunkImpl(BinaryReader, Int64)

    -
    -
    -
    Declaration
    -
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    Parameters
    @@ -331,30 +299,45 @@
    Overrides
    -
    Payload.ProcessChunkImpl(BinaryReader, Int64)
    +
    Payload.DecodeImpl(BinaryReader, Int64)
    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Resolve()

    + +

    EncodeImpl()

    Declaration
    -
    public override void Resolve()
    +
    protected override byte[] EncodeImpl()
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte[]
    Overrides
    -
    Payload.Resolve()
    +
    Payload.EncodeImpl()
    | Improve this Doc - View Source + View Source

    ToString()

    @@ -392,7 +375,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.EmphasisItalicPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.EmphasisItalicPayload.html new file mode 100644 index 000000000..7d3647597 --- /dev/null +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.EmphasisItalicPayload.html @@ -0,0 +1,461 @@ + + + + + + + + Class EmphasisItalicPayload + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + + + +
    + + + + + + diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.ItemPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.ItemPayload.html index 73caf3f5f..777fcfd55 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.ItemPayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.ItemPayload.html @@ -73,7 +73,8 @@

    Class ItemPayload

    -
    +

    An SeString Payload representing an interactable item link.

    +
    Inheritance
    @@ -84,7 +85,16 @@
    Inherited Members
    - Payload.Process(BinaryReader) + Payload.Dirty +
    +
    + Payload.dataResolver +
    +
    + Payload.Encode(Boolean) +
    +
    + Payload.Decode(BinaryReader)
    Payload.START_BYTE @@ -95,9 +105,6 @@ - @@ -136,33 +143,19 @@ | - Improve this Doc + Improve this Doc - View Source + View Source -

    ItemPayload()

    -
    +

    ItemPayload(UInt32, Boolean, String)

    +

    Creates a payload representing an interactable item link for the specified item.

    +
    Declaration
    -
    public ItemPayload()
    -
    - - | - Improve this Doc - - - View Source - - -

    ItemPayload(UInt32, Boolean)

    -
    -
    -
    Declaration
    -
    -
    public ItemPayload(uint itemId, bool isHQ)
    +
    public ItemPayload(uint itemId, bool isHQ, string displayNameOverride = null)
    Parameters
    @@ -177,27 +170,70 @@ - + - + + + + + +
    System.UInt32 itemId

    The id of the item.

    +
    System.Boolean isHQ

    Whether or not the link should be for the high-quality variant of the item.

    +
    System.StringdisplayNameOverride

    An optional name to include in the item link. Typically this should +be left as null, or set to the normal item name. Actual overrides are better done with the subsequent +TextPayload that is a part of a full item link in chat.

    +

    Properties

    + + | + Improve this Doc + + + View Source + + +

    DisplayName

    +

    The displayed name for this item link. Note that incoming links only sometimes have names embedded, +often the name is only present in a following text payload.

    +
    +
    +
    Declaration
    +
    +
    public string DisplayName { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String
    | Improve this Doc - View Source + View Source

    IsHQ

    -
    +

    Whether or not this item link is for a high-quality version of the item.

    +
    Declaration
    @@ -220,18 +256,19 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    ItemId

    -
    + +

    Item

    +

    The underlying Lumina Item represented by this payload.

    +
    Declaration
    -
    public uint ItemId { get; }
    +
    public Item Item { get; }
    Property Value
    @@ -243,47 +280,20 @@ - - - - -
    System.UInt32
    - - | - Improve this Doc - - - View Source - - -

    ItemName

    -
    -
    -
    Declaration
    -
    -
    public string ItemName { get; }
    -
    -
    Property Value
    - - - - - - - - - - +
    TypeDescription
    System.StringItem
    +
    Remarks
    +

    Value is evaluated lazily and cached.

    +
    | Improve this Doc - View Source + View Source

    Type

    @@ -314,18 +324,57 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    public override byte[] Encode()
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.IO.BinaryReaderreader
    System.Int64endOfStream
    +
    Overrides
    + + + | + Improve this Doc + + + View Source + + +

    EncodeImpl()

    +
    +
    +
    Declaration
    +
    +
    protected override byte[] EncodeImpl()
    Returns
    @@ -343,13 +392,13 @@
    Overrides
    - + | Improve this Doc - View Source + View Source

    GetMarkerForIntegerBytes(Byte[])

    @@ -395,18 +444,18 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    ProcessChunkImpl(BinaryReader, Int64)

    + +

    MakeInteger(UInt32, Boolean, Boolean)

    Declaration
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    +
    protected override byte[] MakeInteger(uint value, bool withMarker = true, bool incrementSmallInts = true)
    Parameters
    @@ -419,42 +468,45 @@ - - + + - - + + + + + + + + + + +
    System.IO.BinaryReaderreaderSystem.UInt32value
    System.Int64endOfStreamSystem.BooleanwithMarker
    System.BooleanincrementSmallInts
    +
    Returns
    + + + + + + + + + +
    TypeDescription
    System.Byte[]
    Overrides
    - - - | - Improve this Doc - - - View Source - - -

    Resolve()

    -
    -
    -
    Declaration
    -
    -
    public override void Resolve()
    -
    -
    Overrides
    - + | Improve this Doc - View Source + View Source

    ToString()

    @@ -492,7 +544,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.MapLinkPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.MapLinkPayload.html index 24af2cb5d..11bb649af 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.MapLinkPayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.MapLinkPayload.html @@ -73,7 +73,8 @@

    Class MapLinkPayload

    -
    +

    An SeString Payload representing an interactable map position link.

    +
    Inheritance
    @@ -84,7 +85,16 @@
    Inherited Members
    + + +
    Payload.START_BYTE @@ -132,112 +142,136 @@
    public class MapLinkPayload : Payload
    +

    Constructors +

    + + | + Improve this Doc + + + View Source + + +

    MapLinkPayload(UInt32, UInt32, Int32, Int32)

    +

    Creates an interactable MapLinkPayload from a raw position.

    +
    +
    +
    Declaration
    +
    +
    public MapLinkPayload(uint territoryTypeId, uint mapId, int rawX, int rawY)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.UInt32territoryTypeId

    The id of the TerritoryType entry for this link.

    +
    System.UInt32mapId

    The id of the Map entry for this link.

    +
    System.Int32rawX

    The internal raw x-coordinate for this link.

    +
    System.Int32rawY

    The internal raw y-coordinate for this link.

    +
    + + | + Improve this Doc + + + View Source + + +

    MapLinkPayload(UInt32, UInt32, Single, Single, Single)

    +

    Creates an interactable MapLinkPayload from a human-readable position.

    +
    +
    +
    Declaration
    +
    +
    public MapLinkPayload(uint territoryTypeId, uint mapId, float niceXCoord, float niceYCoord, float fudgeFactor = 0.05F)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.UInt32territoryTypeId

    The id of the TerritoryType entry for this link.

    +
    System.UInt32mapId

    The id of the Map entry for this link.

    +
    System.SingleniceXCoord

    The human-readable x-coordinate for this link.

    +
    System.SingleniceYCoord

    The human-readable y-coordinate for this link.

    +
    System.SinglefudgeFactor

    An optional offset to account for rounding and truncation errors; it is best to leave this untouched in most cases.

    +

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    MapId

    -
    + +

    CoordinateString

    +

    The printable map coordinates for this link. This value tries to match the in-game printable text as closely as possible +but is an approximation and may be slightly off for some positions.

    +
    Declaration
    -
    public uint MapId { get; set; }
    -
    -
    Property Value
    - - - - - - - - - - - - - -
    TypeDescription
    System.UInt32
    - - | - Improve this Doc - - - View Source - - -

    RawX

    -
    -
    -
    Declaration
    -
    -
    public uint RawX { get; set; }
    -
    -
    Property Value
    - - - - - - - - - - - - - -
    TypeDescription
    System.UInt32
    - - | - Improve this Doc - - - View Source - - -

    RawY

    -
    -
    -
    Declaration
    -
    -
    public uint RawY { get; set; }
    -
    -
    Property Value
    - - - - - - - - - - - - - -
    TypeDescription
    System.UInt32
    - - | - Improve this Doc - - - View Source - - -

    Territory

    -
    -
    -
    Declaration
    -
    -
    public string Territory { get; }
    +
    public string CoordinateString { get; }
    Property Value
    @@ -256,18 +290,19 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    TerritoryTypeId

    -
    + +

    DataString

    +

    The data string for this map link, for use by internal game functions that take a string variant and not a binary payload.

    +
    Declaration
    -
    public uint TerritoryTypeId { get; set; }
    +
    public string DataString { get; }
    Property Value
    @@ -279,17 +314,209 @@ - +
    System.UInt32System.String
    + + | + Improve this Doc + + + View Source + + +

    Map

    +

    The Map specified for this map link.

    +
    +
    +
    Declaration
    +
    +
    public Map Map { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    Lumina.Excel.GeneratedSheets.Map
    +
    Remarks
    +

    Value is evaluated lazily and cached.

    +
    + + | + Improve this Doc + + + View Source + + +

    PlaceName

    +

    The place name for this map link. This corresponds to the lower zone name found in the actual in-game map UI. eg, "Limsa Lominsa Upper Decks"

    +
    +
    +
    Declaration
    +
    +
    public string PlaceName { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String
    + + | + Improve this Doc + + + View Source + + +

    PlaceNameRegion

    +

    The region name for this map link. This corresponds to the upper zone name found in the actual in-game map UI. eg, "La Noscea"

    +
    +
    +
    Declaration
    +
    +
    public string PlaceNameRegion { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String
    + + | + Improve this Doc + + + View Source + + +

    RawX

    +

    The internal x-coordinate for this map position.

    +
    +
    +
    Declaration
    +
    +
    public int RawX { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Int32
    + + | + Improve this Doc + + + View Source + + +

    RawY

    +

    The internal y-coordinate for this map position.

    +
    +
    +
    Declaration
    +
    +
    public int RawY { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Int32
    + + | + Improve this Doc + + + View Source + + +

    TerritoryType

    +

    The TerritoryType specified for this map link.

    +
    +
    +
    Declaration
    +
    +
    public TerritoryType TerritoryType { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    Lumina.Excel.GeneratedSheets.TerritoryType
    +
    Remarks
    +

    Value is evaluated lazily and cached.

    +
    | Improve this Doc - View Source + View Source

    Type

    @@ -321,11 +548,12 @@ Improve this Doc - View Source + View Source

    XCoord

    -
    +

    The readable x-coordinate position for this map link. This value is approximate and unrounded.

    +
    Declaration
    @@ -351,11 +579,12 @@ Improve this Doc - View Source + View Source

    YCoord

    -
    +

    The readable y-coordinate position for this map link. This value is approximate and unrounded.

    +
    Declaration
    @@ -376,52 +605,61 @@ +

    Methods +

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Zone

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    public string Zone { get; }
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    -
    Property Value
    +
    Parameters
    + - + + + + + + +
    TypeName Description
    System.StringSystem.IO.BinaryReaderreader
    System.Int64endOfStream
    -

    Methods -

    +
    Overrides
    + | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    + +

    EncodeImpl()

    Declaration
    -
    public override byte[] Encode()
    +
    protected override byte[] EncodeImpl()
    Returns
    @@ -439,13 +677,13 @@
    Overrides
    - + | Improve this Doc - View Source + View Source

    GetMarkerForIntegerBytes(Byte[])

    @@ -489,68 +727,12 @@
    Overrides
    - - | - Improve this Doc - - - View Source - - -

    ProcessChunkImpl(BinaryReader, Int64)

    -
    -
    -
    Declaration
    -
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    -
    -
    Parameters
    - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescription
    System.IO.BinaryReaderreader
    System.Int64endOfStream
    -
    Overrides
    - - - | - Improve this Doc - - - View Source - - -

    Resolve()

    -
    -
    -
    Declaration
    -
    -
    public override void Resolve()
    -
    -
    Overrides
    - | Improve this Doc - View Source + View Source

    ToString()

    @@ -588,7 +770,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.PlayerPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.PlayerPayload.html index 460e02d2c..d977cc9f1 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.PlayerPayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.PlayerPayload.html @@ -73,7 +73,8 @@

    Class PlayerPayload

    -
    +

    An SeString Payload representing a player link.

    +
    Inheritance
    @@ -84,7 +85,16 @@
    Inherited Members
    + + +
    Payload.START_BYTE @@ -137,31 +147,17 @@

    Constructors

    - - | - Improve this Doc - - - View Source - - -

    PlayerPayload()

    -
    -
    -
    Declaration
    -
    -
    public PlayerPayload()
    -
    | Improve this Doc - View Source + View Source

    PlayerPayload(String, UInt32)

    -
    +

    Create a PlayerPayload link for the specified player.

    +
    Declaration
    @@ -180,12 +176,14 @@ System.String playerName - +

    The player's displayed name.

    + System.UInt32 serverId - +

    The player's home server id.

    + @@ -193,18 +191,20 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    PlayerName

    -
    + +

    DisplayedName

    +

    A text representation of this player link matching how it might appear in-game. +The world name will always be present.

    +
    Declaration
    -
    public string PlayerName { get; }
    +
    public string DisplayedName { get; }
    Property Value
    @@ -223,48 +223,19 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    ServerId

    -
    + +

    PlayerName

    +

    The player's displayed name. This does not contain the server name.

    +
    Declaration
    -
    public uint ServerId { get; }
    -
    -
    Property Value
    - - - - - - - - - - - - - -
    TypeDescription
    System.UInt32
    - - | - Improve this Doc - - - View Source - - -

    ServerName

    -
    -
    -
    Declaration
    -
    -
    public string ServerName { get; }
    +
    public string PlayerName { get; set; }
    Property Value
    @@ -286,7 +257,7 @@ Improve this Doc - View Source + View Source

    Type

    @@ -313,24 +284,23 @@
    Overrides
    -

    Methods -

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    -
    + +

    World

    +

    The Lumina object representing the player's home server.

    +
    Declaration
    -
    public override byte[] Encode()
    +
    public World World { get; }
    -
    Returns
    +
    Property Value
    @@ -340,27 +310,30 @@ - +
    System.Byte[]Lumina.Excel.GeneratedSheets.World
    -
    Overrides
    - +
    Remarks
    +

    Value is evaluated lazily and cached.

    +
    +

    Methods +

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    ProcessChunkImpl(BinaryReader, Int64)

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    Parameters
    @@ -385,30 +358,45 @@
    Overrides
    - + | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Resolve()

    + +

    EncodeImpl()

    Declaration
    -
    public override void Resolve()
    +
    protected override byte[] EncodeImpl()
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte[]
    Overrides
    - + | Improve this Doc - View Source + View Source

    ToString()

    @@ -446,7 +434,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.RawPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.RawPayload.html index 23bd2aac0..691a21dc6 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.RawPayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.RawPayload.html @@ -73,7 +73,10 @@

    Class RawPayload

    -
    +

    An SeString Payload representing unhandled raw payload data. +Mainly useful for constructing unhandled hardcoded payloads, or forwarding any unknown +payloads without modification.

    +
    Inheritance
    @@ -84,7 +87,16 @@
    Inherited Members
    + + +
    Payload.START_BYTE @@ -139,18 +151,18 @@ | - Improve this Doc + Improve this Doc - View Source + View Source -

    RawPayload(Byte)

    +

    RawPayload(Byte[])

    Declaration
    -
    public RawPayload(byte chunkType)
    +
    public RawPayload(byte[] data)
    Parameters
    @@ -163,54 +175,26 @@ - - + +
    System.BytechunkTypeSystem.Byte[]data

    Properties

    - - | - Improve this Doc - - - View Source - - -

    ChunkType

    -
    -
    -
    Declaration
    -
    -
    public byte ChunkType { get; }
    -
    -
    Property Value
    - - - - - - - - - - - - - -
    TypeDescription
    System.Byte
    | Improve this Doc - View Source + View Source

    Data

    -
    +

    The entire payload byte sequence for this payload. +The returned data is a clone and modifications will not be persisted.

    +
    Declaration
    @@ -231,12 +215,43 @@ + + | + Improve this Doc + + + View Source + + +

    LinkTerminator

    +

    A fixed Payload representing a common link-termination sequence, found in many payload chains.

    +
    +
    +
    Declaration
    +
    +
    public static RawPayload LinkTerminator { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    RawPayload
    | Improve this Doc - View Source + View Source

    Type

    @@ -267,50 +282,18 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    public override byte[] Encode()
    -
    -
    Returns
    - - - - - - - - - - - - - -
    TypeDescription
    System.Byte[]
    -
    Overrides
    - - - | - Improve this Doc - - - View Source - - -

    ProcessChunkImpl(BinaryReader, Int64)

    -
    -
    -
    Declaration
    -
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    Parameters
    @@ -335,30 +318,45 @@
    Overrides
    - + | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Resolve()

    + +

    EncodeImpl()

    Declaration
    -
    public override void Resolve()
    +
    protected override byte[] EncodeImpl()
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte[]
    Overrides
    - + | Improve this Doc - View Source + View Source

    ToString()

    @@ -396,7 +394,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.StatusPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.StatusPayload.html index 11df58987..cf80449c3 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.StatusPayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.StatusPayload.html @@ -73,7 +73,8 @@

    Class StatusPayload

    -
    +

    An SeString Payload representing an interactable status link.

    +
    Inheritance
    @@ -84,7 +85,16 @@
    Inherited Members
    + + +
    Payload.START_BYTE @@ -137,31 +147,17 @@

    Constructors

    - - | - Improve this Doc - - - View Source - - -

    StatusPayload()

    -
    -
    -
    Declaration
    -
    -
    public StatusPayload()
    -
    | Improve this Doc - View Source + View Source

    StatusPayload(UInt32)

    -
    +

    Creates a new StatusPayload for the given status id.

    +
    Declaration
    @@ -180,7 +176,8 @@ System.UInt32 statusId - +

    The id of the Status for this link.

    + @@ -188,18 +185,19 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    StatusId

    -
    + +

    Status

    +

    The Lumina Status object represented by this payload.

    +
    Declaration
    -
    public uint StatusId { get; }
    +
    public Status Status { get; }
    Property Value
    @@ -211,47 +209,20 @@ - - - - -
    System.UInt32
    - - | - Improve this Doc - - - View Source - - -

    StatusName

    -
    -
    -
    Declaration
    -
    -
    public string StatusName { get; }
    -
    -
    Property Value
    - - - - - - - - - - +
    TypeDescription
    System.StringLumina.Excel.GeneratedSheets.Status
    +
    Remarks
    +

    Value is evaluated lazily and cached.

    +
    | Improve this Doc - View Source + View Source

    Type

    @@ -282,50 +253,18 @@ | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    public override byte[] Encode()
    -
    -
    Returns
    - - - - - - - - - - - - - -
    TypeDescription
    System.Byte[]
    -
    Overrides
    - - - | - Improve this Doc - - - View Source - - -

    ProcessChunkImpl(BinaryReader, Int64)

    -
    -
    -
    Declaration
    -
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    Parameters
    @@ -350,30 +289,45 @@
    Overrides
    - + | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Resolve()

    + +

    EncodeImpl()

    Declaration
    -
    public override void Resolve()
    +
    protected override byte[] EncodeImpl()
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte[]
    Overrides
    - + | Improve this Doc - View Source + View Source

    ToString()

    @@ -411,7 +365,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.TextPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.TextPayload.html index 3d3b7eb9b..3852b0891 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.TextPayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.TextPayload.html @@ -73,7 +73,8 @@

    Class TextPayload

    -
    +

    An SeString Payload representing a plain text string.

    +
    Inheritance
    @@ -84,7 +85,16 @@
    Inherited Members
    + + +
    Payload.START_BYTE @@ -133,35 +143,21 @@
    Assembly: Dalamud.dll
    Syntax
    -
    public class TextPayload : Payload
    +
    public class TextPayload : Payload, ITextProvider

    Constructors

    - - | - Improve this Doc - - - View Source - - -

    TextPayload()

    -
    -
    -
    Declaration
    -
    -
    public TextPayload()
    -
    | Improve this Doc - View Source + View Source

    TextPayload(String)

    -
    +

    Creates a new TextPayload for the given text.

    +
    Declaration
    @@ -180,54 +176,24 @@ System.String text - +

    The text to include for this payload.

    +

    Properties

    - - | - Improve this Doc - - - View Source - - -

    RawData

    -

    The raw unconverted data of this text payload.

    -
    -
    -
    Declaration
    -
    -
    public byte[] RawData { get; set; }
    -
    -
    Property Value
    - - - - - - - - - - - - - -
    TypeDescription
    System.Byte[]
    | Improve this Doc - View Source + View Source

    Text

    -

    The Text of this text payload as an UTF-8 converted string. -Don't rely on this for accurate representation of SE payload data, please check RawData instead.

    +

    The text contained in this payload. +This may contain SE's special unicode characters.

    Declaration
    @@ -254,7 +220,7 @@ Don't rely on this for accurate representation of SE payload data, please check Improve this Doc - View Source + View Source

    Type

    @@ -285,50 +251,18 @@ Don't rely on this for accurate representation of SE payload data, please check | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    public override byte[] Encode()
    -
    -
    Returns
    - - - - - - - - - - - - - -
    TypeDescription
    System.Byte[]
    -
    Overrides
    - - - | - Improve this Doc - - - View Source - - -

    ProcessChunkImpl(BinaryReader, Int64)

    -
    -
    -
    Declaration
    -
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    Parameters
    @@ -353,30 +287,45 @@ Don't rely on this for accurate representation of SE payload data, please check
    Overrides
    - + | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Resolve()

    + +

    EncodeImpl()

    Declaration
    -
    public override void Resolve()
    +
    protected override byte[] EncodeImpl()
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte[]
    Overrides
    - + | Improve this Doc - View Source + View Source

    ToString()

    @@ -414,7 +363,7 @@ Don't rely on this for accurate representation of SE payload data, please check Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.UIForegroundPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.UIForegroundPayload.html index 629897566..29d39d793 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.UIForegroundPayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.UIForegroundPayload.html @@ -73,7 +73,8 @@

    Class UIForegroundPayload

    -
    +

    An SeString Payload representing a UI foreground color applied to following text payloads.

    +
    Inheritance
    @@ -84,7 +85,16 @@
    Inherited Members
    + + +
    Payload.START_BYTE @@ -132,22 +142,58 @@
    public class UIForegroundPayload : Payload
    +

    Constructors +

    + + | + Improve this Doc + + + View Source + + +

    UIForegroundPayload(UInt16)

    +

    Creates a new UIForegroundPayload for the given UIColor key.

    +
    +
    +
    Declaration
    +
    +
    public UIForegroundPayload(ushort colorKey)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.UInt16colorKey

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    RawColor

    -
    + +

    ColorKey

    +

    The color key used as a lookup in the UIColor table for this foreground color.

    +
    Declaration
    -
    public ushort RawColor { get; }
    +
    public ushort ColorKey { get; set; }
    Property Value
    @@ -164,12 +210,74 @@
    + + | + Improve this Doc + + + View Source + + +

    IsEnabled

    +

    Whether or not this payload represents applying a foreground color, or disabling one.

    +
    +
    +
    Declaration
    +
    +
    public bool IsEnabled { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Boolean
    + + | + Improve this Doc + + + View Source + + +

    RGB

    +

    The Red/Green/Blue values for this foreground color, encoded as a typical hex color.

    +
    +
    +
    Declaration
    +
    +
    public uint RGB { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.UInt32
    | Improve this Doc - View Source + View Source

    Type

    @@ -196,22 +304,126 @@
    Overrides
    + + | + Improve this Doc + + + View Source + + +

    UIColor

    +

    A Lumina UIColor object representing this payload. The actual color data is at UIColor.UIForeground

    +
    +
    +
    Declaration
    +
    +
    public UIColor UIColor { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    Lumina.Excel.GeneratedSheets.UIColor
    +
    Remarks
    +

    Value is evaluated lazily and cached.

    +
    + + | + Improve this Doc + + + View Source + + +

    UIForegroundOff

    +

    Payload representing disabling foreground color on following text.

    +
    +
    +
    Declaration
    +
    +
    public static UIForegroundPayload UIForegroundOff { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    UIForegroundPayload

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    public override byte[] Encode()
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.IO.BinaryReaderreader
    System.Int64endOfStream
    +
    Overrides
    + + + | + Improve this Doc + + + View Source + + +

    EncodeImpl()

    +
    +
    +
    Declaration
    +
    +
    protected override byte[] EncodeImpl()
    Returns
    @@ -229,13 +441,13 @@
    Overrides
    - + | Improve this Doc - View Source + View Source

    GetMarkerForIntegerBytes(Byte[])

    @@ -279,68 +491,12 @@
    Overrides
    - - | - Improve this Doc - - - View Source - - -

    ProcessChunkImpl(BinaryReader, Int64)

    -
    -
    -
    Declaration
    -
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    -
    -
    Parameters
    - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescription
    System.IO.BinaryReaderreader
    System.Int64endOfStream
    -
    Overrides
    - - - | - Improve this Doc - - - View Source - - -

    Resolve()

    -
    -
    -
    Declaration
    -
    -
    public override void Resolve()
    -
    -
    Overrides
    - | Improve this Doc - View Source + View Source

    ToString()

    @@ -378,7 +534,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.UIGlowPayload.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.UIGlowPayload.html index d4c5d28f6..2d7229736 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.UIGlowPayload.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.UIGlowPayload.html @@ -73,7 +73,8 @@

    Class UIGlowPayload

    -
    +

    An SeString Payload representing a UI glow color applied to following text payloads.

    +
    Inheritance
    @@ -84,7 +85,16 @@
    Inherited Members
    + + +
    Payload.START_BYTE @@ -132,22 +142,58 @@
    public class UIGlowPayload : Payload
    +

    Constructors +

    + + | + Improve this Doc + + + View Source + + +

    UIGlowPayload(UInt16)

    +

    Creates a new UIForegroundPayload for the given UIColor key.

    +
    +
    +
    Declaration
    +
    +
    public UIGlowPayload(ushort colorKey)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.UInt16colorKey

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    RawColor

    -
    + +

    ColorKey

    +

    The color key used as a lookup in the UIColor table for this glow color.

    +
    Declaration
    -
    public ushort RawColor { get; }
    +
    public ushort ColorKey { get; set; }
    Property Value
    @@ -164,12 +210,74 @@
    + + | + Improve this Doc + + + View Source + + +

    IsEnabled

    +

    Whether or not this payload represents applying a glow color, or disabling one.

    +
    +
    +
    Declaration
    +
    +
    public bool IsEnabled { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Boolean
    + + | + Improve this Doc + + + View Source + + +

    RGB

    +

    The Red/Green/Blue values for this glow color, encoded as a typical hex color.

    +
    +
    +
    Declaration
    +
    +
    public uint RGB { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.UInt32
    | Improve this Doc - View Source + View Source

    Type

    @@ -196,22 +304,126 @@
    Overrides
    + + | + Improve this Doc + + + View Source + + +

    UIColor

    +

    A Lumina UIColor object representing this payload. The actual color data is at UIColor.UIGlow

    +
    +
    +
    Declaration
    +
    +
    public UIColor UIColor { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    Lumina.Excel.GeneratedSheets.UIColor
    +
    Remarks
    +

    Value is evaluated lazily and cached.

    +
    + + | + Improve this Doc + + + View Source + + +

    UIGlowOff

    +

    Payload representing disabling glow color on following text.

    +
    +
    +
    Declaration
    +
    +
    public static UIGlowPayload UIGlowOff { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    UIGlowPayload

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source - -

    Encode()

    + +

    DecodeImpl(BinaryReader, Int64)

    Declaration
    -
    public override byte[] Encode()
    +
    protected override void DecodeImpl(BinaryReader reader, long endOfStream)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.IO.BinaryReaderreader
    System.Int64endOfStream
    +
    Overrides
    + + + | + Improve this Doc + + + View Source + + +

    EncodeImpl()

    +
    +
    +
    Declaration
    +
    +
    protected override byte[] EncodeImpl()
    Returns
    @@ -229,13 +441,13 @@
    Overrides
    - + | Improve this Doc - View Source + View Source

    GetMarkerForIntegerBytes(Byte[])

    @@ -279,68 +491,12 @@
    Overrides
    - - | - Improve this Doc - - - View Source - - -

    ProcessChunkImpl(BinaryReader, Int64)

    -
    -
    -
    Declaration
    -
    -
    protected override void ProcessChunkImpl(BinaryReader reader, long endOfStream)
    -
    -
    Parameters
    - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescription
    System.IO.BinaryReaderreader
    System.Int64endOfStream
    -
    Overrides
    - - - | - Improve this Doc - - - View Source - - -

    Resolve()

    -
    -
    -
    Declaration
    -
    -
    public override void Resolve()
    -
    -
    Overrides
    - | Improve this Doc - View Source + View Source

    ToString()

    @@ -378,7 +534,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.html index 8ecf4eee1..6506bdce7 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.Payloads.html @@ -78,23 +78,37 @@

    Classes

    AutoTranslatePayload

    -
    +

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

    +
    +

    EmphasisItalicPayload

    +

    An SeString Payload containing information about enabling or disabling italics formatting on following text.

    +

    ItemPayload

    -
    +

    An SeString Payload representing an interactable item link.

    +

    MapLinkPayload

    -
    +

    An SeString Payload representing an interactable map position link.

    +

    PlayerPayload

    -
    +

    An SeString Payload representing a player link.

    +

    RawPayload

    -
    +

    An SeString Payload representing unhandled raw payload data. +Mainly useful for constructing unhandled hardcoded payloads, or forwarding any unknown +payloads without modification.

    +

    StatusPayload

    -
    +

    An SeString Payload representing an interactable status link.

    +

    TextPayload

    -
    +

    An SeString Payload representing a plain text string.

    +

    UIForegroundPayload

    -
    +

    An SeString Payload representing a UI foreground color applied to following text payloads.

    +

    UIGlowPayload

    -
    +

    An SeString Payload representing a UI glow color applied to following text payloads.

    +
    diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.SeString.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.SeString.html index 6c08be528..62d5b3d0a 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.SeString.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.SeString.html @@ -113,16 +113,51 @@

    Constructors

    + + | + Improve this Doc + + + View Source + + +

    SeString(Payload[])

    +

    Creates a new SeString from an ordered list of payloads.

    +
    +
    +
    Declaration
    +
    +
    public SeString(Payload[] payloads)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    Payload[]payloads

    The Payload objects to make up this string.

    +
    | Improve this Doc - View Source + View Source

    SeString(List<Payload>)

    -
    +

    Creates a new SeString from an ordered list of payloads.

    +
    Declaration
    @@ -141,7 +176,8 @@ System.Collections.Generic.List<Payload> payloads - +

    The Payload objects to make up this string.

    + @@ -152,11 +188,12 @@ Improve this Doc - View Source + View Source

    Payloads

    -
    +

    The ordered list of payloads included in this SeString.

    +
    Declaration
    @@ -182,7 +219,7 @@ Improve this Doc - View Source + View Source

    TextValue

    @@ -211,16 +248,167 @@

    Methods

    + + | + Improve this Doc + + + View Source + + +

    Append(Payload)

    +

    Appends a single payload to this SeString.

    +
    +
    +
    Declaration
    +
    +
    public SeString Append(Payload payload)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    Payloadpayload

    The payload to append.

    +
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    SeString

    This object.

    +
    + + | + Improve this Doc + + + View Source + + +

    Append(SeString)

    +

    Appends the contents of one SeString to this one.

    +
    +
    +
    Declaration
    +
    +
    public SeString Append(SeString other)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    SeStringother

    The SeString to append to this one.

    +
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    SeString

    This object.

    +
    + + | + Improve this Doc + + + View Source + + +

    Append(List<Payload>)

    +

    Appends a list of payloads to this SeString.

    +
    +
    +
    Declaration
    +
    +
    public SeString Append(List<Payload> payloads)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.Collections.Generic.List<Payload>payloads

    The Payloads to append.

    +
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    SeString

    This object.

    +
    | Improve this Doc - View Source + View Source

    Encode()

    -

    Encode a parsed/created SeString to an array of bytes, to be used for injection.

    +

    Encodes the Payloads in this SeString into a binary representation +suitable for use by in-game handlers, such as the chat log.

    Declaration
    @@ -238,7 +426,7 @@ System.Byte[] -

    The bytes of the message.

    +

    The binary encoded payload data.

    @@ -248,11 +436,11 @@ Improve this Doc - View Source + View Source

    Parse(Byte[])

    -

    Parse an array of bytes to a SeString.

    +

    Parse a binary game message into an SeString.

    Declaration
    @@ -272,7 +460,8 @@ System.Byte[] bytes - +

    Binary message payload data in SE's internal format.

    + @@ -287,7 +476,8 @@ SeString - +

    An SeString containing parsed Payload objects for each payload in the data.

    + @@ -302,7 +492,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.SeStringUtils.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.SeStringUtils.html new file mode 100644 index 000000000..8c4761b6f --- /dev/null +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.SeStringUtils.html @@ -0,0 +1,518 @@ + + + + + + + + Class SeStringUtils + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + + + +
    + + + + + + diff --git a/docs/api/Dalamud.Game.Chat.SeStringHandling.html b/docs/api/Dalamud.Game.Chat.SeStringHandling.html index 923a59221..f585e430c 100644 --- a/docs/api/Dalamud.Game.Chat.SeStringHandling.html +++ b/docs/api/Dalamud.Game.Chat.SeStringHandling.html @@ -82,6 +82,9 @@

    SeString

    This class represents a parsed SeString.

    +
    +

    SeStringUtils

    +

    A utility class for working with common SeString variants.

    Enums

    diff --git a/docs/api/Dalamud.Game.ChatHandlers.html b/docs/api/Dalamud.Game.ChatHandlers.html index 74aa8ef59..f168a5897 100644 --- a/docs/api/Dalamud.Game.ChatHandlers.html +++ b/docs/api/Dalamud.Game.ChatHandlers.html @@ -151,7 +151,7 @@ Improve this Doc - View Source + View Source diff --git a/docs/api/Dalamud.Game.ClientState.Actors.CustomizeIndex.html b/docs/api/Dalamud.Game.ClientState.Actors.CustomizeIndex.html new file mode 100644 index 000000000..cfb418177 --- /dev/null +++ b/docs/api/Dalamud.Game.ClientState.Actors.CustomizeIndex.html @@ -0,0 +1,246 @@ + + + + + + + + Enum CustomizeIndex + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + + + +
    + + + + + + diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Position3.html b/docs/api/Dalamud.Game.ClientState.Actors.Position3.html index 6499cc286..698bb36a2 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Position3.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Position3.html @@ -191,6 +191,106 @@ +

    Operators +

    + + | + Improve this Doc + + + View Source + + +

    Implicit(Position3 to Vector3)

    +

    Convert this Position3 to a SharpDX.Vector3

    +
    +
    +
    Declaration
    +
    +
    public static implicit operator Vector3(Position3 pos)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    Position3pos

    Position to convert.

    +
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    SharpDX.Vector3
    + + | + Improve this Doc + + + View Source + + +

    Implicit(Position3 to Vector3)

    +

    Convert this Position3 to a System.Numerics.Vector3

    +
    +
    +
    Declaration
    +
    +
    public static implicit operator Vector3(Position3 pos)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    Position3pos

    Position to convert.

    +
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    System.Numerics.Vector3
    diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html index 86879761f..41d756570 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html @@ -258,7 +258,7 @@ Improve this Doc - View Source + View Source

    ActorId

    @@ -289,7 +289,7 @@ Improve this Doc - View Source + View Source

    Name

    @@ -320,7 +320,7 @@ Improve this Doc - View Source + View Source

    ObjectKind

    @@ -378,6 +378,100 @@ possible values.

    + + | + Improve this Doc + + + View Source + + +

    Rotation

    +

    Rotation of this Actor.
    +This ranges from -pi to pi radians.

    +
    +
    +
    Declaration
    +
    +
    public float Rotation { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Single
    + + | + Improve this Doc + + + View Source + + +

    YalmDistanceX

    +

    The X distance from the local player in yalms.

    +
    +
    +
    Declaration
    +
    +
    public byte YalmDistanceX { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte
    + + | + Improve this Doc + + + View Source + + +

    YalmDistanceY

    +

    The Y distance from the local player in yalms.

    +
    +
    +
    Declaration
    +
    +
    public byte YalmDistanceY { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte
    diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html index d6bb13de1..872373563 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html @@ -98,6 +98,9 @@ + @@ -107,6 +110,12 @@ + +
    System.Object.ToString()
    @@ -278,6 +287,37 @@ + + | + Improve this Doc + + + View Source + + +

    Customize

    +

    Byte array describing the visual appearance of this Chara. Indexed by CustomizeIndex.

    +
    +
    +
    Declaration
    +
    +
    public byte[] Customize { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte[]
    | Improve this Doc diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html index b12072db7..54687bd21 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html @@ -110,6 +110,9 @@ + @@ -122,6 +125,9 @@ + @@ -131,6 +137,12 @@ + +
    System.Object.ToString()
    diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html index 7caff47c0..e3dd23a22 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html @@ -104,6 +104,9 @@ + @@ -116,6 +119,9 @@ + @@ -125,6 +131,12 @@ + +
    System.Object.ToString()
    diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html index 027d0a014..f0a648332 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html @@ -103,6 +103,9 @@ + @@ -115,6 +118,9 @@ + @@ -124,6 +130,12 @@ + +
    System.Object.ToString()
    diff --git a/docs/api/Dalamud.Game.ClientState.Actors.html b/docs/api/Dalamud.Game.ClientState.Actors.html index 556353961..20926e6c6 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.html @@ -86,6 +86,9 @@

    Enums

    +

    CustomizeIndex

    +

    This enum describes the indices of the Customize array.

    +

    ObjectKind

    Enum describing possible entity kinds.

    diff --git a/docs/api/Dalamud.Game.ClientState.Structs.Actor.html b/docs/api/Dalamud.Game.ClientState.Structs.Actor.html index 9cbf37523..369427f1e 100644 --- a/docs/api/Dalamud.Game.ClientState.Structs.Actor.html +++ b/docs/api/Dalamud.Game.ClientState.Structs.Actor.html @@ -110,7 +110,7 @@ Improve this Doc
    - View Source + View Source

    ActorId

    @@ -139,7 +139,7 @@ Improve this Doc - View Source + View Source

    ClassJob

    @@ -168,7 +168,7 @@ Improve this Doc - View Source + View Source

    CompanyTag

    @@ -197,7 +197,7 @@ Improve this Doc - View Source + View Source

    CurrentHp

    @@ -226,7 +226,7 @@ Improve this Doc - View Source + View Source

    CurrentMp

    @@ -255,7 +255,7 @@ Improve this Doc - View Source + View Source

    CurrentWorld

    @@ -279,12 +279,41 @@ + + | + Improve this Doc + + + View Source + +

    Customize

    +
    +
    +
    Declaration
    +
    +
    public byte[] Customize
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte[]
    | Improve this Doc - View Source + View Source

    DataId

    @@ -313,7 +342,7 @@ Improve this Doc - View Source + View Source

    HomeWorld

    @@ -342,7 +371,7 @@ Improve this Doc - View Source + View Source

    IsFriendly

    @@ -371,7 +400,7 @@ Improve this Doc - View Source + View Source

    Level

    @@ -400,7 +429,7 @@ Improve this Doc - View Source + View Source

    MaxHp

    @@ -429,7 +458,7 @@ Improve this Doc - View Source + View Source

    MaxMp

    @@ -458,7 +487,7 @@ Improve this Doc - View Source + View Source

    Name

    @@ -487,7 +516,7 @@ Improve this Doc - View Source + View Source

    NameId

    @@ -516,7 +545,7 @@ Improve this Doc - View Source + View Source

    ObjectKind

    @@ -545,7 +574,7 @@ Improve this Doc - View Source + View Source

    OwnerId

    @@ -574,7 +603,7 @@ Improve this Doc - View Source + View Source

    PlayerTargetStatus

    @@ -603,7 +632,7 @@ Improve this Doc - View Source + View Source

    Position

    @@ -627,12 +656,41 @@ + + | + Improve this Doc + + + View Source + +

    Rotation

    +
    +
    +
    Declaration
    +
    +
    public float Rotation
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Single
    | Improve this Doc - View Source + View Source

    SubKind

    @@ -661,7 +719,7 @@ Improve this Doc - View Source + View Source

    TargetActorId

    @@ -687,17 +745,46 @@ | - Improve this Doc + Improve this Doc - View Source + View Source -

    YalmDistanceFromPlayer1

    +

    UIStatusEffects

    Declaration
    -
    public byte YalmDistanceFromPlayer1
    +
    public StatusEffect[] UIStatusEffects
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    StatusEffect[]
    + + | + Improve this Doc + + + View Source + +

    YalmDistanceFromPlayerX

    +
    +
    +
    Declaration
    +
    +
    public byte YalmDistanceFromPlayerX
    Field Value
    @@ -716,17 +803,17 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source -

    YalmDistanceFromPlayer2

    +

    YalmDistanceFromPlayerY

    Declaration
    -
    public byte YalmDistanceFromPlayer2
    +
    public byte YalmDistanceFromPlayerY
    Field Value
    diff --git a/docs/api/Dalamud.Game.ClientState.Structs.StatusEffect.html b/docs/api/Dalamud.Game.ClientState.Structs.StatusEffect.html new file mode 100644 index 000000000..44ae6679d --- /dev/null +++ b/docs/api/Dalamud.Game.ClientState.Structs.StatusEffect.html @@ -0,0 +1,294 @@ + + + + + + + + Struct StatusEffect + + + + + + + + + + + + + + + + +
    +
    + + + + +
    +
    + + + + + + + + + + + + +
    TypeDescription
    System.Single
    + + | + Improve this Doc + + + View Source + +

    EffectId

    +
    +
    +
    Declaration
    +
    +
    public short EffectId
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Int16
    + + | + Improve this Doc + + + View Source + +

    OwnerId

    +
    +
    +
    Declaration
    +
    +
    public int OwnerId
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Int32
    + + | + Improve this Doc + + + View Source + +

    Param

    +
    +
    +
    Declaration
    +
    +
    public byte Param
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte
    + + | + Improve this Doc + + + View Source + +

    StackCount

    +
    +
    +
    Declaration
    +
    +
    public byte StackCount
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Byte
    + +
    + + +
    +
    + + +
    + + + + + + diff --git a/docs/api/Dalamud.Game.ClientState.Structs.html b/docs/api/Dalamud.Game.ClientState.Structs.html index f6b649631..6467a27cc 100644 --- a/docs/api/Dalamud.Game.ClientState.Structs.html +++ b/docs/api/Dalamud.Game.ClientState.Structs.html @@ -82,6 +82,9 @@

    PartyMember

    +

    StatusEffect

    +

    Native memory representation of a FFXIV status effect.

    +
    diff --git a/docs/api/Dalamud.Game.Command.CommandManager.html b/docs/api/Dalamud.Game.Command.CommandManager.html index 2a8be0c6f..0c45b2b44 100644 --- a/docs/api/Dalamud.Game.Command.CommandManager.html +++ b/docs/api/Dalamud.Game.Command.CommandManager.html @@ -118,7 +118,7 @@ Improve this Doc - View Source + View Source

    CommandManager(Dalamud, ClientLanguage)

    @@ -157,7 +157,7 @@ Improve this Doc - View Source + View Source

    Commands

    @@ -190,7 +190,7 @@ Improve this Doc - View Source + View Source

    AddHandler(String, CommandInfo)

    @@ -246,7 +246,7 @@ Improve this Doc - View Source + View Source

    DispatchCommand(String, String, CommandInfo)

    @@ -283,6 +283,56 @@ CommandInfo info

    A CommandInfo object describing this command.

    + + + + + + | + Improve this Doc + + + View Source + + +

    ProcessCommand(String)

    +

    Process a command in full.

    +
    +
    +
    Declaration
    +
    +
    public bool ProcessCommand(string content)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.Stringcontent

    The full command string.

    +
    +
    Returns
    + + + + + + + + + + + @@ -292,7 +342,7 @@ Improve this Doc - View Source + View Source

    RemoveHandler(String)

    @@ -348,7 +398,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnCheckMessageHandledDelegate.html b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnCheckMessageHandledDelegate.html new file mode 100644 index 000000000..b5de5debe --- /dev/null +++ b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnCheckMessageHandledDelegate.html @@ -0,0 +1,162 @@ + + + + + + + + Delegate ChatGui.OnCheckMessageHandledDelegate + + + + + + + + + + + + + + + + +
    +
    + + + + +
    +
    TypeDescription
    System.Boolean

    True if the command was found and dispatched.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    XivChatTypetype
    System.UInt32senderId
    SeStringsender
    SeStringmessage
    System.BooleanisHandled
    + +
    + + +
    +
    + + +
    + + + + + + diff --git a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnMessageDelegate.html b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnMessageDelegate.html index b27694b1e..67b4a22a8 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnMessageDelegate.html +++ b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnMessageDelegate.html @@ -129,7 +129,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnMessageRawDelegate.html b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnMessageRawDelegate.html index 0d00d2adc..679715940 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnMessageRawDelegate.html +++ b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.OnMessageRawDelegate.html @@ -129,7 +129,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html index 8e8010d15..d8b25c814 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html +++ b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html @@ -121,7 +121,7 @@ Improve this Doc - View Source + View Source

    ChatGui(IntPtr, SigScanner, Dalamud)

    @@ -165,7 +165,7 @@ Improve this Doc - View Source + View Source

    LastLinkedItemFlags

    @@ -195,7 +195,7 @@ Improve this Doc - View Source + View Source

    LastLinkedItemId

    @@ -227,7 +227,7 @@ Improve this Doc - View Source + View Source

    Dispose()

    @@ -242,7 +242,7 @@ Improve this Doc - View Source + View Source

    Enable()

    @@ -257,7 +257,7 @@ Improve this Doc - View Source + View Source

    Print(String)

    @@ -289,7 +289,7 @@ Improve this Doc - View Source + View Source

    PrintChat(XivChatEntry)

    @@ -324,7 +324,7 @@ later to be processed when UpdateQueue() is called.

    Improve this Doc - View Source + View Source

    PrintError(String)

    @@ -356,7 +356,7 @@ later to be processed when UpdateQueue() is called.

    Improve this Doc - View Source + View Source

    UpdateQueue(Framework)

    @@ -391,10 +391,11 @@ later to be processed when UpdateQueue() is called.

    Improve this Doc - View Source + View Source

    OnChatMessage

    -
    +

    Event that will be fired when a chat message is sent to chat by the game.

    +
    Declaration
    @@ -420,10 +421,11 @@ later to be processed when UpdateQueue() is called.

    Improve this Doc - View Source + View Source

    OnChatMessageRaw

    -
    +

    Event that will be fired when a chat message is sent by the game, containing raw, unparsed data.

    +
    Declaration
    @@ -445,6 +447,36 @@ public event ChatGui.OnMessageRawDelegate OnChatMessageRaw + + | + Improve this Doc + + + View Source + +

    OnCheckMessageHandled

    +

    Event that allows you to stop messages from appearing in chat by setting the isHandled parameter to true.

    +
    +
    +
    Declaration
    +
    +
    public event ChatGui.OnCheckMessageHandledDelegate OnCheckMessageHandled
    +
    +
    Event Type
    + + + + + + + + + + + + + +
    TypeDescription
    ChatGui.OnCheckMessageHandledDelegate

    Implements

    System.IDisposable diff --git a/docs/api/Dalamud.Game.Internal.Gui.GameGui.html b/docs/api/Dalamud.Game.Internal.Gui.GameGui.html index 3ecdd6c83..94217cf56 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.GameGui.html +++ b/docs/api/Dalamud.Game.Internal.Gui.GameGui.html @@ -121,7 +121,7 @@ Improve this Doc - View Source + View Source

    GameGui(IntPtr, SigScanner, Dalamud)

    @@ -165,7 +165,7 @@ Improve this Doc - View Source + View Source

    Chat

    @@ -195,7 +195,7 @@ Improve this Doc - View Source + View Source

    HoveredItem

    @@ -227,7 +227,7 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    Improve this Doc - View Source + View Source

    HoveredItemChanged

    @@ -260,7 +260,7 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    Improve this Doc - View Source + View Source

    Dispose()

    @@ -275,7 +275,7 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    Improve this Doc - View Source + View Source

    Enable()

    @@ -290,11 +290,12 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    Improve this Doc - View Source + View Source -
    +

    Opens the in-game map with a flag on the location of the parameter

    +
    Declaration
    @@ -313,7 +314,8 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    MapLinkPayload mapLink - +

    Link to the map to be opened

    + @@ -328,7 +330,70 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    System.Boolean - +

    True if there were no errors and it could open the map

    + + + + + + | + Improve this Doc + + + View Source + + +

    ScreenToWorld(Vector2, out Vector3, Single)

    +

    Converts screen coordinates to in-world coordinates via raycasting.

    +
    +
    +
    Declaration
    +
    +
    public bool ScreenToWorld(Vector2 screenPos, out Vector3 worldPos, float rayDistance = 100000F)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    SharpDX.Vector2screenPos

    Screen coordinates

    +
    SharpDX.Vector3worldPos

    Converted coordinates

    +
    System.SinglerayDistance

    How far to search for a collision

    +
    +
    Returns
    + + + + + + + + + + +
    TypeDescription
    System.Boolean

    True if successful. On false, worldPos's contents are undefined

    +
    @@ -337,7 +402,7 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    Improve this Doc - View Source + View Source

    SetBgm(UInt16)

    @@ -364,6 +429,62 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    + + | + Improve this Doc + + + View Source + + +

    WorldToScreen(Vector3, out Vector2)

    +

    Converts in-world coordinates to screen coordinates (upper left corner origin).

    +
    +
    +
    Declaration
    +
    +
    public bool WorldToScreen(Vector3 worldPos, out Vector2 screenPos)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    SharpDX.Vector3worldPos

    Coordinates in the world

    +
    SharpDX.Vector2screenPos

    Converted coordinates

    +
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    System.Boolean

    True if worldPos corresponds to a position in front of the camera

    +

    Implements

    System.IDisposable @@ -379,7 +500,7 @@ If > 1.000.000, subtract 1.000.000 and treat it as HQ

    Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Internal.Gui.html b/docs/api/Dalamud.Game.Internal.Gui.html index 4eec33965..0be9c1c91 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.html +++ b/docs/api/Dalamud.Game.Internal.Gui.html @@ -85,6 +85,8 @@

    Delegates

    +

    ChatGui.OnCheckMessageHandledDelegate

    +

    ChatGui.OnMessageDelegate

    ChatGui.OnMessageRawDelegate

    diff --git a/docs/api/Dalamud.Game.Internal.Network.GameNetwork.OnNetworkMessageDelegate.html b/docs/api/Dalamud.Game.Internal.Network.GameNetwork.OnNetworkMessageDelegate.html new file mode 100644 index 000000000..9c77b70e5 --- /dev/null +++ b/docs/api/Dalamud.Game.Internal.Network.GameNetwork.OnNetworkMessageDelegate.html @@ -0,0 +1,162 @@ + + + + + + + + Delegate GameNetwork.OnNetworkMessageDelegate + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + + + +
    + + + + + + diff --git a/docs/api/Dalamud.Game.Internal.Network.GameNetwork.html b/docs/api/Dalamud.Game.Internal.Network.GameNetwork.html index b4e65ccb8..a1ce97d00 100644 --- a/docs/api/Dalamud.Game.Internal.Network.GameNetwork.html +++ b/docs/api/Dalamud.Game.Internal.Network.GameNetwork.html @@ -118,18 +118,18 @@ | - Improve this Doc + Improve this Doc - View Source + View Source -

    GameNetwork(Dalamud, SigScanner)

    +

    GameNetwork(SigScanner)

    Declaration
    -
    public GameNetwork(Dalamud dalamud, SigScanner scanner)
    +
    public GameNetwork(SigScanner scanner)
    Parameters
    @@ -141,11 +141,6 @@ - - - - - @@ -157,17 +152,18 @@ | - Improve this Doc + Improve this Doc - View Source + View Source -

    OnZonePacket

    -
    +

    OnNetworkMessage

    +

    Event that is called when a network message is sent/received.

    +
    Declaration
    -
    public GameNetwork.OnZonePacketDelegate OnZonePacket
    +
    public GameNetwork.OnNetworkMessageDelegate OnNetworkMessage
    Field Value
    Dalamud.Dalamuddalamud
    SigScanner scanner
    @@ -179,7 +175,7 @@ - + @@ -191,7 +187,7 @@ Improve this Doc - View Source + View Source

    Dispose()

    @@ -206,7 +202,7 @@ Improve this Doc - View Source + View Source

    Enable()

    @@ -221,7 +217,7 @@ Improve this Doc - View Source + View Source

    UpdateQueue(Framework)

    @@ -264,7 +260,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Internal.Network.NetworkMessageDirection.html b/docs/api/Dalamud.Game.Internal.Network.NetworkMessageDirection.html new file mode 100644 index 000000000..5695c0ef9 --- /dev/null +++ b/docs/api/Dalamud.Game.Internal.Network.NetworkMessageDirection.html @@ -0,0 +1,149 @@ + + + + + + + + Enum NetworkMessageDirection + + + + + + + + + + + + + + + + +
    +
    + + + + +
    +
    GameNetwork.OnZonePacketDelegateGameNetwork.OnNetworkMessageDelegate
    + + + + + + + + + + + + + + + + +
    NameDescription
    ZoneDown
    ZoneUp
    +

    Extension Methods

    + + +
    + + +
    +
    + + +
    + + + + + + diff --git a/docs/api/Dalamud.Game.Internal.Network.html b/docs/api/Dalamud.Game.Internal.Network.html index 67ec9a3c7..7b2e15ce2 100644 --- a/docs/api/Dalamud.Game.Internal.Network.html +++ b/docs/api/Dalamud.Game.Internal.Network.html @@ -79,9 +79,13 @@

    GameNetwork

    +

    Enums +

    +

    NetworkMessageDirection

    +

    Delegates

    -

    GameNetwork.OnZonePacketDelegate

    +

    GameNetwork.OnNetworkMessageDelegate

    diff --git a/docs/api/Dalamud.Game.Network.NetworkHandlers.CfPop.html b/docs/api/Dalamud.Game.Network.NetworkHandlers.CfPop.html index 1327b3e7f..df9fda653 100644 --- a/docs/api/Dalamud.Game.Network.NetworkHandlers.CfPop.html +++ b/docs/api/Dalamud.Game.Network.NetworkHandlers.CfPop.html @@ -124,7 +124,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Game.Network.NetworkHandlers.html b/docs/api/Dalamud.Game.Network.NetworkHandlers.html index 3aa94c8ac..e7e557b28 100644 --- a/docs/api/Dalamud.Game.Network.NetworkHandlers.html +++ b/docs/api/Dalamud.Game.Network.NetworkHandlers.html @@ -117,7 +117,7 @@ Improve this Doc - View Source + View Source

    NetworkHandlers(Dalamud, Boolean)

    @@ -156,7 +156,7 @@ Improve this Doc - View Source + View Source

    ProcessCfPop

    @@ -191,7 +191,7 @@ Improve this Doc
  • - View Source + View Source
  • diff --git a/docs/api/Dalamud.Interface.FontAwesomeExtensions.html b/docs/api/Dalamud.Interface.FontAwesomeExtensions.html new file mode 100644 index 000000000..6adc4104d --- /dev/null +++ b/docs/api/Dalamud.Interface.FontAwesomeExtensions.html @@ -0,0 +1,250 @@ + + + + + + + + Class FontAwesomeExtensions + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + + + +
    + + + + + + diff --git a/docs/api/Dalamud.Interface.FontAwesomeIcon.html b/docs/api/Dalamud.Interface.FontAwesomeIcon.html new file mode 100644 index 000000000..604456b82 --- /dev/null +++ b/docs/api/Dalamud.Interface.FontAwesomeIcon.html @@ -0,0 +1,5779 @@ + + + + + + + + Enum FontAwesomeIcon + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + + + +
    + + + + + + diff --git a/docs/api/Dalamud.Interface.InterfaceManager.html b/docs/api/Dalamud.Interface.InterfaceManager.html index cb0073ca9..bdf5dcf9c 100644 --- a/docs/api/Dalamud.Interface.InterfaceManager.html +++ b/docs/api/Dalamud.Interface.InterfaceManager.html @@ -121,7 +121,7 @@ Improve this Doc - View Source + View Source

    InterfaceManager(Dalamud, SigScanner)

    @@ -184,6 +184,97 @@ + + | + Improve this Doc + + + View Source + +

    OnBuildFonts

    +
    +
    +
    Declaration
    +
    +
    public Action OnBuildFonts
    +
    +
    Field Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Action
    +

    Properties +

    + + | + Improve this Doc + + + View Source + + +

    DefaultFont

    +
    +
    +
    Declaration
    +
    +
    public static ImFontPtr DefaultFont { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    ImFontPtr
    + + | + Improve this Doc + + + View Source + + +

    IconFont

    +
    +
    +
    Declaration
    +
    +
    public static ImFontPtr IconFont { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    ImFontPtr

    Methods

    @@ -191,7 +282,7 @@ Improve this Doc - View Source + View Source

    Dispose()

    @@ -206,7 +297,7 @@ Improve this Doc - View Source + View Source

    Enable()

    @@ -221,7 +312,7 @@ Improve this Doc - View Source + View Source

    LoadImage(Byte[])

    @@ -268,7 +359,7 @@ Improve this Doc - View Source + View Source

    LoadImage(String)

    @@ -315,7 +406,7 @@ Improve this Doc - View Source + View Source

    LoadImageRaw(Byte[], Int32, Int32, Int32)

    @@ -372,6 +463,21 @@ + + | + Improve this Doc + + + View Source + + +

    RebuildFonts()

    +
    +
    +
    Declaration
    +
    +
    public void RebuildFonts()
    +

    Events

    @@ -379,7 +485,7 @@ Improve this Doc - View Source + View Source

    OnDraw

    This event gets called by a plugin UiBuilder when read

    diff --git a/docs/api/Dalamud.Interface.UiBuilder.html b/docs/api/Dalamud.Interface.UiBuilder.html index 3692957ba..d5ab88dc9 100644 --- a/docs/api/Dalamud.Interface.UiBuilder.html +++ b/docs/api/Dalamud.Interface.UiBuilder.html @@ -123,7 +123,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc - View Source + View Source

    UiBuilder(InterfaceManager, String)

    @@ -165,7 +165,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc - View Source + View Source

    OnOpenConfigUi

    Event that is fired when the plugin should open its configuration interface.

    @@ -190,6 +190,105 @@ It can be used to draw custom windows and overlays.

    +

    Properties +

    + + | + Improve this Doc + + + View Source + + +

    DefaultFont

    +

    The default Dalamud font based on Noto Sans CJK Medium in 17pt - supporting all game languages and icons.

    +
    +
    +
    Declaration
    +
    +
    public static ImFontPtr DefaultFont { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    ImFontPtr
    + + | + Improve this Doc + + + View Source + + +

    IconFont

    +

    The default Dalamud icon font based on FontAwesome 5 Free solid in 17pt.

    +
    +
    +
    Declaration
    +
    +
    public static ImFontPtr IconFont { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    ImFontPtr
    + + | + Improve this Doc + + + View Source + + +

    OnBuildFonts

    +

    An event that is called any time ImGui fonts need to be rebuilt.
    +Any ImFontPtr objects that you store can be invalidated when fonts are rebuilt +(at any time), so you should both reload your custom fonts and restore those +pointers inside this handler.
    +PLEASE remove this handler inside Dipose, or when you no longer need your fonts!

    +
    +
    +
    Declaration
    +
    +
    public Action OnBuildFonts { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Action

    Methods

    @@ -197,7 +296,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc
    - View Source + View Source

    Dispose()

    @@ -213,7 +312,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc - View Source + View Source

    LoadImage(Byte[])

    @@ -263,7 +362,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc - View Source + View Source

    LoadImage(String)

    @@ -313,7 +412,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc - View Source + View Source

    LoadImageRaw(Byte[], Int32, Int32, Int32)

    @@ -376,6 +475,24 @@ It can be used to draw custom windows and overlays.

    + + | + Improve this Doc + + + View Source + + +

    RebuildFonts()

    +

    Call this to queue a rebuild of the font atlas.
    +This will invoke any OnBuildFonts handlers and ensure that any loaded fonts are +ready to be used on the next UI frame.

    +
    +
    +
    Declaration
    +
    +
    public void RebuildFonts()
    +

    Events

    @@ -383,7 +500,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc
    - View Source + View Source

    OnBuildUi

    The delegate that gets called when Dalamud is ready to draw your windows or overlays. diff --git a/docs/api/Dalamud.Interface.html b/docs/api/Dalamud.Interface.html index 3ae9b2ba4..ce13beaf1 100644 --- a/docs/api/Dalamud.Interface.html +++ b/docs/api/Dalamud.Interface.html @@ -77,6 +77,8 @@

    Classes

    +

    FontAwesomeExtensions

    +

    InterfaceManager

    MySinkExtensions

    @@ -87,6 +89,10 @@

    This class represents the Dalamud UI that is drawn on top of the game. It can be used to draw custom windows and overlays.

    +

    Enums +

    +

    FontAwesomeIcon

    +
    diff --git a/docs/api/Dalamud.Plugin.PluginDefinition.html b/docs/api/Dalamud.Plugin.PluginDefinition.html index 50bcc3bb2..6a10ac7c7 100644 --- a/docs/api/Dalamud.Plugin.PluginDefinition.html +++ b/docs/api/Dalamud.Plugin.PluginDefinition.html @@ -267,7 +267,7 @@ Improve this Doc - View Source + View Source

    IsHide

    @@ -322,6 +322,36 @@ + + | + Improve this Doc + + + View Source + + +

    RepoUrl

    +
    +
    +
    Declaration
    +
    +
    public string RepoUrl { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String
    diff --git a/docs/api/Dalamud.Plugin.PluginRepository.html b/docs/api/Dalamud.Plugin.PluginRepository.html index 1b3090588..8f2b3b35a 100644 --- a/docs/api/Dalamud.Plugin.PluginRepository.html +++ b/docs/api/Dalamud.Plugin.PluginRepository.html @@ -221,18 +221,18 @@ | - Improve this Doc + Improve this Doc View Source -

    InstallPlugin(PluginDefinition)

    +

    InstallPlugin(PluginDefinition, Boolean)

    Declaration
    -
    public bool InstallPlugin(PluginDefinition definition)
    +
    public bool InstallPlugin(PluginDefinition definition, bool enableAfterInstall = true)
    Parameters
    @@ -249,6 +249,11 @@ + + + + +
    definition
    System.BooleanenableAfterInstall
    Returns
    @@ -271,7 +276,7 @@ Improve this Doc - View Source + View Source

    UpdatePlugins(Boolean)

    diff --git a/docs/api/ImGuiScene.FramerateLimit.LimitType.html b/docs/api/ImGuiScene.FramerateLimit.LimitType.html index 091bfff68..438ffd1db 100644 --- a/docs/api/ImGuiScene.FramerateLimit.LimitType.html +++ b/docs/api/ImGuiScene.FramerateLimit.LimitType.html @@ -122,10 +122,10 @@ This will disable vsync regardless of the fps value.

    diff --git a/docs/api/ImGuiScene.FramerateLimit.html b/docs/api/ImGuiScene.FramerateLimit.html index b986af0b0..7b9015374 100644 --- a/docs/api/ImGuiScene.FramerateLimit.html +++ b/docs/api/ImGuiScene.FramerateLimit.html @@ -113,10 +113,10 @@ Vsync-enabled (sync to monitor refresh), or a specified fixed framerate (vsync d | - Improve this Doc + Improve this Doc - View Source + View Source

    FramerateLimit(FramerateLimit.LimitType, Int32)

    @@ -155,10 +155,10 @@ Vsync-enabled (sync to monitor refresh), or a specified fixed framerate (vsync d | - Improve this Doc + Improve this Doc - View Source + View Source

    FPS

    @@ -186,10 +186,10 @@ Vsync-enabled (sync to monitor refresh), or a specified fixed framerate (vsync d | - Improve this Doc + Improve this Doc - View Source + View Source

    Type

    @@ -219,10 +219,10 @@ Vsync-enabled (sync to monitor refresh), or a specified fixed framerate (vsync d | - Improve this Doc + Improve this Doc - View Source + View Source

    ToString()

    @@ -257,10 +257,10 @@ Vsync-enabled (sync to monitor refresh), or a specified fixed framerate (vsync d diff --git a/docs/api/ImGuiScene.GLTextureWrap.html b/docs/api/ImGuiScene.GLTextureWrap.html index 1ae296054..5b19c6733 100644 --- a/docs/api/ImGuiScene.GLTextureWrap.html +++ b/docs/api/ImGuiScene.GLTextureWrap.html @@ -121,10 +121,10 @@ Provides a simple wrapped view of the disposeable resource as well as the handle | - Improve this Doc + Improve this Doc - View Source + View Source

    GLTextureWrap(UInt32, Int32, Int32)

    @@ -165,10 +165,10 @@ Provides a simple wrapped view of the disposeable resource as well as the handle | - Improve this Doc + Improve this Doc - View Source + View Source

    Height

    @@ -195,10 +195,10 @@ Provides a simple wrapped view of the disposeable resource as well as the handle | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGuiHandle

    @@ -225,10 +225,10 @@ Provides a simple wrapped view of the disposeable resource as well as the handle | - Improve this Doc + Improve this Doc - View Source + View Source

    Width

    @@ -257,10 +257,10 @@ Provides a simple wrapped view of the disposeable resource as well as the handle | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose()

    @@ -272,10 +272,10 @@ Provides a simple wrapped view of the disposeable resource as well as the handle
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -304,10 +304,10 @@ Provides a simple wrapped view of the disposeable resource as well as the handle | - Improve this Doc + Improve this Doc - View Source + View Source

    Finalize()

    @@ -332,10 +332,10 @@ Provides a simple wrapped view of the disposeable resource as well as the handle diff --git a/docs/api/ImGuiScene.IImGuiInputHandler.html b/docs/api/ImGuiScene.IImGuiInputHandler.html index abea06ec7..bb0aba362 100644 --- a/docs/api/ImGuiScene.IImGuiInputHandler.html +++ b/docs/api/ImGuiScene.IImGuiInputHandler.html @@ -91,10 +91,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    NewFrame(Int32, Int32)

    @@ -128,10 +128,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    SetIniPath(String)

    @@ -166,10 +166,10 @@ diff --git a/docs/api/ImGuiScene.IImGuiRenderer.html b/docs/api/ImGuiScene.IImGuiRenderer.html index 07499b939..a2c87d626 100644 --- a/docs/api/ImGuiScene.IImGuiRenderer.html +++ b/docs/api/ImGuiScene.IImGuiRenderer.html @@ -86,10 +86,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Init(Object[])

    @@ -118,10 +118,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    NewFrame()

    @@ -133,10 +133,10 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source

    RenderDrawData(ImDrawDataPtr)

    @@ -165,10 +165,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Shutdown()

    @@ -186,10 +186,10 @@ diff --git a/docs/api/ImGuiScene.IRenderer.html b/docs/api/ImGuiScene.IRenderer.html index d4ef2c8f8..02dfe9047 100644 --- a/docs/api/ImGuiScene.IRenderer.html +++ b/docs/api/ImGuiScene.IRenderer.html @@ -92,10 +92,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ClearColor

    @@ -123,10 +123,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Debuggable

    @@ -154,10 +154,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Type

    @@ -185,10 +185,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Vsync

    @@ -218,10 +218,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    AttachToWindow(SimpleSDLWindow)

    @@ -255,10 +255,10 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Clear()

    @@ -271,10 +271,10 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateTexture(Void*, Int32, Int32, Int32)

    @@ -342,10 +342,10 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_Init()

    @@ -357,10 +357,10 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_NewFrame()

    @@ -372,10 +372,10 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_RenderDrawData(ImDrawDataPtr)

    @@ -404,10 +404,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_Shutdown()

    @@ -419,10 +419,10 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Present()

    @@ -441,10 +441,10 @@ diff --git a/docs/api/ImGuiScene.ImGui_Impl_DX11.html b/docs/api/ImGuiScene.ImGui_Impl_DX11.html index 92c52508f..ad273ff92 100644 --- a/docs/api/ImGuiScene.ImGui_Impl_DX11.html +++ b/docs/api/ImGuiScene.ImGui_Impl_DX11.html @@ -124,10 +124,10 @@ Would be nice to organize it better, but it seems to work

    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDeviceObjects()

    @@ -154,10 +154,10 @@ Would be nice to organize it better, but it seems to work

    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateFontsTexture()

    @@ -169,10 +169,10 @@ Would be nice to organize it better, but it seems to work

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Init(Object[])

    @@ -201,10 +201,10 @@ Would be nice to organize it better, but it seems to work

    | - Improve this Doc + Improve this Doc - View Source + View Source

    InvalidateDeviceObjects()

    @@ -216,10 +216,10 @@ Would be nice to organize it better, but it seems to work

    | - Improve this Doc + Improve this Doc - View Source + View Source

    NewFrame()

    @@ -231,10 +231,25 @@ Would be nice to organize it better, but it seems to work

    | - Improve this Doc + Improve this Doc - View Source + View Source + + +

    RebuildFontTexture()

    +
    +
    +
    Declaration
    +
    +
    public void RebuildFontTexture()
    +
    + + | + Improve this Doc + + + View Source

    RenderDrawData(ImDrawDataPtr)

    @@ -263,10 +278,10 @@ Would be nice to organize it better, but it seems to work

    | - Improve this Doc + Improve this Doc - View Source + View Source

    SetupRenderState(ImDrawDataPtr)

    @@ -295,10 +310,10 @@ Would be nice to organize it better, but it seems to work

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Shutdown()

    @@ -320,10 +335,10 @@ Would be nice to organize it better, but it seems to work

    diff --git a/docs/api/ImGuiScene.ImGui_Impl_OpenGL3.html b/docs/api/ImGuiScene.ImGui_Impl_OpenGL3.html index 5105e4b14..1bb1990c0 100644 --- a/docs/api/ImGuiScene.ImGui_Impl_OpenGL3.html +++ b/docs/api/ImGuiScene.ImGui_Impl_OpenGL3.html @@ -121,10 +121,10 @@ State backup IS done for this renderer, because SDL does not play nicely when us | - Improve this Doc + Improve this Doc - View Source + View Source

    Init(Object[])

    @@ -153,10 +153,10 @@ State backup IS done for this renderer, because SDL does not play nicely when us | - Improve this Doc + Improve this Doc - View Source + View Source

    NewFrame()

    @@ -168,10 +168,10 @@ State backup IS done for this renderer, because SDL does not play nicely when us | - Improve this Doc + Improve this Doc - View Source + View Source

    RenderDrawData(ImDrawDataPtr)

    @@ -200,10 +200,10 @@ State backup IS done for this renderer, because SDL does not play nicely when us | - Improve this Doc + Improve this Doc - View Source + View Source

    Shutdown()

    @@ -225,10 +225,10 @@ State backup IS done for this renderer, because SDL does not play nicely when us
    diff --git a/docs/api/ImGuiScene.ImGui_Impl_SDL.html b/docs/api/ImGuiScene.ImGui_Impl_SDL.html index 0dbe53ed0..afaab851e 100644 --- a/docs/api/ImGuiScene.ImGui_Impl_SDL.html +++ b/docs/api/ImGuiScene.ImGui_Impl_SDL.html @@ -121,10 +121,10 @@ A near-direct port of | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_Impl_SDL(IntPtr)

    @@ -155,10 +155,10 @@ A near-direct port of | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose()

    @@ -170,10 +170,10 @@ A near-direct port of | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -202,10 +202,10 @@ A near-direct port of | - Improve this Doc + Improve this Doc - View Source + View Source

    Finalize()

    @@ -217,10 +217,10 @@ A near-direct port of | - Improve this Doc + Improve this Doc - View Source + View Source

    NewFrame(Int32, Int32)

    @@ -254,10 +254,10 @@ A near-direct port of | - Improve this Doc + Improve this Doc - View Source + View Source

    SetIniPath(String)

    @@ -299,10 +299,10 @@ A near-direct port of diff --git a/docs/api/ImGuiScene.ImGui_Input_Impl_Direct.html b/docs/api/ImGuiScene.ImGui_Input_Impl_Direct.html index 0eb6cc8e2..2a63e7ca3 100644 --- a/docs/api/ImGuiScene.ImGui_Input_Impl_Direct.html +++ b/docs/api/ImGuiScene.ImGui_Input_Impl_Direct.html @@ -119,10 +119,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_Input_Impl_Direct(IntPtr)

    @@ -153,10 +153,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose()

    @@ -168,10 +168,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -200,10 +200,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Finalize()

    @@ -215,10 +215,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    IsImGuiCursor(IntPtr)

    @@ -262,10 +262,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    NewFrame(Int32, Int32)

    @@ -299,10 +299,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    SetIniPath(String)

    @@ -344,10 +344,10 @@
    diff --git a/docs/api/ImGuiScene.RawDX11Scene.BuildUIDelegate.html b/docs/api/ImGuiScene.RawDX11Scene.BuildUIDelegate.html index 66059e3fd..e71a5fa26 100644 --- a/docs/api/ImGuiScene.RawDX11Scene.BuildUIDelegate.html +++ b/docs/api/ImGuiScene.RawDX11Scene.BuildUIDelegate.html @@ -89,10 +89,10 @@
    diff --git a/docs/api/ImGuiScene.RawDX11Scene.NewInputFrameDelegate.html b/docs/api/ImGuiScene.RawDX11Scene.NewInputFrameDelegate.html index 738bb90ff..e4995fae7 100644 --- a/docs/api/ImGuiScene.RawDX11Scene.NewInputFrameDelegate.html +++ b/docs/api/ImGuiScene.RawDX11Scene.NewInputFrameDelegate.html @@ -89,10 +89,10 @@
    diff --git a/docs/api/ImGuiScene.RawDX11Scene.NewRenderFrameDelegate.html b/docs/api/ImGuiScene.RawDX11Scene.NewRenderFrameDelegate.html index 76300d037..7fcf73e8a 100644 --- a/docs/api/ImGuiScene.RawDX11Scene.NewRenderFrameDelegate.html +++ b/docs/api/ImGuiScene.RawDX11Scene.NewRenderFrameDelegate.html @@ -89,10 +89,10 @@
    diff --git a/docs/api/ImGuiScene.RawDX11Scene.html b/docs/api/ImGuiScene.RawDX11Scene.html index 8fbb9a665..2a6a5ea03 100644 --- a/docs/api/ImGuiScene.RawDX11Scene.html +++ b/docs/api/ImGuiScene.RawDX11Scene.html @@ -118,10 +118,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    RawDX11Scene(IntPtr)

    @@ -150,10 +150,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    RawDX11Scene(IntPtr, IntPtr)

    @@ -189,10 +189,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    OnBuildUI

    User methods invoked every ImGui frame to construct custom UIs.

    @@ -219,10 +219,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    OnNewInputFrame

    @@ -248,10 +248,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    OnNewRenderFrame

    @@ -279,10 +279,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGuiIniPath

    @@ -311,10 +311,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    CaptureScreenshot()

    @@ -341,10 +341,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose()

    @@ -356,10 +356,10 @@
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Finalize()

    @@ -371,10 +371,25 @@ | - Improve this Doc + Improve this Doc - View Source + View Source + + +

    InvalidateFonts()

    +
    +
    +
    Declaration
    +
    +
    public void InvalidateFonts()
    +
    + + | + Improve this Doc + + + View Source

    IsImGuiCursor(IntPtr)

    @@ -418,10 +433,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    LoadImage(Byte[])

    @@ -465,10 +480,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    LoadImage(String)

    @@ -512,10 +527,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    LoadImageRaw(Byte[], Int32, Int32, Int32)

    @@ -574,10 +589,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    OnPostResize(Int32, Int32)

    @@ -611,10 +626,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    OnPreResize()

    @@ -626,10 +641,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Render()

    @@ -651,10 +666,10 @@
    diff --git a/docs/api/ImGuiScene.RendererFactory.RendererBackend.html b/docs/api/ImGuiScene.RendererFactory.RendererBackend.html index 5d9807f5d..bded16886 100644 --- a/docs/api/ImGuiScene.RendererFactory.RendererBackend.html +++ b/docs/api/ImGuiScene.RendererFactory.RendererBackend.html @@ -113,10 +113,10 @@
    diff --git a/docs/api/ImGuiScene.RendererFactory.html b/docs/api/ImGuiScene.RendererFactory.html index 8c0c21c31..8e6a4c892 100644 --- a/docs/api/ImGuiScene.RendererFactory.html +++ b/docs/api/ImGuiScene.RendererFactory.html @@ -115,10 +115,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateRenderer(RendererFactory.RendererBackend, Boolean)

    @@ -176,10 +176,10 @@
    diff --git a/docs/api/ImGuiScene.SDLWindowGL.html b/docs/api/ImGuiScene.SDLWindowGL.html index b2ad57df1..6c29c4d87 100644 --- a/docs/api/ImGuiScene.SDLWindowGL.html +++ b/docs/api/ImGuiScene.SDLWindowGL.html @@ -147,10 +147,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    InitForRenderer(IRenderer)

    @@ -183,10 +183,10 @@
    SimpleSDLWindow.InitForRenderer(IRenderer)
    | - Improve this Doc + Improve this Doc - View Source + View Source

    WindowCreationFlags(WindowCreateInfo)

    @@ -245,10 +245,10 @@
    diff --git a/docs/api/ImGuiScene.SimpleD3D.html b/docs/api/ImGuiScene.SimpleD3D.html index 55bfd2a66..c45d7b0a4 100644 --- a/docs/api/ImGuiScene.SimpleD3D.html +++ b/docs/api/ImGuiScene.SimpleD3D.html @@ -120,10 +120,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ClearColor

    @@ -151,10 +151,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Debuggable

    @@ -182,10 +182,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Type

    @@ -213,10 +213,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Vsync

    @@ -246,10 +246,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    AttachToWindow(SimpleSDLWindow)

    @@ -280,10 +280,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Clear()

    @@ -296,10 +296,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateTexture(Void*, Int32, Int32, Int32)

    @@ -367,10 +367,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose()

    @@ -382,10 +382,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -414,10 +414,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Finalize()

    @@ -429,10 +429,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_Init()

    @@ -444,10 +444,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_NewFrame()

    @@ -459,10 +459,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_RenderDrawData(ImDrawDataPtr)

    @@ -491,10 +491,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_Shutdown()

    @@ -506,10 +506,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Present()

    @@ -535,10 +535,10 @@
    diff --git a/docs/api/ImGuiScene.SimpleImGuiScene.BuildUIDelegate.html b/docs/api/ImGuiScene.SimpleImGuiScene.BuildUIDelegate.html index 149554e88..20010f5f8 100644 --- a/docs/api/ImGuiScene.SimpleImGuiScene.BuildUIDelegate.html +++ b/docs/api/ImGuiScene.SimpleImGuiScene.BuildUIDelegate.html @@ -89,10 +89,10 @@
    diff --git a/docs/api/ImGuiScene.SimpleImGuiScene.html b/docs/api/ImGuiScene.SimpleImGuiScene.html index f839f6e1f..518f024d9 100644 --- a/docs/api/ImGuiScene.SimpleImGuiScene.html +++ b/docs/api/ImGuiScene.SimpleImGuiScene.html @@ -121,10 +121,10 @@ Currently this always creates a new window rather than take ownership of an exis | - Improve this Doc + Improve this Doc - View Source + View Source

    SimpleImGuiScene(RendererFactory.RendererBackend, WindowCreateInfo, Boolean)

    @@ -168,10 +168,10 @@ Currently this always creates a new window rather than take ownership of an exis | - Improve this Doc + Improve this Doc - View Source + View Source

    OnBuildUI

    User methods invoked every ImGui frame to construct custom UIs.

    @@ -200,10 +200,10 @@ Currently this always creates a new window rather than take ownership of an exis | - Improve this Doc + Improve this Doc - View Source + View Source

    FramerateLimit

    @@ -232,10 +232,10 @@ The default behavior is | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGuiIniPath

    @@ -262,10 +262,10 @@ The default behavior is | - Improve this Doc + Improve this Doc - View Source + View Source

    OnSDLEvent

    @@ -294,10 +294,10 @@ This is just a convenience wrapper around | - Improve this Doc + Improve this Doc - View Source + View Source

    PauseWhenUnfocused

    @@ -327,10 +327,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Renderer

    @@ -358,10 +358,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    ShouldQuit

    @@ -389,10 +389,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Window

    @@ -422,10 +422,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateOverlay(RendererFactory.RendererBackend, SDL.SDL_Scancode, Single[], Boolean)

    @@ -489,10 +489,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose()

    @@ -504,10 +504,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -536,10 +536,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Finalize()

    @@ -551,10 +551,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    LoadImage(Byte[])

    @@ -604,10 +604,10 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    LoadImage(String)

    @@ -657,10 +657,72 @@ if you are rendering dynamic data.

    | - Improve this Doc + Improve this Doc - View Source + View Source + + +

    LoadImageRaw(Byte[], Int32, Int32, Int32)

    +
    +
    +
    Declaration
    +
    +
    public TextureWrap LoadImageRaw(byte[] imageData, int width, int height, int numChannels = 4)
    +
    +
    Parameters
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescription
    System.Byte[]imageData
    System.Int32width
    System.Int32height
    System.Int32numChannels
    +
    Returns
    + + + + + + + + + + + + + +
    TypeDescription
    TextureWrap
    + + | + Improve this Doc + + + View Source

    Run()

    @@ -674,10 +736,10 @@ requests an exit (via | - Improve this Doc + Improve this Doc - View Source + View Source

    Update()

    @@ -701,10 +763,10 @@ This method does not check any quit conditions.

    diff --git a/docs/api/ImGuiScene.SimpleOGL3.html b/docs/api/ImGuiScene.SimpleOGL3.html index f7de56b94..b477d807c 100644 --- a/docs/api/ImGuiScene.SimpleOGL3.html +++ b/docs/api/ImGuiScene.SimpleOGL3.html @@ -120,10 +120,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ClearColor

    @@ -151,10 +151,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ContextMajorVersion

    @@ -181,10 +181,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ContextMinorVersion

    @@ -211,10 +211,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Debuggable

    @@ -242,10 +242,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Type

    @@ -273,10 +273,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Vsync

    @@ -306,10 +306,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    AttachToWindow(SimpleSDLWindow)

    @@ -340,10 +340,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Clear()

    @@ -356,10 +356,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateTexture(Void*, Int32, Int32, Int32)

    @@ -418,10 +418,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose()

    @@ -433,10 +433,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -465,10 +465,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Finalize()

    @@ -480,10 +480,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_Init()

    @@ -495,10 +495,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_NewFrame()

    @@ -510,10 +510,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_RenderDrawData(ImDrawDataPtr)

    @@ -542,10 +542,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGui_Shutdown()

    @@ -557,10 +557,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Present()

    @@ -586,10 +586,10 @@
    diff --git a/docs/api/ImGuiScene.SimpleSDLWindow.ProcessEventDelegate.html b/docs/api/ImGuiScene.SimpleSDLWindow.ProcessEventDelegate.html index 9f66443c7..54fbebe4b 100644 --- a/docs/api/ImGuiScene.SimpleSDLWindow.ProcessEventDelegate.html +++ b/docs/api/ImGuiScene.SimpleSDLWindow.ProcessEventDelegate.html @@ -106,10 +106,10 @@
    diff --git a/docs/api/ImGuiScene.SimpleSDLWindow.html b/docs/api/ImGuiScene.SimpleSDLWindow.html index 9749dd6ab..6baae2492 100644 --- a/docs/api/ImGuiScene.SimpleSDLWindow.html +++ b/docs/api/ImGuiScene.SimpleSDLWindow.html @@ -120,10 +120,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    OnSDLEvent

    @@ -151,10 +151,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    WantsClose

    @@ -182,10 +182,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Window

    @@ -215,10 +215,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateColorKey(Single, Single, Single)

    @@ -276,10 +276,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose()

    @@ -291,10 +291,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Dispose(Boolean)

    @@ -323,10 +323,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Finalize()

    @@ -338,10 +338,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    GetHWnd()

    @@ -370,10 +370,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    InitForRenderer(IRenderer)

    @@ -402,10 +402,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    MakeTransparent(UInt32)

    @@ -440,10 +440,10 @@ Transparent regions behave as if they are not present, and can be clicked throug | - Improve this Doc + Improve this Doc - View Source + View Source

    ProcessEvents()

    @@ -457,10 +457,10 @@ User handlers from | - Improve this Doc + Improve this Doc - View Source + View Source

    WindowCreationFlags(WindowCreateInfo)

    @@ -517,10 +517,10 @@ User handlers from diff --git a/docs/api/ImGuiScene.TextureWrap.html b/docs/api/ImGuiScene.TextureWrap.html index 8a98e11f9..121fb9693 100644 --- a/docs/api/ImGuiScene.TextureWrap.html +++ b/docs/api/ImGuiScene.TextureWrap.html @@ -92,10 +92,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Height

    @@ -122,10 +122,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    ImGuiHandle

    @@ -153,10 +153,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Width

    @@ -189,10 +189,10 @@
    diff --git a/docs/api/ImGuiScene.WindowCreateInfo.html b/docs/api/ImGuiScene.WindowCreateInfo.html index 0f52e6d35..32f658fcd 100644 --- a/docs/api/ImGuiScene.WindowCreateInfo.html +++ b/docs/api/ImGuiScene.WindowCreateInfo.html @@ -115,10 +115,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    Fullscreen

    Whether the window should be created fullscreen. This is a borderless windowed mode and will not affect desktop resolution. @@ -146,10 +146,10 @@ Fullscreen windows are "always on top".

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Height

    The height of the window. Ignored for fullscreen windows.

    @@ -176,10 +176,10 @@ Fullscreen windows are "always on top".

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Title

    The window title. This will not be visible for fullscreen windows except in things like task manager.

    @@ -206,10 +206,10 @@ Fullscreen windows are "always on top".

    | - Improve this Doc + Improve this Doc - View Source + View Source

    TransparentColor

    An optional float[4] color key used to make any matching portion of the window's client area transparent. For example, setting this to magenta will @@ -238,10 +238,10 @@ Values are red, green, blue from 0 to 1.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Width

    The width of the window. Ignored for fullscreen windows.

    @@ -268,10 +268,10 @@ Values are red, green, blue from 0 to 1.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    XPos

    The x location of the top left corner of the window. Ignored for fullscreen windows.

    @@ -298,10 +298,10 @@ Values are red, green, blue from 0 to 1.

    | - Improve this Doc + Improve this Doc - View Source + View Source

    YPos

    The y location of the top left corner of the window. Ignored for fullscreen windows.

    @@ -334,10 +334,10 @@ Values are red, green, blue from 0 to 1.

    diff --git a/docs/api/ImGuiScene.WindowFactory.html b/docs/api/ImGuiScene.WindowFactory.html index 7708e24e4..27b357d42 100644 --- a/docs/api/ImGuiScene.WindowFactory.html +++ b/docs/api/ImGuiScene.WindowFactory.html @@ -115,10 +115,10 @@ | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateForRenderer(IRenderer, WindowCreateInfo)

    @@ -176,10 +176,10 @@ diff --git a/docs/api/toc.html b/docs/api/toc.html index c15b94293..2ab6497cd 100644 --- a/docs/api/toc.html +++ b/docs/api/toc.html @@ -50,12 +50,18 @@ Dalamud.Data.TransientSheet
  • @@ -119,6 +125,9 @@
  • SeString
  • +
  • + SeStringUtils +
  • @@ -129,6 +138,9 @@
  • AutoTranslatePayload
  • +
  • + EmphasisItalicPayload +
  • ItemPayload
  • @@ -182,6 +194,9 @@
  • ActorTable
  • +
  • + CustomizeIndex +
  • ObjectKind
  • @@ -252,6 +267,9 @@
  • PartyMember
  • +
  • + StatusEffect +
  • @@ -399,6 +417,9 @@
  • ChatGui
  • +
  • + ChatGui.OnCheckMessageHandledDelegate +
  • ChatGui.OnMessageDelegate
  • @@ -441,7 +462,10 @@ GameNetwork
  • - GameNetwork.OnZonePacketDelegate + GameNetwork.OnNetworkMessageDelegate +
  • +
  • + NetworkMessageDirection
  • @@ -488,6 +512,12 @@ Dalamud.Interface