Interface PlexPlayerView

public interface PlexPlayerView
Read-only view of a Plex player.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    frozen()
    Returns whether the player is currently frozen.
    List<String>
    ips()
    Returns known IP addresses.
    boolean
    lockedUp()
    Returns whether the player is currently locked up.
    boolean
    muted()
    Returns whether the player is currently muted.
    String
    name()
    Returns the current or last known player name.
    List<PunishmentView>
    punishments()
    Returns the player's punishment history.
    boolean
    staffChat()
    Returns whether the player currently has staff-chat mode enabled.
    net.kyori.adventure.text.Component
    tag()
    Returns the saved custom tag using Plex's visual formatting rules.
    UUID
    uuid()
    Returns the player's UUID.

  • Method Details

    • uuid

      UUID uuid()
      Returns the player's UUID.
      Returns:
      player UUID

    • name

      String name()
      Returns the current or last known player name.
      Returns:
      current or last known player name

    • tag

      net.kyori.adventure.text.Component tag()
      Returns the saved custom tag using Plex's visual formatting rules. Does not include a rank prefix or additive PlayerPrefixEvent prefixes.
      Returns:
      custom tag, or an empty component when none is set

    • ips

      List<String> ips()
      Returns known IP addresses.
      Returns:
      immutable copy of known IP addresses

    • punishments

      List<PunishmentView> punishments()
      Returns the player's punishment history.
      Returns:
      punishment history for the player

    • frozen

      boolean frozen()
      Returns whether the player is currently frozen.
      Returns:
      whether the player is currently frozen

    • muted

      boolean muted()
      Returns whether the player is currently muted.
      Returns:
      whether the player is currently muted

    • lockedUp

      boolean lockedUp()
      Returns whether the player is currently locked up.
      Returns:
      whether the player is currently locked up

    • staffChat

      boolean staffChat()
      Returns whether the player currently has staff-chat mode enabled.

      When enabled, the player's normal chat input is routed to Plex staff chat and exposed through StaffChatMessageEvent.

      Returns:
      whether staff-chat mode is enabled