https://github.com/kalilistic/dalamud.contextmenu
dalamud context menus
https://github.com/kalilistic/dalamud.contextmenu
dalamud dalamud-plugin ffxiv
Last synced: 4 months ago
JSON representation
dalamud context menus
- Host: GitHub
- URL: https://github.com/kalilistic/dalamud.contextmenu
- Owner: kalilistic
- License: mit
- Created: 2022-05-31T19:02:23.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-24T13:47:37.000Z (about 1 year ago)
- Last Synced: 2024-02-24T14:39:33.569Z (about 1 year ago)
- Topics: dalamud, dalamud-plugin, ffxiv
- Language: C#
- Homepage:
- Size: 226 KB
- Stars: 5
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# THIS IS DEPRECATED AND WILL NOT BE UPDATED FOR 7.0.
# Dalamud.ContextMenu
[](https://www.nuget.org/packages/Dalamud.ContextMenu/)
This is a library to add context menus to dalamud plugins.
### Features
- Add context menu items to game objects (e.g. players).
- Add context menu items to inventory items.
- Add an dalamud indicator icon so players know a plugin is adding the menu item (optional).
### Limitations
- No sub menus.
- No random inserts - all custom items are added to the end of the menu.
### Credits
- The logic is all copied from a deprecated version of annaclemens' XIVCommon library.
### How to Use
- Import from nuget.
- Add ```true``` in your csproj file.
### Example
```csharp
// create instance
DalamudContextMenu contextMenu = new DalamudContextMenu(PluginInterface);
// create context menu item
GameObjectContextMenuItem contextMenuItem = new GameObjectContextMenuItem(
new SeString(new TextPayload("My Menu Item"), // text
MyMenuItemAction, // action to invoke
true); // use dalamud indicator
// add event handler
contextMenu.OnOpenGameObjectContextMenu += OpenGameObjectContextMenu;
// add custom item on game object menu open
private void OpenGameObjectContextMenu(GameObjectContextMenuOpenArgs args)
{
args.AddCustomItem(contextMenuItem);
}
// add action method when custom item is clicked
private void MyMenuItemAction(GameObjectContextMenuItemSelectedArgs args)
{
// do something
}
// dispose
contextMenu.OnOpenGameObjectContextMenu -= OpenGameObjectContextMenu;
contextMenu.Dispose();
```