Package sawfowl.regionguard.api.worldedit

Interface WorldEditCUIAPI

All Known Implementing Classes:
WorldEditAPI
public interface WorldEditCUIAPI

  • Method Summary

    Modifier and Type
    Method
    Description
    CUIUser
    getOrCreateUser(UUID uuid)
    Creating or getting a WECui user.
    CUIUser
    getOrCreateUser(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Creating or getting a WECui user.
    Optional<org.spongepowered.api.world.server.ServerLocation>
    getTargetBlock(org.spongepowered.api.entity.living.player.server.ServerPlayer player, int maxDistance)
    Location of the block the player is looking at.
    void
    removeUser(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Removing a WECui user.
    void
    revertVisuals(org.spongepowered.api.entity.living.player.server.ServerPlayer player, UUID regionUniqueId)
    Remove border highlighting.
    void
    sendVisualDrag(org.spongepowered.api.entity.living.player.server.ServerPlayer player, org.spongepowered.math.vector.Vector3i pos)
    Dynamic selection of the area in the direction of the player's gaze.
    void
    stopVisualDrag(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
    Stop the dynamic area selection.
    void
    visualizeRegion(Region region, org.spongepowered.api.entity.living.player.server.ServerPlayer player, boolean investigating, boolean tempRegion)
    Display the region boundaries.
    void
    visualizeRegion(Region region, org.spongepowered.math.vector.Vector3i pos1, org.spongepowered.math.vector.Vector3i pos2, org.spongepowered.api.entity.living.player.server.ServerPlayer player, CUIUser user, boolean investigating, boolean tempRegion)
    Display the region boundaries.
    void
    visualizeRegions(List<Region> regions, org.spongepowered.api.entity.living.player.server.ServerPlayer player, boolean investigating)
    Display borders to multiple regions at the same time.

  • Method Details

    • getOrCreateUser

      CUIUser getOrCreateUser(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Creating or getting a WECui user.

    • getOrCreateUser

      CUIUser getOrCreateUser(UUID uuid)
      Creating or getting a WECui user.

    • removeUser

      void removeUser(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Removing a WECui user.

    • visualizeRegion

      void visualizeRegion(Region region, org.spongepowered.api.entity.living.player.server.ServerPlayer player, boolean investigating, boolean tempRegion)
      Display the region boundaries.
      Parameters:
      region - - visualization region
      player - - the player who needs to display the boundaries of the region
      investigating - - checking the region type to change the color of the grid
      tempRegion - - whether the region is temporary

    • visualizeRegion

      void visualizeRegion(Region region, org.spongepowered.math.vector.Vector3i pos1, org.spongepowered.math.vector.Vector3i pos2, org.spongepowered.api.entity.living.player.server.ServerPlayer player, CUIUser user, boolean investigating, boolean tempRegion)
      Display the region boundaries.
      Parameters:
      region - - target region
      pos1 - - first position
      pos2 - - second position
      player - - the player who needs to display the boundaries of the region
      user - - WECui user
      investigating - - checking the region type to change the color of the grid
      tempRegion - - whether the region is temporary

    • visualizeRegions

      void visualizeRegions(List<Region> regions, org.spongepowered.api.entity.living.player.server.ServerPlayer player, boolean investigating)
      Display borders to multiple regions at the same time.
      Parameters:
      regions - - список регионов для отображения границ
      player - - the player who needs to display the boundaries of the regions
      investigating - - checking the region type to change the color of the grid

    • revertVisuals

      void revertVisuals(org.spongepowered.api.entity.living.player.server.ServerPlayer player, UUID regionUniqueId)
      Remove border highlighting.
      Parameters:
      player - - target player
      regionUniqueId - - specify a specific region, if necessary

    • stopVisualDrag

      void stopVisualDrag(org.spongepowered.api.entity.living.player.server.ServerPlayer player)
      Stop the dynamic area selection.
      Parameters:
      player - - target player

    • sendVisualDrag

      void sendVisualDrag(org.spongepowered.api.entity.living.player.server.ServerPlayer player, org.spongepowered.math.vector.Vector3i pos)
      Dynamic selection of the area in the direction of the player's gaze.
      Parameters:
      player - - target player
      pos - - position from which the selection will take place in the direction of the view

    • getTargetBlock

      Optional<org.spongepowered.api.world.server.ServerLocation> getTargetBlock(org.spongepowered.api.entity.living.player.server.ServerPlayer player, int maxDistance)
      Location of the block the player is looking at.
      Parameters:
      player - - target player
      maxDistance - - distance to find the block
      Returns: