anna
/
RoleplayersToolbox
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feat(housing): add bookmarks

This commit is contained in:
Anna 2021-06-27 18:56:44 -04:00
parent cb151cad29
commit ee62e50390
5 changed files with 258 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
RoleplayersToolbox/Tools/Housing/Bookmark.cs Executable file
View File

@ -0,0 +1,25 @@
using System;
namespace RoleplayersToolbox.Tools.Housing {
[Serializable]
internal class Bookmark {
public string Name;
public uint WorldId;
public HousingArea Area;
public uint Ward;
public uint Plot;
public Bookmark(string name) {
this.Name = name;
}
internal Bookmark Clone() {
return new(this.Name) {
WorldId = this.WorldId,
Area = this.Area,
Ward = this.Ward,
Plot = this.Plot,
};
}
}
}

180
RoleplayersToolbox/Tools/Housing/BookmarksUi.cs Executable file
View File

@ -0,0 +1,180 @@
using System;
using System.Numerics;
using Dalamud.Interface;
using ImGuiNET;
using Lumina.Excel.GeneratedSheets;
namespace RoleplayersToolbox.Tools.Housing {
internal class BookmarksUi {
private Plugin Plugin { get; }
private HousingTool Tool { get; }
private HousingConfig Config { get; }
private (Bookmark editing, int index)? _editing;
internal bool ShouldDraw;
internal BookmarksUi(Plugin plugin, HousingTool tool, HousingConfig config) {
this.Plugin = plugin;
this.Tool = tool;
this.Config = config;
}
internal void Draw() {
if (!this.ShouldDraw) {
return;
}
this.AddEditWindow();
if (!ImGui.Begin("Housing Bookmarks", ref this.ShouldDraw)) {
ImGui.End();
return;
}
if (Util.IconButton(FontAwesomeIcon.Plus)) {
this._editing = (new Bookmark(string.Empty), -1);
}
var toDelete = -1;
if (ImGui.BeginChild("bookmark-list", new Vector2(-1, -1))) {
for (var i = 0; i < this.Config.Bookmarks.Count; i++) {
var bookmark = this.Config.Bookmarks[i];
var hash = bookmark.GetHashCode().ToString();
if (ImGui.TreeNode($"{bookmark.Name}##{hash}")) {
var worldName = this.Plugin.Interface.Data.GetExcelSheet<World>().GetRow(bookmark.WorldId)?.Name;
ImGui.TextUnformatted($"{worldName}/{bookmark.Area.Name()}/W{bookmark.Ward}/P{bookmark.Plot}");
if (Util.IconButton(FontAwesomeIcon.MapMarkerAlt, hash)) {
this.Tool.FlagHouseOnMap(bookmark.Area, bookmark.Plot);
}
Util.Tooltip("Show on map");
ImGui.SameLine();
if (Util.IconButton(FontAwesomeIcon.Route, hash)) {
this.Tool.Destination = new DestinationInfo(
this.Tool.Info,
this.Plugin.Interface.Data.GetExcelSheet<World>().GetRow(bookmark.WorldId),
bookmark.Area,
bookmark.Ward,
bookmark.Plot
);
}
Util.Tooltip("Open routing window");
ImGui.SameLine();
if (Util.IconButton(FontAwesomeIcon.PencilAlt, hash)) {
this._editing = (bookmark.Clone(), i);
}
Util.Tooltip("Edit");
ImGui.SameLine();
if (Util.IconButton(FontAwesomeIcon.Trash, hash)) {
toDelete = i;
}
Util.Tooltip("Delete");
ImGui.TreePop();
}
ImGui.Separator();
}
ImGui.EndChild();
}
if (toDelete > -1) {
this.Config.Bookmarks.RemoveAt(toDelete);
this.Plugin.SaveConfig();
}
ImGui.End();
}
private void AddEditWindow() {
if (this._editing == null) {
return;
}
if (!ImGui.Begin("Edit bookmark", ImGuiWindowFlags.AlwaysAutoResize)) {
ImGui.End();
return;
}
var (bookmark, index) = this._editing.Value;
ImGui.InputText("Name", ref bookmark.Name, 255);
var world = bookmark.WorldId == 0
? null
: this.Plugin.Interface.Data.GetExcelSheet<World>().GetRow(bookmark.WorldId);
if (ImGui.BeginCombo("World", world?.Name?.ToString() ?? string.Empty)) {
var dataCentre = this.Plugin.Interface.ClientState.LocalPlayer?.HomeWorld?.GameData?.DataCenter?.Row;
foreach (var availWorld in this.Plugin.Interface.Data.GetExcelSheet<World>()) {
if (availWorld.DataCenter.Row != dataCentre || !availWorld.IsPublic) {
continue;
}
if (!ImGui.Selectable(availWorld.Name.ToString())) {
continue;
}
bookmark.WorldId = availWorld.RowId;
}
ImGui.EndCombo();
}
var area = bookmark.Area;
if (ImGui.BeginCombo("Housing area", area != 0 ? area.Name() : string.Empty)) {
foreach (var housingArea in (HousingArea[]) Enum.GetValues(typeof(HousingArea))) {
if (!ImGui.Selectable(housingArea.Name(), area == housingArea)) {
continue;
}
bookmark.Area = housingArea;
}
ImGui.EndCombo();
}
var ward = (int) bookmark.Ward;
if (ImGui.InputInt("Ward", ref ward)) {
bookmark.Ward = (uint) Math.Max(1, Math.Min(24, ward));
}
var plot = (int) bookmark.Plot;
if (ImGui.InputInt("Plot", ref plot)) {
bookmark.Plot = (uint) Math.Max(1, Math.Min(60, plot));
}
if (ImGui.Button("Save")) {
if (index < 0) {
this.Config.Bookmarks.Add(bookmark);
} else if (index < this.Config.Bookmarks.Count) {
this.Config.Bookmarks[index] = bookmark;
}
this.Plugin.SaveConfig();
this._editing = null;
}
ImGui.SameLine();
if (ImGui.Button("Cancel")) {
this._editing = null;
}
ImGui.End();
}
}
}

