Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update IPC docs for recent changes #276

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[Docs] Update IPC docs for recent changes #276

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d27c49
Fix broken link
zbee Jan 6, 2025
0dc2497
Note most recent direct changes
zbee Jan 6, 2025
b3935e7
Update method signatures
zbee Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/IPC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,7 @@ enabled. There will still be error logs about it though.
### IPC Methods

The Provider files ([main](https://github.com/PunishXIV/WrathCombo/blob/main/WrathCombo/Services/IPC/Provider.cs),
[auto-rot settings](https://github.
com/PunishXIV/WrathCombo/blob/main/WrathCombo/Services/IPC/ProvideAutoRotConfig.cs))
[auto-rot settings](https://github.com/PunishXIV/WrathCombo/blob/main/WrathCombo/Services/IPC/ProvideAutoRotConfig.cs))
are the real documentation on all IPC methods, and have verbose doc comments,
this here will only serve to document via the verbose method names and brief
comments on each method.
Expand Down Expand Up @@ -207,9 +206,9 @@ comments on each method.
plugin
- Only whether a Single-Target and Multi-Target combo are enabled in Auto-Mode,
NOT whether they are turned on
- `List? GetComboNamesForJob(string)`
- `List? GetComboNamesForJob(uint)`
- Gets the names of all the combos for a job
- `Dictionary? GetComboOptionNamesForJob(string)`
- `Dictionary? GetComboOptionNamesForJob(uint)`
- Gets the names of all the options for a job
- `Dictionary? GetComboState(string)`
- Gets the state and Auto-Mode state of a combo, whether by the user or another
Expand Down Expand Up @@ -413,6 +412,10 @@ resources below, or the first several sections of this guide.

## Changelog

- PunishXIV/WrathCombo@3ef3109 - Methods with specific job parameters are now `uint`,
`1.0.0.9`.
- PunishXIV/WrathCombo@5699d7b - Auto-Rotation Configurations enums are no longer a
subset of the full options, `1.0.0.9`.
- PunishXIV/WrathCombo@0d8faa7 - Added `IncludeNPCs` healer option to the
`AutoRotationConfigOption`
enum, `1.0.0.8`.
Expand Down