CompanionClient

All Known Subinterfaces:: InGameSocialUser, SocialUser

All Known Implementing Classes:: AbstractSocialUser, BukkitSocialUser, ConsoleSocialUser

public interface CompanionClient

Method Summary

Modifier and Type

Method

Description

@NotNull Optional<SocialUserCompanion>

companion()

Gets the optional SocialUserCompanion instance of this user.

<T extends NetworkPayloadWrapper.ServerToClient> void

sendCustomPayload(@NotNull S2CNetworkChannelWrapper<T> channel, T payload)

Sends a custom payload to this user.

Method Details
- companion
  
  @NotNull @NotNull Optional<SocialUserCompanion> companion()
  
  Gets the optional SocialUserCompanion instance of this user.
  
  Returns:
  
  an Optional containing the SocialUserCompanion instance of this user, or an empty Optional otherwise
- sendCustomPayload
  
  <T extends NetworkPayloadWrapper.ServerToClient> void sendCustomPayload(@NotNull @NotNull S2CNetworkChannelWrapper<T> channel, @NotNull T payload)
  
  Sends a custom payload to this user.
  
  Type Parameters:
  
  T - the NetworkPayloadWrapper.ServerToClient implementation to send
  
  Parameters:
  
  channel - the S2CNetworkChannelWrapper where the payload should be sent
  
  payload - the payload that should be sent