2
RoleplayersToolbox/Tools/Housing/HousingConfig.cs
View File

@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using RoleplayersToolbox.Tools.Housing;
namespace RoleplayersToolbox.Tools {
@ -13,5 +14,6 @@ namespace RoleplayersToolbox.Tools.Housing {
public bool PlaceFlagOnSelect = true;
public bool CloseMapOnApproach = true;
public bool ClearFlagOnApproach = true;
public List<Bookmark> Bookmarks = new();
}
}

32
RoleplayersToolbox/Tools/Housing/HousingTool.cs
View File

@ -31,12 +31,13 @@ namespace RoleplayersToolbox.Tools.Housing {
public override string Name => "Housing";
private Plugin Plugin { get; }
private HousingConfig Config { get; }
private HousingInfo Info { get; }
internal HousingInfo Info { get; }
private BookmarksUi BookmarksUi { get; }
private Teleport Teleport { get; }
private DestinationInfo? _destination;
private DestinationInfo? Destination {
internal DestinationInfo? Destination {
get => this._destination;
set {
this._destination = value;
@ -69,6 +70,7 @@ namespace RoleplayersToolbox.Tools.Housing {
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);
if (this.Plugin.Interface.TargetModuleScanner.TryScanText(Signatures.AddonMapHide, out var addonMapHidePtr)) {
@ -79,12 +81,16 @@ namespace RoleplayersToolbox.Tools.Housing {
this.Plugin.Common.Functions.ContextMenu.OpenContextMenu += this.OnContextMenu;
this.Plugin.Interface.Framework.OnUpdateEvent += this.OnFramework;
this.Plugin.Interface.CommandManager.AddHandler("/route", new CommandInfo(this.OnCommand) {
this.Plugin.Interface.CommandManager.AddHandler("/route", new CommandInfo(this.OnRouteCommand) {
HelpMessage = "Extract housing information from the given text and open the routing window",
});
this.Plugin.Interface.CommandManager.AddHandler("/bookmarks", new CommandInfo(this.OnBookmarksCommand) {
HelpMessage = "Toggles the housing bookmarks window",
});
}
public void Dispose() {
this.Plugin.Interface.CommandManager.RemoveHandler("/bookmarks");
this.Plugin.Interface.CommandManager.RemoveHandler("/route");
this.Plugin.Interface.Framework.OnUpdateEvent -= this.OnFramework;
this.Plugin.Common.Functions.ContextMenu.OpenContextMenu -= this.OnContextMenu;
@ -103,9 +109,19 @@ namespace RoleplayersToolbox.Tools.Housing {
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;
}
@ -155,7 +171,7 @@ namespace RoleplayersToolbox.Tools.Housing {
var ward = (int) (this.Destination.Ward ?? 0);
if (ImGui.InputInt("Ward", ref ward)) {
this.Destination.Ward = (uint) Math.Max(1, Math.Min(60, ward));
this.Destination.Ward = (uint) Math.Max(1, Math.Min(24, ward));
anyChanged = true;
}
@ -190,7 +206,7 @@ namespace RoleplayersToolbox.Tools.Housing {
ImGui.End();
}
private void OnCommand(string command, string arguments) {
private void OnRouteCommand(string command, string arguments) {
var player = this.Plugin.Interface.ClientState.LocalPlayer;
if (player == null) {
return;
@ -199,6 +215,10 @@ namespace RoleplayersToolbox.Tools.Housing {
this.Destination = InfoExtractor.Extract(arguments, player.HomeWorld.GameData.DataCenter.Row, this.Plugin.Interface.Data, this.Info);
}
private void OnBookmarksCommand(string command, string arguments) {
this.BookmarksUi.ShouldDraw ^= true;
}
private void OnContextMenu(ContextMenuOpenArgs args) {
if (args.ParentAddonName != "LookingForGroup" || args.ContentIdLower == 0) {
return;
@ -301,7 +321,7 @@ namespace RoleplayersToolbox.Tools.Housing {
this.FlagHouseOnMap(this.Destination.Area.Value, this.Destination.Plot.Value);
}
private void FlagHouseOnMap(HousingArea area, uint plot) {
internal void FlagHouseOnMap(HousingArea area, uint plot) {
var info = this.Plugin.Interface.Data.GetExcelSheet<HousingMapMarkerInfo>().GetRow((uint) area, plot - 1);
if (info == null) {
return;

25
RoleplayersToolbox/Util.cs
View File

@ -5,6 +5,8 @@ using System.Runtime.InteropServices;
using System.Text;
using Dalamud.Game;
using Dalamud.Game.Text.SeStringHandling;
using Dalamud.Interface;
using ImGuiNET;
namespace RoleplayersToolbox {
internal static class Util {
@ -76,5 +78,28 @@ namespace RoleplayersToolbox {
return start;
}
internal static bool IconButton(FontAwesomeIcon icon, string? id = null) {
var label = icon.ToIconString();
if (id != null) {
label += $"##{id}";
}
ImGui.PushFont(UiBuilder.IconFont);
var ret = ImGui.Button(label);
ImGui.PopFont();
return ret;
}
internal static void Tooltip(string tooltip) {
if (!ImGui.IsItemHovered()) {
return;
}
ImGui.BeginTooltip();
ImGui.TextUnformatted(tooltip);
ImGui.EndTooltip();
}
}
}