API

To access API of our plugin, you should add it as dependency. For now you can do it only as local dependency. We'll show how to do it on Maven.

Access to API

1. Open your project on any IDE (for example, IntelliJ IDEA by JetBrains)

2. Go to terminal page(Alt+F12 for Windows/Linux or ⌥(Option)+F12 for MacOS) and run following:

mvn install:install-file -Dfile="pathToDiscordWhitelistJarFile.jar" -DgroupId="com.windstudio" -DartifactId="DiscordWhiteList" -Dversion="VERSION" -Dpackaging=jar -DgeneratePom=true

For example:

mvn install:install-file -Dfile="C:/DiscordWhiteList-24.3.jar" -DgroupId="com.windstudio" -DartifactId="DiscordWhiteList" -Dversion="24.3" -Dpackaging=jar -DgeneratePom=true

3. When build succeed, you can now use our plugin as dependency:

      <dependency>
          <groupId>com.windstudio</groupId>
          <artifactId>DiscordWhiteList</artifactId>
          <version>VERSION</version>
          <scope>system</scope>
          <systemPath>pathToDiscordWhitelistJarFile.jar</systemPath>
      </dependency>

Plugin Events

Event	Description	Returns
UserWhitelistWelcomeMessageSentEvent	Called when Welcome Message send after user was whitelisted	GlobalChannel, WhitelistChannel, Member, Nickname
UserWhitelistedEvent	Called when user was whitelisted	Channel, Nickname, Member, Player
UserUnWhitelistedEvent	Called when user was un-whitelisted	Channel, Nickname, Member, Player
UserRoleRemoveEvent	Called when role from user was removed	Nickname, Member, Channel, Role
UserRoleAddEvent	Called when role was added to user	Nickname, Member, Channel, Role
UserNicknameReceivedEvent	Called when bot received nickname from user	Nickname, Member, Channel
UserNicknameChangedEvent	Called when plugin changes user's nickname	NewNickname, OldNickname, Member, Channel
UserDirectMessageSendEvent	Called when plugin send DM to user	Nickname, User, Channel
SlashCommandUsedEvent	Called when somebody used plugin's SlashCommand	Member, CommandName, CommandID
PluginStartupEvent	Called when plugin loaded	Plugin instance
PlayerQuitEvent	Called when player quit the server	Player
PlayerJoinEvent	Called when player join the server	Player
PlayerNotWhiteistedKickedEvent	Called when user got kicked (with EWHITELIST) if he not whitelisted	Player, Cause(NOT_WHITELISTED)
PlayerMaintenanceKickedEvent	Called when user got kicked (with EWHITELIST) if server is on service	Player, Cause(MAINTENANCE)
PlayerBlacklistedKickedEvent	Called when user got kicked (with EWHITELIST) if he blacklisted	Player, Cause(BLACKLISTED)
NicknameConfirmationMenuSendEvent	Called when confirmation menu to confirm nickname correctness send	Nickname, Member, Channel, Player
LogsSendEvent	Called when logs message was send	AdminChannel, Cause(WHITELIST, LINK, CHECK)
InGameCommandUsedEvent	Called when command of plugin was used in-game	CommandName, Command, Sender
ErrorReceivedEvent	Called when plugin send almost all error messages	Nickname, Member, Channel, ErrorCause
DiscordLeftEvent	Called when somebody left from Discord server and plugin detected this	Nickname, User (in future will be improved)
ChannelWhitelistAttemptEvent	Called when plugin detected a whitelist attemp	Nickname, Member, Channel
BotPresenceEvent	Called when plugin forced bot to change his presence	ReadyEvent, SelfUser(Bot)