diff --git a/docs/README.html b/docs/README.html
index 6950c2aa4..466fb11e8 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -122,15 +122,15 @@ Dalamud can be loaded via DLL injection, or by rewriting a process' entrypoint.<
Scan for a .data address using a .text function.
This is intended to be used with IDA sigs.
-Place your cursor on the line calling a static address, and create and IDA sig.
+Place your cursor on the line calling a static address, and create and IDA sig.
+The signature and offset should not break through instruction boundaries.
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.html
index f23592bbc..57cd62c16 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.ItemPayload.html
@@ -287,8 +287,7 @@ often the name is only present in a following text payload.
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.MapLinkPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.MapLinkPayload.html
index 82a276f02..6757f05f4 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.MapLinkPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.MapLinkPayload.html
@@ -270,8 +270,7 @@ as possible but is an approximation and may be slightly off for some positions.<
@@ -507,7 +502,7 @@ public TerritoryType TerritoryType { get; }
-
Lumina.Excel.GeneratedSheets.TerritoryType
+
TerritoryType
@@ -593,8 +588,7 @@ public TerritoryType TerritoryType { get; }
Declaration
-
[JsonIgnore]
-public float YCoord { get; }
+
public float YCoord { get; }
Property Value
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.PlayerPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.PlayerPayload.html
index fa38f1811..19a11a4e3 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.PlayerPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.PlayerPayload.html
@@ -199,8 +199,7 @@ The world name will always be present.
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.QuestPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.QuestPayload.html
index 7292064ac..7c4608332 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.QuestPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.QuestPayload.html
@@ -192,8 +192,7 @@ Creates a payload representing an interactable quest link for the specified ques
Declaration
-
[JsonIgnore]
-public Quest Quest { get; }
+
public Quest Quest { get; }
Property Value
@@ -205,7 +204,7 @@ public Quest Quest { get; }
-
Lumina.Excel.GeneratedSheets.Quest
+
Quest
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.RawPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.RawPayload.html
index 95df0595c..7d774d72d 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.RawPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.RawPayload.html
@@ -188,8 +188,7 @@ The returned data is a clone and modifications will not be persisted.
Declaration
-
[JsonIgnore]
-public byte[] Data { get; }
+
public byte[] Data { get; }
Property Value
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.StatusPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.StatusPayload.html
index b1d26e970..48d125f07 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.StatusPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.StatusPayload.html
@@ -192,8 +192,7 @@ Creates a new StatusPayload for the given status id.
Declaration
-
[JsonIgnore]
-public Status Status { get; }
+
public Status Status { get; }
Property Value
@@ -205,7 +204,7 @@ public Status Status { get; }
-
Lumina.Excel.GeneratedSheets.Status
+
Status
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.TextPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.TextPayload.html
index a2ef3f638..af8376b0f 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.TextPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.TextPayload.html
@@ -197,8 +197,7 @@ This may contain SE's special unicode characters.
Declaration
-
[JsonIgnore]
-public string Text { get; set; }
+
public string Text { get; set; }
Property Value
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.UIForegroundPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.UIForegroundPayload.html
index 9d63b672d..d2cf29aa7 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.UIForegroundPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.UIForegroundPayload.html
@@ -192,8 +192,7 @@ Creates a new UIForegroundPayload for the given UIColor key.
@@ -333,7 +330,7 @@ public UIColor UIColor { get; }
-
Lumina.Excel.GeneratedSheets.UIColor
+
UIColor
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.UIGlowPayload.html b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.UIGlowPayload.html
index f635cdb52..8034795fe 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.UIGlowPayload.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.Payloads.UIGlowPayload.html
@@ -192,8 +192,7 @@ Creates a new UIForegroundPayload for the given UIColor key.
@@ -333,7 +330,7 @@ public UIColor UIColor { get; }
-
Lumina.Excel.GeneratedSheets.UIColor
+
UIColor
diff --git a/docs/api/Dalamud.Game.Text.SeStringHandling.SeString.html b/docs/api/Dalamud.Game.Text.SeStringHandling.SeString.html
index 55bbd5fd2..6e64df729 100644
--- a/docs/api/Dalamud.Game.Text.SeStringHandling.SeString.html
+++ b/docs/api/Dalamud.Game.Text.SeStringHandling.SeString.html
@@ -177,8 +177,7 @@ Creates a new SeString from an ordered list of payloads.
diff --git a/docs/api/Dalamud.Interface.UiBuilder.html b/docs/api/Dalamud.Interface.UiBuilder.html
index deaab7b1d..8b6a88621 100644
--- a/docs/api/Dalamud.Interface.UiBuilder.html
+++ b/docs/api/Dalamud.Interface.UiBuilder.html
@@ -206,7 +206,7 @@ It can be used to draw custom windows and overlays.
diff --git a/docs/api/Dalamud.Interface.Windowing.WindowSystem.html b/docs/api/Dalamud.Interface.Windowing.WindowSystem.html
index ace42c028..9b5190125 100644
--- a/docs/api/Dalamud.Interface.Windowing.WindowSystem.html
+++ b/docs/api/Dalamud.Interface.Windowing.WindowSystem.html
@@ -378,7 +378,7 @@ that has focus and is not marked to be excluded from consideration.
Improve this Doc
- View Source
+ View Source
Gets the repository from which this plugin was installed.
+
If a plugin was installed from the official/main repository, this will return the value of
+Dalamud.Plugin.Internal.Types.LocalPluginManifest.FlagMainRepo. Developer plugins will return the value of
+Dalamud.Plugin.Internal.Types.LocalPluginManifest.FlagDevPlugin.
diff --git a/docs/api/Dalamud.Utility.MapUtil.html b/docs/api/Dalamud.Utility.MapUtil.html
index 5c80d0600..54bfce76f 100644
--- a/docs/api/Dalamud.Utility.MapUtil.html
+++ b/docs/api/Dalamud.Utility.MapUtil.html
@@ -243,13 +243,13 @@ it with 0 for calculation purposes to show a more sane Z coordinate.
The current level of the Cozy Cabin for the Island Sanctuary.
+
+
+
Declaration
+
+
public byte CabinLevel
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Byte
+
+
+
+
+
Remarks
+
This field is offset by 1 compared to the level present in MJIBuildings. Cabin Level 3 will actually have
+a value of 3 in this field. This is probably because Cabin Level 0 is "nonexistent"..?
The current Sanctuary Rank of the player's island. Controls what buildings/items/recipes are or aren't
+available to the player, and represented by MJIRank.
A struct representing the current state of granaries present on the island. See the struct documentation
+for more information on how to access this data.
An array of booleans representing if a specific item is (un)locked. Locked/unavailable items are set to true,
+while those that are unlocked are false. This array is indexed by RowID from the MJIItemPouch table.
+An item appears to be unlocked upon being gathered or crafted for the first time.
+IsPouchItemLocked(UInt16)
A bitfield representing all unlocked key items (MJIKeyItem) for the player. Backing field for
+IsKeyItemUnlocked(UInt16), which should be used where possible.
+
+
+
Declaration
+
+
public ushort UnlockedKeyItems
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.UInt16
+
+
+
+
+
Remarks
+
The index of this field will be (RowID - 1), so "Islekeep's Stone Hatchet" appears at position 0.
A bitfield representing if a specific recipe (MJIRecipe) is unlocked. Backing field for
+IsRecipeUnlocked(UInt16), which should be used where possible.
A struct representing the current state of workshops present on the island. See the struct documentation
+for more information on how to access this data.
+
Note that this struct only provides mapping from a workshop ID to other data.
At load, the location of this specific building. Will update if a building is changed, but the exact
+mechanism of the update (and why it does such) is not currently known.
When a building is fully constructed, this will be the value present at offset +0x0C from MJIBuilding. While
+a building is under construction, however, the appropriate model (as determined by progress) will be shown
+from columns +0E, +10, +12, or +14.
+
Can also be zero, if nothing is built in that location yet.
A struct representing a list of granaries present in the Island Sanctuary.
+
The struct provides a helper method to retrieve information about a single granary (referenced by ID), but will
+otherwise allow querying a specific field by ID directly.
A struct representing building placements on the Island Sanctuary. Each index represents a specific building
+slot directly. Refer to MJIBuildingPlacement for more information.
+
+
+
Declaration
+
+
public byte *BuildingPlacements
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Byte*
+
+
+
+
+
Remarks
+
This field's exact purpose is currently unknown, but seems to be related to either mapping or rendering
+logic. To that end, this field doesn't actually seem authoritative for determining what's going on - see
+Granaries and Workshops for what seems to be
+used by system logic.
An array containing the currently-configured rest days for the Isleworks. Contains values 0 - 13, and is
+always in order.
+
+
+
Declaration
+
+
public byte *CraftworksRestDays
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Byte*
+
+
+
+
+
Remarks
+
Like CurrentCycleDay, 0 represents Reset Day. 7, likewise, represents the next reset. This field may not be
+populated until the Craftworks have been opened at least once.
A reference to the current set of popularity scores given to craftworks on the player's island. The actual
+popularity scores can be pulled from the MJICraftworksPopularity sheet using this value as a Row ID.
A struct representing landmark placements on the Island Sanctuary. Each index represents a specific landmark
+slot directly. Refer to MJILandmarkPlacement for more information.
+
+
+
Declaration
+
+
public byte *LandmarkPlacements
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Byte*
+
+
+
+
+
Remarks
+
This field's exact purpose is currently unknown, but seems to be related to either mapping or rendering
+logic. To that end, this field doesn't actually seem authoritative for determining what's going on - see
+LandmarkIds et al for what seems to be used by system logic.
An array of bytes representing the current supply and demand shift for each craftwork that the player can
+create. Information for a specific item can be retrieved by querying the RowID for the item under inspection.
+
+The current supply value is stored in the upper half of each byte, while the current demand shift is stored in
+the lower half.
A struct representing a list of workshops present in the Island Sanctuary.
+
The struct provides a helper method to retrieve information about a single workshop (referenced by ID), but will
+otherwise allow querying a specific field by ID directly.
A struct representing a list of granaries present in the Island Sanctuary.
+
The struct provides a helper method to retrieve information about a single granary (referenced by ID), but will
+otherwise allow querying a specific field by ID directly.
A struct representing a list of workshops present in the Island Sanctuary.
+
The struct provides a helper method to retrieve information about a single workshop (referenced by ID), but will
+otherwise allow querying a specific field by ID directly.
A struct representing a list of granaries present in the Island Sanctuary.
-
The struct provides a helper method to retrieve information about a single granary (referenced by ID), but will
-otherwise allow querying a specific field by ID directly.
A struct representing a list of workshops present in the Island Sanctuary.
-
The struct provides a helper method to retrieve information about a single workshop (referenced by ID), but will
-otherwise allow querying a specific field by ID directly.
A "boolean" representing if this specific hotbar slot has been fully loaded. False for empty slots and slots
@@ -376,7 +376,7 @@ reset if the slot is hidden (and subsequently outdated).
public void SetupSearchSpace(nint memoryPointer, int memorySize, int textSectionOffset, int textSectionSize, int dataSectionOffset, int dataSectionSize, int rdataSectionOffset, int rdataSectionSize, FileInfo? cacheFile = null)
Separates the given string into lines, and then appends each line, prefixed
+by the current indent and followed by a new line, to the string being built.
+
+
+
Declaration
+
+
public virtual IndentedStringBuilder AppendLines(string value, bool skipFinalNewline = false)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
value
+
The string to append.
+
+
+
+
System.Boolean
+
skipFinalNewline
+
If true, then the terminating new line is not added after the last line.
diff --git a/docs/api/ImGuiScene.FramerateLimit.LimitType.html b/docs/api/ImGuiScene.FramerateLimit.LimitType.html
index e946e6074..bd3456007 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.GLTextureWrap.html b/docs/api/ImGuiScene.GLTextureWrap.html
index c8f3b2ca9..99c229197 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
diff --git a/docs/api/ImGuiScene.ImGui_Impl_DX11.html b/docs/api/ImGuiScene.ImGui_Impl_DX11.html
index 85802158d..ba72a4043 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
diff --git a/docs/api/ImGuiScene.ImGui_Impl_OpenGL3.html b/docs/api/ImGuiScene.ImGui_Impl_OpenGL3.html
index 1cb5895b4..cadae9be9 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
diff --git a/docs/api/ImGuiScene.SimpleImGuiScene.html b/docs/api/ImGuiScene.SimpleImGuiScene.html
index 201fb195f..b28119b08 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
diff --git a/docs/api/ImGuiScene.WindowCreateInfo.html b/docs/api/ImGuiScene.WindowCreateInfo.html
index 64f286ce2..8658feac7 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".
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.