Developer API

Add the API to your project

The current API version is: 2.0.0

pom.xml
<repositories>
    <repository>
    <id>hypera-releases</id>
    <url>https://repo.hypera.dev/releases/</url>
  </repository>
</repositories>

<dependencies>
    <dependency>
    <groupId>dev.hypera</groupId>
    <artifactId>UltraStaffChatPro-API</artifactId>
    <version>[VERSION]</version>
  </dependency>
</dependencies>

Using the API

Make sure to add UltraStaffChatPro as a dependency in your plugin.yml file.

Note: The velocity plugin id is ultrastaffchatpro.

public class MyPlugin extends JavaPlugin {

	@Override
	public void onEnable() {
		// Register the plugin
		APIPlugin plugin = UltraStaffChatProAPI.getInstance()
				.registerPlugin("MyPlugin", "0.1.0-SNAPSHOT", "Me, Myself and I");

		// Register a listener
		UltraStaffChatProAPI.getInstance().registerListener(plugin, new MyListener());
	}

}
public class MyListener implements UltraStaffChatProListener {

	@USCPEventHandler
	public void onMessage(UltraStaffChatProMessageEvent event) {
		// Do something with the message
	}
	
	@USCPEventHandler
	public void onJoinMessage(UltraStaffChatProJoinMessageEvent event) {
		if (event.getUser().getName().equalsIgnoreCase("Steve")) {
			event.setCancelled(true);
		}
	}
// Send a message
UltraStaffChatProAPI.getInstance().getMessageManager().sendMessage(MessageBuilder.create(UserBuilder.create("Steve", UUID.randomUUID()).build(), "Hi, my name is Steve.").build());

// Toggle global mute in StaffChat
UltraStaffChatProAPI.getInstance().getStateManager().toggleGlobalMute(null);

Last updated