Package net.draycia.carbon.api
Interface CarbonChat
@DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class)
public interface CarbonChat
The
CarbonChat interface is the gateway to interacting with the majority of the CarbonChat API.
Instances may be obtained through CarbonChatProvider.carbonChat() once Carbon is loaded.
On most platforms, you should use the provided load order mechanism to ensure your addon loads after Carbon.
On Fabric, use the carbonchat entrypoint (type: Consumer<CarbonChat>) to have a callback
when Carbon is loaded.
- Since:
- 1.0.0
-
Method Summary
Modifier and TypeMethodDescriptionThe registry that channels are registered to.Theevent handler, used for listening to and emittingevents.server()The server that carbon is running on.UserManager<?> The user manager.
-
Method Details
-
eventHandler
CarbonEventHandler eventHandler()Theevent handler, used for listening to and emittingevents.- Returns:
- the event handler
- Since:
- 2.0.0
-
server
CarbonServer server()The server that carbon is running on.- Returns:
- the server
- Since:
- 2.0.0
-
userManager
UserManager<?> userManager()The user manager.- Returns:
- the user manager
- Since:
- 3.0.0
-
channelRegistry
ChannelRegistry channelRegistry()The registry that channels are registered to.- Returns:
- the channel registry
- Since:
- 2.0.0
-