Fix documentation for addClientSideModDependency and add new modIsInstalled function with more sensible naming and semantics
#51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RDIL
reviewed
Dec 3, 2022
RDIL
added a commit
that referenced
this pull request
Dec 3, 2022
…Installed` function with more sensible naming and semantics (#51) * Fix documentation and add new function Signed-off-by: atampy25 <24306974+atampy25@users.noreply.github.com> Co-authored-by: Reece Dunham <me@rdil.rocks>
scrungofan
pushed a commit
to scrungofan/Peacock
that referenced
this pull request
Dec 6, 2022
…Installed` function with more sensible naming and semantics (thepeacockproject#51) * Fix documentation and add new function Signed-off-by: atampy25 <24306974+atampy25@users.noreply.github.com> Co-authored-by: Reece Dunham <me@rdil.rocks>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
addClientSideModDependencyfunction used to do what it says; it would check if the mod was installed and abort the plugin loading if it wasn't. At some point, the semantics changed to supposedly "returning whether the mod is available", but even that has been broken for a long time, as it actually returns whether the mod is UNavailable. This has had a knock-on effect to theoverrideFrameworkChecksflag, which is meant to make it so that checks always succeed; however, because a check succeeding means returning false in this broken function, the flag being set actually makes all plugins with mod dependencies abort initialisation.This PR deprecates the old function and updates its documentation to describe the actual behaviour of the function. It also introduces a new function with a more sensible name that describes its more sensible semantics.