Skip to content

Feature - Private Mod Status API - #312

Open
ItsNature wants to merge 1 commit into
feature/totem-counter-modulefrom
improvement/paginated-mod-status
Open

ItsNature wants to merge 1 commit into
feature/totem-counter-modulefrom
improvement/paginated-mod-status

Conversation

@ItsNature

@ItsNature ItsNature commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator

Overview

Description:
Make the Mod Status API of the Mod Setting module a private feature, like the private Cosmetic module, and make it request based like installed mods.

Changes:

  • Add ModSettingModule#requestModStatus(ApolloPlayer) returning Future<ModStatusResponse>
    • ModStatusResponse is paginated; its elements are ModOptionStatus (option, value) for every option
  • Add @RestrictedAccess: documented marker
    • Marks CosmeticModule, ModSettingModule#getStatus, requestModStatus, the new request/response types and ApolloUpdateModOptionEvent

Code Example (If applicable):

this.modSettingModule.requestModStatus(apolloPlayer)
    .onSuccess(response -> {
        boolean waypointsEnabled = this.modSettingModule.getStatus(apolloPlayer, ModWaypoints.ENABLED);
    });

Related Issue (If applicable):

Screenshots and/or Videos (If applicable):


Review Request Checklist

  • Your code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have tested this change myself. (If applicable)
  • I have made corresponding changes to the documentation. (If applicable)
  • The branch name follows the projects naming conventions. (e.g. feature/add-module & bugfix/fix-issue)

@ItsNature ItsNature added type: Documentation Documentation improvement or issue type: Enhancement Feature improvement or addition labels Sep 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: Documentation Documentation improvement or issue type: Enhancement Feature improvement or addition

Development

Successfully merging this pull request may close these issues.

2 participants