Package sawfowl.regionguard.api.worldedit

Interface CUIUser

All Known Implementing Classes:
CUIUserImpl
public interface CUIUser

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispatchCUIEvent(CUIEvent event)
    Activate the event of displaying the selection boundaries.
    Region
    getClaimResizing()
    Getting a region that is resized.
    Cuboid
    getDragCuboid()
    Getting a cuboid of dynamic selection.
    long
    getLastTimeSendBorders()
    Getting the time when the player was shown the boundaries
    org.spongepowered.math.vector.Vector3i
    getLastWandLocation()
    Getting the last position that was selected by the wand tool.
    Optional<org.spongepowered.api.entity.living.player.server.ServerPlayer>
    getPlayer()
    Getting player
    UUID
    getVisualClaimId()
    Getting the UUID of the region whose borders were shown to the player.
    void
    handleCUIInitializationMessage(String text)
    You don't have to use that.
    boolean
    isDrag()
    Checking whether the player is using dynamic selection.
    boolean
    isSupportCUI()
    Checking if the player will be sent packets to display the boundaries by the WECui mod.
    void
    setClaimResizing(Region claimResizing)
    Specifies the region that will be resized.
    void
    setDrag(boolean isDrag)
    Setting the status of the dynamic selection.
    void
    setDragCuboid(Cuboid dragCuboid)
    Setting cuboid for dynamic selection.
    void
    setLastTimeSendBorders(long lastTimeSendBorders)
    Setting the last time of the boundaries display
    void
    setLastWandLocation(org.spongepowered.math.vector.Vector3i lastWandLocation)
    Getting the last position that was selected by the wand tool.
    void
    setSupportCUI(boolean cuiSupport)
    If sets this to false, the player will not receive packets for display the boundaries by the WECui mod.
    void
    setVisualClaimId(UUID visualClaimId)
    Setting the UUID of the region, the boundaries of which will be shown to the player.

  • Method Details

    • dispatchCUIEvent

      void dispatchCUIEvent(CUIEvent event)
      Activate the event of displaying the selection boundaries.

    • getPlayer

      Optional<org.spongepowered.api.entity.living.player.server.ServerPlayer> getPlayer()
      Getting player

    • getLastTimeSendBorders

      long getLastTimeSendBorders()
      Getting the time when the player was shown the boundaries

    • setLastTimeSendBorders

      void setLastTimeSendBorders(long lastTimeSendBorders)
      Setting the last time of the boundaries display

    • isDrag

      boolean isDrag()
      Checking whether the player is using dynamic selection.

    • setDrag

      void setDrag(boolean isDrag)
      Setting the status of the dynamic selection.

    • getDragCuboid

      Cuboid getDragCuboid()
      Getting a cuboid of dynamic selection.

    • setDragCuboid

      void setDragCuboid(Cuboid dragCuboid)
      Setting cuboid for dynamic selection.

    • getClaimResizing

      Region getClaimResizing()
      Getting a region that is resized. It can be zero.
      Returns:
      Region or null

    • setClaimResizing

      void setClaimResizing(Region claimResizing)
      Specifies the region that will be resized.

    • getLastWandLocation

      org.spongepowered.math.vector.Vector3i getLastWandLocation()
      Getting the last position that was selected by the wand tool.
      Returns:
      Vector3i

    • setLastWandLocation

      void setLastWandLocation(org.spongepowered.math.vector.Vector3i lastWandLocation)
      Getting the last position that was selected by the wand tool.
      Parameters:
      lastWandLocation - - Vector3i

    • getVisualClaimId

      UUID getVisualClaimId()
      Getting the UUID of the region whose borders were shown to the player.
      Returns:
      - UUID

    • setVisualClaimId

      void setVisualClaimId(UUID visualClaimId)
      Setting the UUID of the region, the boundaries of which will be shown to the player.
      Parameters:
      visualClaimId - - UUID

    • isSupportCUI

      boolean isSupportCUI()
      Checking if the player will be sent packets to display the boundaries by the WECui mod.

    • setSupportCUI

      void setSupportCUI(boolean cuiSupport)
      If sets this to false, the player will not receive packets for display the boundaries by the WECui mod. If a player has the right to see boundaries, when the player logs into the server, plugin will attempt to verify that the player has the WECui mod.

    • handleCUIInitializationMessage

      void handleCUIInitializationMessage(String text)
      You don't have to use that.