587 lines
22 KiB
C#
Executable File
587 lines
22 KiB
C#
Executable File
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Runtime.InteropServices;
|
|
using Dalamud.ContextMenu;
|
|
using Dalamud.Game;
|
|
using Dalamud.Game.Command;
|
|
using Dalamud.Game.Text.SeStringHandling;
|
|
using Dalamud.Game.Text.SeStringHandling.Payloads;
|
|
using FFXIVClientStructs.FFXIV.Client.UI;
|
|
using FFXIVClientStructs.FFXIV.Client.UI.Agent;
|
|
using FFXIVClientStructs.FFXIV.Component.GUI;
|
|
using ImGuiNET;
|
|
using Lumina.Excel.GeneratedSheets;
|
|
|
|
namespace RoleplayersToolbox.Tools.Housing {
|
|
internal class HousingTool : BaseTool, IDisposable {
|
|
private static class Signatures {
|
|
internal const string AddonMapHide = "40 53 48 83 EC 30 0F B6 91 ?? ?? ?? ?? 48 8B D9 E8 ?? ?? ?? ??";
|
|
}
|
|
|
|
// AgentMap.vf8 has this offset if the sig above doesn't work
|
|
private const int AgentMapFlagSetOffset = 0x5997;
|
|
|
|
private delegate IntPtr AddonMapHideDelegate(IntPtr addon);
|
|
|
|
public override string Name => "Housing";
|
|
private Plugin Plugin { get; }
|
|
private HousingConfig Config { get; }
|
|
internal HousingInfo Info { get; }
|
|
private BookmarksUi BookmarksUi { get; }
|
|
private Teleport Teleport { get; }
|
|
|
|
private DestinationInfo? _destination;
|
|
|
|
internal DestinationInfo? Destination {
|
|
get => this._destination;
|
|
set {
|
|
this._destination = value;
|
|
|
|
if (value == null) {
|
|
this.ClearFlagAndCloseMap();
|
|
} else if (this.Config.PlaceFlagOnSelect) {
|
|
this.FlagDestinationOnMap();
|
|
}
|
|
}
|
|
}
|
|
|
|
private readonly AddonMapHideDelegate? _addonMapHide;
|
|
|
|
private readonly List<(string, List<World>)> _worlds = new();
|
|
|
|
internal HousingTool(Plugin plugin) {
|
|
this.Plugin = plugin;
|
|
this.Config = plugin.Config.Tools.Housing;
|
|
this.Info = new HousingInfo(plugin);
|
|
this.BookmarksUi = new BookmarksUi(plugin, this, this.Config);
|
|
this.Teleport = new Teleport(plugin);
|
|
|
|
this._worlds = this.Plugin.DataManager.GetExcelSheet<World>()!
|
|
.Where(row => row.IsPublic)
|
|
.GroupBy(row => row.DataCenter.Value!)
|
|
.Where(grouping => grouping.Key.Region != 0)
|
|
.OrderBy(grouping => grouping.Key.Region)
|
|
.ThenBy(grouping => grouping.Key.Name.RawString)
|
|
.Select(grouping => (grouping.Key.Name.RawString, grouping.OrderBy(row => row.Name.RawString).ToList()))
|
|
.ToList();
|
|
|
|
if (this.Plugin.SigScanner.TryScanText(Signatures.AddonMapHide, out var addonMapHidePtr)) {
|
|
this._addonMapHide = Marshal.GetDelegateForFunctionPointer<AddonMapHideDelegate>(addonMapHidePtr);
|
|
}
|
|
|
|
this.Plugin.ContextMenu.OnOpenGameObjectContextMenu += this.OnContextMenu;
|
|
this.Plugin.Framework.Update += this.OnFramework;
|
|
this.Plugin.CommandManager.AddHandler("/route", new CommandInfo(this.OnRouteCommand) {
|
|
HelpMessage = "Extract housing information from the given text and open the routing window",
|
|
});
|
|
this.Plugin.CommandManager.AddHandler("/bookmarks", new CommandInfo(this.OnBookmarksCommand) {
|
|
HelpMessage = "Toggles the housing bookmarks window",
|
|
});
|
|
}
|
|
|
|
public void Dispose() {
|
|
this.Plugin.CommandManager.RemoveHandler("/bookmarks");
|
|
this.Plugin.CommandManager.RemoveHandler("/route");
|
|
this.Plugin.Framework.Update -= this.OnFramework;
|
|
this.Plugin.ContextMenu.OnOpenGameObjectContextMenu -= this.OnContextMenu;
|
|
}
|
|
|
|
public override void DrawSettings(ref bool anyChanged) {
|
|
anyChanged |= ImGui.Checkbox("Place flag and open map after selecting destination", ref this.Config.PlaceFlagOnSelect);
|
|
anyChanged |= ImGui.Checkbox("Clear flag on approach", ref this.Config.ClearFlagOnApproach);
|
|
anyChanged |= ImGui.Checkbox("Close map on approach", ref this.Config.CloseMapOnApproach);
|
|
|
|
ImGui.Separator();
|
|
|
|
if (ImGui.Button("Open routing window")) {
|
|
this.Destination = new DestinationInfo(this.Info);
|
|
}
|
|
|
|
ImGui.TextUnformatted("You can also use the /route command for this.");
|
|
ImGui.TextUnformatted("Ex: /route jen lb w5 p3");
|
|
|
|
ImGui.Separator();
|
|
|
|
if (ImGui.Button("Open housing bookmarks")) {
|
|
this.BookmarksUi.ShouldDraw = true;
|
|
}
|
|
|
|
ImGui.TextUnformatted("You can also use the /bookmarks command for this.");
|
|
}
|
|
|
|
public override void DrawAlways() {
|
|
this.BookmarksUi.Draw();
|
|
|
|
if (this.Destination == null) {
|
|
return;
|
|
}
|
|
|
|
if (!ImGui.Begin("Housing destination", ImGuiWindowFlags.AlwaysAutoResize)) {
|
|
ImGui.End();
|
|
return;
|
|
}
|
|
|
|
ImGui.TextUnformatted("Routing to...");
|
|
|
|
var anyChanged = false;
|
|
|
|
var world = this.Destination.World;
|
|
if (ImGui.BeginCombo("World", world?.Name?.ToString() ?? string.Empty)) {
|
|
var currentDc = this.Plugin.ClientState.LocalPlayer?.CurrentWorld.GameData?.DataCenter?.Value?.Name?.RawString;
|
|
|
|
foreach (var (dc, worlds) in this._worlds) {
|
|
if (ImGui.IsWindowAppearing() && world == null && dc == currentDc) {
|
|
ImGui.SetScrollHereY(0.5f);
|
|
}
|
|
|
|
ImGui.PushStyleColor(ImGuiCol.Text, ImGui.GetStyle().Colors[(int) ImGuiCol.TextDisabled]);
|
|
ImGui.TextUnformatted(dc);
|
|
ImGui.PopStyleColor();
|
|
ImGui.Separator();
|
|
|
|
foreach (var availWorld in worlds) {
|
|
var isSelected = world?.RowId == availWorld.RowId;
|
|
|
|
if (ImGui.IsWindowAppearing() && isSelected) {
|
|
ImGui.SetScrollHereY(0.5f);
|
|
}
|
|
|
|
if (!ImGui.Selectable(availWorld.Name.RawString, isSelected)) {
|
|
continue;
|
|
}
|
|
|
|
this.Destination.World = availWorld;
|
|
anyChanged = true;
|
|
}
|
|
|
|
ImGui.Spacing();
|
|
}
|
|
|
|
ImGui.EndCombo();
|
|
}
|
|
|
|
var area = this.Destination.Area;
|
|
if (ImGui.BeginCombo("Housing area", area?.Name() ?? string.Empty)) {
|
|
foreach (var housingArea in (HousingArea[]) Enum.GetValues(typeof(HousingArea))) {
|
|
if (!ImGui.Selectable(housingArea.Name(), area == housingArea)) {
|
|
continue;
|
|
}
|
|
|
|
this.Destination.Area = housingArea;
|
|
anyChanged = true;
|
|
}
|
|
|
|
ImGui.EndCombo();
|
|
}
|
|
|
|
var ward = (int) (this.Destination.Ward ?? 0);
|
|
if (ImGui.InputInt("Ward", ref ward)) {
|
|
this.Destination.Ward = (uint) Math.Max(1, Math.Min(24, ward));
|
|
anyChanged = true;
|
|
}
|
|
|
|
var plot = (int) (this.Destination.Plot ?? 0);
|
|
if (ImGui.InputInt("Plot", ref plot)) {
|
|
this.Destination.Plot = (uint) Math.Max(1, Math.Min(60, plot));
|
|
anyChanged = true;
|
|
}
|
|
|
|
if (ImGui.Button("Clear")) {
|
|
this.Destination = null;
|
|
}
|
|
|
|
if (this.Destination?.Area != null) {
|
|
ImGui.SameLine();
|
|
|
|
var destArea = this.Destination.Area.Value;
|
|
if (!destArea.CanWorldTravel() && this.Destination?.World != null && this.Destination?.World != this.Plugin.ClientState.LocalPlayer?.CurrentWorld.GameData) {
|
|
destArea = HousingArea.Mist;
|
|
}
|
|
|
|
var name = destArea.CityState(this.Plugin.DataManager).PlaceName.Value!.Name;
|
|
if (ImGui.Button($"Teleport to {name}")) {
|
|
this.Teleport.TeleportToHousingArea(destArea);
|
|
}
|
|
}
|
|
|
|
if (anyChanged) {
|
|
this.FlagDestinationOnMap();
|
|
}
|
|
|
|
ImGui.End();
|
|
}
|
|
|
|
private void OnRouteCommand(string command, string arguments) {
|
|
var player = this.Plugin.ClientState.LocalPlayer;
|
|
if (player == null) {
|
|
return;
|
|
}
|
|
|
|
this.Destination = InfoExtractor.Extract(arguments, player.HomeWorld.GameData.DataCenter.Row, this.Plugin.DataManager, this.Info);
|
|
}
|
|
|
|
private void OnBookmarksCommand(string command, string arguments) {
|
|
this.BookmarksUi.ShouldDraw ^= true;
|
|
}
|
|
|
|
private void OnContextMenu(GameObjectContextMenuOpenArgs args) {
|
|
if (args.ParentAddonName != "LookingForGroup" || args.ContentIdLower is 0) {
|
|
return;
|
|
}
|
|
|
|
args.AddCustomItem(new GameObjectContextMenuItem("Select as Destination", this.SelectDestination));
|
|
args.AddCustomItem(new GameObjectContextMenuItem("Add Bookmark", this.AddBookmark));
|
|
}
|
|
|
|
private void SelectDestination(GameObjectContextMenuItemSelectedArgs args) {
|
|
var contentId = args.ContentIdLower;
|
|
if (contentId is 0) {
|
|
return;
|
|
}
|
|
|
|
var contentIdLower = contentId & 0xFFFFFFFF;
|
|
|
|
var listing = this.Plugin.Common.Functions.PartyFinder.CurrentListings.Values.FirstOrDefault(listing => listing.ContentIdLower == contentIdLower);
|
|
if (listing == null) {
|
|
return;
|
|
}
|
|
|
|
this.ClearFlag();
|
|
this.Destination = InfoExtractor.Extract(listing.Description.TextValue, listing.World.Value.DataCenter.Row, this.Plugin.DataManager, this.Info);
|
|
}
|
|
|
|
private void AddBookmark(GameObjectContextMenuItemSelectedArgs args) {
|
|
var contentId = args.ContentIdLower;
|
|
if (contentId is 0) {
|
|
return;
|
|
}
|
|
|
|
var contentIdLower = contentId & 0xFFFFFFFF;
|
|
|
|
var listing = this.Plugin.Common.Functions.PartyFinder.CurrentListings.Values.FirstOrDefault(listing => listing.ContentIdLower == contentIdLower);
|
|
if (listing == null) {
|
|
return;
|
|
}
|
|
|
|
var dest = InfoExtractor.Extract(listing.Description.TextValue, listing.World.Value.DataCenter.Row, this.Plugin.DataManager, this.Info);
|
|
this.BookmarksUi.Editing = (new Bookmark(string.Empty) {
|
|
WorldId = dest.World?.RowId ?? 0,
|
|
Area = dest.Area ?? 0,
|
|
Ward = dest.Ward ?? 0,
|
|
Plot = dest.Plot ?? 0,
|
|
}, -1);
|
|
this.BookmarksUi.ShouldDraw = true;
|
|
}
|
|
|
|
private void OnFramework(Framework framework) {
|
|
this.ClearIfNear();
|
|
this.HighlightSelectString();
|
|
this.HighlightResidentialTeleport();
|
|
this.HighlightWorldTravel();
|
|
this.HighlightTeleportTown();
|
|
}
|
|
|
|
private void ClearIfNear() {
|
|
var destination = this.Destination;
|
|
if (destination == null || destination.AnyNull()) {
|
|
return;
|
|
}
|
|
|
|
var info = this.Plugin.DataManager.GetExcelSheet<HousingMapMarkerInfo>()!.GetRow((uint) destination.Area!.Value, (uint) destination.Plot! - 1);
|
|
if (info == null) {
|
|
return;
|
|
}
|
|
|
|
var player = this.Plugin.ClientState.LocalPlayer;
|
|
if (player == null) {
|
|
return;
|
|
}
|
|
|
|
// ensure on correct world
|
|
if (player.CurrentWorld.GameData != destination.World) {
|
|
return;
|
|
}
|
|
|
|
// ensure in correct zone
|
|
if (this.Plugin.ClientState.TerritoryType != (ushort) destination.Area) {
|
|
return;
|
|
}
|
|
|
|
var loc = this.Plugin.Common.Functions.Housing.Location;
|
|
|
|
// ensure in correct ward
|
|
if (loc?.Ward != destination.Ward) {
|
|
return;
|
|
}
|
|
|
|
// ensure either in the yard of the destination plot or actually inside the destination
|
|
if (loc?.Yard != destination.Plot && loc?.Plot != destination.Plot) {
|
|
return;
|
|
}
|
|
|
|
this._destination = null;
|
|
|
|
if (this.Config.ClearFlagOnApproach) {
|
|
this.ClearFlag();
|
|
}
|
|
|
|
if (this.Config.CloseMapOnApproach) {
|
|
this.CloseMap();
|
|
}
|
|
}
|
|
|
|
private void ClearFlagAndCloseMap() {
|
|
this.ClearFlag();
|
|
this.CloseMap();
|
|
}
|
|
|
|
private unsafe void ClearFlag() {
|
|
var mapAgent = (IntPtr) FFXIVClientStructs.FFXIV.Client.System.Framework.Framework.Instance()->GetUiModule()->GetAgentModule()->GetAgentByInternalId(AgentId.Map);
|
|
if (mapAgent != IntPtr.Zero) {
|
|
*(byte*) (mapAgent + AgentMapFlagSetOffset) = 0;
|
|
}
|
|
}
|
|
|
|
private void CloseMap() {
|
|
var addon = this.Plugin.GameGui.GetAddonByName("AreaMap", 1);
|
|
if (addon != IntPtr.Zero) {
|
|
this._addonMapHide?.Invoke(addon);
|
|
}
|
|
}
|
|
|
|
private void FlagDestinationOnMap() {
|
|
if (this.Destination?.Area == null || this.Destination?.Plot == null) {
|
|
return;
|
|
}
|
|
|
|
this.FlagHouseOnMap(this.Destination.Area.Value, this.Destination.Plot.Value);
|
|
}
|
|
|
|
internal void FlagHouseOnMap(HousingArea area, uint plot) {
|
|
var info = this.Plugin.DataManager.GetExcelSheet<HousingMapMarkerInfo>()!.GetRow((uint) area, plot - 1);
|
|
if (info == null) {
|
|
return;
|
|
}
|
|
|
|
var map = info.Map.Value;
|
|
var terr = map?.TerritoryType?.Value;
|
|
|
|
if (terr == null) {
|
|
return;
|
|
}
|
|
|
|
var mapLink = new MapLinkPayload(
|
|
terr.RowId,
|
|
map!.RowId,
|
|
(int) (info.X * 1_000f),
|
|
(int) (info.Z * 1_000f)
|
|
);
|
|
|
|
this.Plugin.GameGui.OpenMapWithMapLink(mapLink);
|
|
}
|
|
|
|
private unsafe void HighlightResidentialTeleport() {
|
|
var addon = this.Plugin.GameGui.GetAddonByName("HousingSelectBlock", 1);
|
|
if (addon == IntPtr.Zero) {
|
|
return;
|
|
}
|
|
|
|
var shouldSet = false;
|
|
|
|
var player = this.Plugin.ClientState.LocalPlayer;
|
|
if (player != null && this.Destination?.World != null) {
|
|
shouldSet = player.CurrentWorld.GameData == this.Destination.World;
|
|
}
|
|
|
|
if (this.Destination?.Area == null) {
|
|
shouldSet = false;
|
|
} else {
|
|
var currentArea = this.Plugin.ClientState.TerritoryType;
|
|
shouldSet = shouldSet && (currentArea == (ushort) this.Destination.Area || currentArea == this.Destination.Area.Value.CityStateTerritoryType());
|
|
}
|
|
|
|
var unit = (AtkUnitBase*) addon;
|
|
var uld = unit->UldManager;
|
|
if (uld.NodeListCount < 1) {
|
|
return;
|
|
}
|
|
|
|
var parentNode = uld.NodeList[0];
|
|
|
|
var siblingCount = 0;
|
|
var prev = parentNode->ChildNode;
|
|
while ((prev = prev->PrevSiblingNode) != null) {
|
|
siblingCount += 1;
|
|
if (siblingCount == 8) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
var radioContainer = prev;
|
|
var radioButton = radioContainer->ChildNode;
|
|
do {
|
|
var component = (AtkComponentNode*) radioButton;
|
|
var radioUld = component->Component->UldManager;
|
|
if (radioUld.NodeListCount < 4) {
|
|
return;
|
|
}
|
|
|
|
var textNode = (AtkTextNode*) radioUld.NodeList[3];
|
|
var text = Util.ReadSeString((IntPtr) textNode->NodeText.StringPtr);
|
|
HighlightIf(radioButton, shouldSet && text.TextValue == $"{this.Destination?.Ward}");
|
|
} while ((radioButton = radioButton->PrevSiblingNode) != null);
|
|
}
|
|
|
|
private unsafe void HighlightSelectString() {
|
|
var addon = this.Plugin.GameGui.GetAddonByName("SelectString", 1);
|
|
if (addon == IntPtr.Zero) {
|
|
return;
|
|
}
|
|
|
|
var select = (AddonSelectString*) addon;
|
|
var list = select->PopupMenu.PopupMenu.List;
|
|
if (list == null) {
|
|
return;
|
|
}
|
|
|
|
this.HighlightSelectStringItems(list);
|
|
}
|
|
|
|
private bool ShouldHighlight(SeString str) {
|
|
var text = str.TextValue;
|
|
|
|
var sameWorld = this.Destination?.World == this.Plugin.ClientState.LocalPlayer?.CurrentWorld.GameData;
|
|
if (!sameWorld && this.Destination?.World != null) {
|
|
return text == " Visit Another World Server.";
|
|
}
|
|
|
|
// ReSharper disable once InvertIf
|
|
if (this.Destination?.Ward != null && this.Plugin.ClientState.TerritoryType == this.Destination?.Area?.CityStateTerritoryType()) {
|
|
switch (text) {
|
|
case " Residential District Aethernet.":
|
|
case "Go to specified ward. (Review Tabs)":
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
private unsafe void HighlightSelectStringItems(AtkComponentList* list) {
|
|
for (var i = 0; i < list->ListLength; i++) {
|
|
var item = list->ItemRendererList + i;
|
|
var button = item->AtkComponentListItemRenderer->AtkComponentButton;
|
|
var buttonText = Util.ReadSeString((IntPtr) button.ButtonTextNode->NodeText.StringPtr);
|
|
|
|
var component = (AtkComponentBase*) item->AtkComponentListItemRenderer;
|
|
|
|
HighlightIf(&component->OwnerNode->AtkResNode, this.ShouldHighlight(buttonText));
|
|
}
|
|
}
|
|
|
|
private unsafe void HighlightTeleportTown() {
|
|
var player = this.Plugin.ClientState.LocalPlayer;
|
|
if (player == null) {
|
|
return;
|
|
}
|
|
|
|
var world = this.Destination?.World;
|
|
if (world?.RowId != player.CurrentWorld.Id) {
|
|
return;
|
|
}
|
|
|
|
var addon = this.Plugin.GameGui.GetAddonByName("TelepotTown", 1);
|
|
if (addon == IntPtr.Zero) {
|
|
return;
|
|
}
|
|
|
|
var unit = (AtkUnitBase*) addon;
|
|
var root = unit->RootNode;
|
|
if (root == null) {
|
|
return;
|
|
}
|
|
|
|
var windowNode = root->ChildNode;
|
|
var list = windowNode->PrevSiblingNode->PrevSiblingNode;
|
|
var treeNode = (AtkComponentNode*) list->ChildNode;
|
|
var collisionNode = treeNode->Component->UldManager.RootNode;
|
|
|
|
var child = collisionNode->PrevSiblingNode;
|
|
while (child != null) {
|
|
var component = (AtkComponentNode*) child;
|
|
if (child->Type != (NodeType) 1020 || component->Component->UldManager.NodeListSize != 7) {
|
|
goto End;
|
|
}
|
|
|
|
var childCollisionNode = component->Component->UldManager.RootNode;
|
|
var textNode = (AtkTextNode*) childCollisionNode->PrevSiblingNode->PrevSiblingNode->PrevSiblingNode;
|
|
var text = textNode->NodeText.ToString();
|
|
|
|
var placeName = this.Destination?.ClosestAethernet?.PlaceName?.Value?.Name?.ToString();
|
|
var currentWard = this.Plugin.Common.Functions.Housing.Location?.Ward;
|
|
|
|
HighlightIf(&textNode->AtkResNode, currentWard == this.Destination?.Ward && placeName != null && text == placeName);
|
|
|
|
End:
|
|
child = child->PrevSiblingNode;
|
|
}
|
|
}
|
|
|
|
private unsafe void HighlightWorldTravel() {
|
|
var player = this.Plugin.ClientState.LocalPlayer;
|
|
if (player == null) {
|
|
return;
|
|
}
|
|
|
|
var world = this.Destination?.World;
|
|
|
|
var addon = this.Plugin.GameGui.GetAddonByName("WorldTravelSelect", 1);
|
|
if (addon == IntPtr.Zero) {
|
|
return;
|
|
}
|
|
|
|
var unit = (AtkUnitBase*) addon;
|
|
var root = unit->RootNode;
|
|
if (root == null) {
|
|
return;
|
|
}
|
|
|
|
var windowComponent = (AtkComponentNode*) root->ChildNode;
|
|
var informationBox = (AtkComponentNode*) windowComponent->AtkResNode.PrevSiblingNode;
|
|
var informationBoxBorder = (AtkNineGridNode*) informationBox->AtkResNode.PrevSiblingNode;
|
|
var worldListComponent = (AtkComponentNode*) informationBoxBorder->AtkResNode.PrevSiblingNode;
|
|
var listChild = worldListComponent->Component->UldManager.RootNode;
|
|
|
|
var prev = listChild;
|
|
if (prev == null) {
|
|
return;
|
|
}
|
|
|
|
do {
|
|
if ((uint) prev->Type != 1010) {
|
|
continue;
|
|
}
|
|
|
|
var comp = (AtkComponentNode*) prev;
|
|
var res = comp->Component->UldManager.RootNode->PrevSiblingNode->PrevSiblingNode->PrevSiblingNode;
|
|
var text = (AtkTextNode*) res->ChildNode;
|
|
var str = Util.ReadSeString((IntPtr) text->NodeText.StringPtr);
|
|
HighlightIf(&text->AtkResNode, str.TextValue == world?.Name?.ToString());
|
|
} while ((prev = prev->PrevSiblingNode) != null);
|
|
}
|
|
|
|
private static unsafe void HighlightIf(AtkResNode* node, bool cond) {
|
|
if (cond) {
|
|
node->MultiplyRed = 0;
|
|
node->MultiplyGreen = 100;
|
|
node->MultiplyBlue = 0;
|
|
} else {
|
|
node->MultiplyRed = 100;
|
|
node->MultiplyGreen = 100;
|
|
node->MultiplyBlue = 100;
|
|
}
|
|
}
|
|
}
|
|
}
|