Interface IFrameworkGatewayView


public interface IFrameworkGatewayView
Internal gateway contract used by framework handle implementations.

This type is not part of the supported public API surface and exists to decouple public handle types from implementation classes in framework.internal.

  • Method Details

    • getBlock

      String getBlock(String worldName, BlockPos position)
      Gets block material at a position.
    • setBlock

      void setBlock(String worldName, BlockPos position, String material)
      Sets block material at a position.
    • getBlockData

      String getBlockData(String worldName, BlockPos position)
      Gets the full block-data string at a position (every state property included).
    • setBlockData

      void setBlockData(String worldName, BlockPos position, String blockData)
      Sets a block from a full block-data string, applying type and state properties atomically.
    • executePlayerCommand

      void executePlayerCommand(UUID playerId, String command)
      Executes a command as a synthetic player.
    • tabComplete

      List<String> tabComplete(UUID playerId, String commandLine)
      Computes command tab-completions as a synthetic player.
      Returns:
      The tab-completion suggestions in server order, permission-filtered for the player.
    • grantPermission

      void grantPermission(UUID playerId, String permission)
      Grants a permission node to a synthetic player by setting it to true on the player's attachment.
    • revokePermission

      void revokePermission(UUID playerId, String permission)
      Revokes a permission node from a synthetic player by setting it to false on the player's attachment.
    • unsetPermission

      void unsetPermission(UUID playerId, String permission)
      Removes a permission node from a synthetic player's attachment, restoring the player's default.
    • hasPermission

      boolean hasPermission(UUID playerId, String permission)
      Queries the live value of a permission node for a synthetic player.
    • teleportPlayer

      boolean teleportPlayer(UUID uuid, String worldName, double x, double y, double z)
      Teleports a synthetic player.
      Returns:
      True if the teleport succeeded, false if it was blocked (e.g. a cancelled teleport event).
    • placePlayerBlock

      void placePlayerBlock(UUID playerId, String material, int x, int y, int z)
      Places a block as a synthetic player.
    • loadChunk

      boolean loadChunk(String worldName, int x, int z)
      Loads a chunk.
      Returns:
      True if the chunk was loaded successfully.
    • unloadChunk

      boolean unloadChunk(String worldName, int x, int z)
      Unloads a chunk.
    • isChunkLoaded

      boolean isChunkLoaded(String worldName, int x, int z)
      Checks if a chunk is loaded.
    • leftClickBlock

      boolean leftClickBlock(UUID playerId, BlockPos position, String blockFace)
      Fires a left-click block interaction as a synthetic player.
      Returns:
      true when a plugin cancelled the fired PlayerInteractEvent.
    • rightClickBlock

      boolean rightClickBlock(UUID playerId, BlockPos position, String blockFace)
      Fires a right-click block interaction as a synthetic player.
      Returns:
      true when a plugin cancelled the fired PlayerInteractEvent.
    • clickMenuSlot

      void clickMenuSlot(UUID playerId, int slot)
      Clicks a menu slot for a synthetic player.
    • dragMenuSlots

      void dragMenuSlots(UUID playerId, String materialKey, int... slots)
      Performs a menu drag interaction for a synthetic player.
    • removePlayer

      void removePlayer(PlayerHandle player)
      Removes a synthetic player.
    • waitTicks

      void waitTicks(int ticks)
      Waits for a number of ticks.
    • waitUntil

      void waitUntil(Condition condition, Duration timeout)
      Waits for a framework condition.
    • playerMessages

      List<String> playerMessages(UUID playerId)
      Gets received message history for a player.
    • playerChatComponents

      List<ChatComponentSnapshot> playerChatComponents(UUID playerId)
      Gets captured chat components for a player.
    • playerInventory

      InventorySnapshot playerInventory(UUID playerId)
      Gets player inventory snapshot.
    • dropItem

      DropResult dropItem(UUID playerId)
      Drops item from player's main hand.
      Returns:
      The drop outcome, distinguishing a successful drop from a cancelled event and an empty hand.
    • registerEventListener

      void registerEventListener(String eventClassName)
      Registers an event listener.
    • getCapturedEvents

      List<CapturedEventSnapshot> getCapturedEvents(String eventClassName)
      Gets captured events for a class.
    • clearCapturedEvents

      void clearCapturedEvents(String eventClassName)
      Clears captured events for a class.
    • unregisterEventListener

      void unregisterEventListener(String eventClassName)
      Unregisters an event listener.
    • cancelNextEvents

      void cancelNextEvents(String eventClassName, int count)
      Arms cancellation of the next N fired events of a class (LOWEST-priority listener).
    • playerChat

      void playerChat(UUID playerId, String message)
      Makes a synthetic player say a chat message, firing the real chat event.
    • currentServerTick

      long currentServerTick()
      Gets the server's current tick.
    • countEntities

      int countEntities(String worldName, @Nullable String entityTypeKey, @Nullable BlockPos boundsMin, @Nullable BlockPos boundsMax)
      Counts entities in a world matching the optional type and bounds filters.
    • snapshotEntities

      List<EntitySnapshot> snapshotEntities(String worldName, @Nullable String entityTypeKey, @Nullable BlockPos boundsMin, @Nullable BlockPos boundsMax)
      Snapshots entities in a world matching the optional type and bounds filters, in one main-thread burst.
    • capturedServerErrors

      List<ServerErrorSnapshot> capturedServerErrors()
      Gets all captured server errors: structured log events plus raw stderr stack-trace detections.
    • clearServerErrors

      void clearServerErrors()
      Clears all captured server errors and advances the raw stderr scan window.