Package com.sk89q.worldedit.internal.cui

Interface CUIRegion

All Known Implementing Classes:
ConvexPolyhedralRegionSelector, CuboidRegionSelector, CylinderRegionSelector, EllipsoidRegionSelector, ExtendingCuboidRegionSelector, Polygonal2DRegionSelector, PolyhedralRegionSelector, SphereRegionSelector
public interface CUIRegion

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    describeCUI(LocalSession session, Actor player)
    Sends CUI events describing the region for versions of CUI equal to or greater than the value supplied by getProtocolVersion().
    void
    describeLegacyCUI(LocalSession session, Actor player)
    Sends CUI events describing the region for versions of CUI smaller than the value supplied by getProtocolVersion().
    String
    getLegacyTypeID()
    Returns the type ID to send to CUI in the selection event if the CUI is in legacy mode.
    int
    getProtocolVersion()
    Returns the CUI version that is required to send up-to-date data.
    String
    getTypeID()
    Returns the type ID to send to CUI in the selection event.

  • Method Details

    • describeCUI

      void describeCUI(LocalSession session, Actor player)
      Sends CUI events describing the region for versions of CUI equal to or greater than the value supplied by getProtocolVersion().

    • describeLegacyCUI

      void describeLegacyCUI(LocalSession session, Actor player)
      Sends CUI events describing the region for versions of CUI smaller than the value supplied by getProtocolVersion().

    • getProtocolVersion

      int getProtocolVersion()
      Returns the CUI version that is required to send up-to-date data. If the CUI version is smaller than this value, the legacy methods will be called.
      Returns:
      the protocol version

    • getTypeID

      String getTypeID()
      Returns the type ID to send to CUI in the selection event.
      Returns:
      the type ID

    • getLegacyTypeID

      String getLegacyTypeID()
      Returns the type ID to send to CUI in the selection event if the CUI is in legacy mode.
      Returns:
      the legacy type ID