Skip to main content
SentrySettings exposes a powerful API that allows external plugins to check if a player has a specific setting enabled, or even inject completely custom toggles directly into the /settings menu!

Getting the API Instance

You can access the SentrySettingsAPI by grabbing the main plugin instance.

Reading Player Preferences

If your custom plugin sends chat messages or plays sounds, you should check the player’s SentrySettings preferences first to ensure they haven’t muted them!

Method: getSetting

UUID
required
The target player’s unique Minecraft UUID.
String
required
The key identifying the setting (e.g. actionbar-alerts, private-messages, crystal-pvp-optimizer).
boolean
default:"true"
Fallback boolean returned if the player has not yet customized this preference.
boolean
Returns true if the setting is active for this player, false otherwise.

Registering Custom GUI Toggles

You can inject your own custom toggles into the SentrySettings GUI. These toggles will automatically be saved to the database (H2/MySQL) just like native settings! To do this, you implement the CustomSetting interface.
Registering it with the API:
Last modified on October 24, 2026