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 Summary
Modifier and TypeMethodDescriptionvoidcancelNextEvents(String eventClassName, int count) Arms cancellation of the next N fired events of a class (LOWEST-priority listener).Gets all captured server errors: structured log events plus raw stderr stack-trace detections.voidclearCapturedEvents(String eventClassName) Clears captured events for a class.voidClears all captured server errors and advances the raw stderr scan window.voidclickMenuSlot(UUID playerId, int slot) Clicks a menu slot for a synthetic player.intcountEntities(String worldName, @Nullable String entityTypeKey, @Nullable BlockPos boundsMin, @Nullable BlockPos boundsMax) Counts entities in a world matching the optional type and bounds filters.longGets the server's current tick.voiddragMenuSlots(UUID playerId, String materialKey, int... slots) Performs a menu drag interaction for a synthetic player.Drops item from player's main hand.voidexecutePlayerCommand(UUID playerId, String command) Executes a command as a synthetic player.Gets block material at a position.getBlockData(String worldName, BlockPos position) Gets the full block-data string at a position (every state property included).getCapturedEvents(String eventClassName) Gets captured events for a class.voidgrantPermission(UUID playerId, String permission) Grants a permission node to a synthetic player by setting it totrueon the player's attachment.booleanhasPermission(UUID playerId, String permission) Queries the live value of a permission node for a synthetic player.booleanisChunkLoaded(String worldName, int x, int z) Checks if a chunk is loaded.booleanleftClickBlock(UUID playerId, BlockPos position, String blockFace) Fires a left-click block interaction as a synthetic player.booleanLoads a chunk.menuSnapshot(UUID playerId) Retrieves menu snapshot for a synthetic player.voidplacePlayerBlock(UUID playerId, String material, int x, int y, int z) Places a block as a synthetic player.voidplayerChat(UUID playerId, String message) Makes a synthetic player say a chat message, firing the real chat event.playerChatComponents(UUID playerId) Gets captured chat components for a player.playerInventory(UUID playerId) Gets player inventory snapshot.playerMessages(UUID playerId) Gets received message history for a player.voidregisterEventListener(String eventClassName) Registers an event listener.voidremovePlayer(PlayerHandle player) Removes a synthetic player.voidrevokePermission(UUID playerId, String permission) Revokes a permission node from a synthetic player by setting it tofalseon the player's attachment.booleanrightClickBlock(UUID playerId, BlockPos position, String blockFace) Fires a right-click block interaction as a synthetic player.voidSets block material at a position.voidsetBlockData(String worldName, BlockPos position, String blockData) Sets a block from a full block-data string, applying type and state properties atomically.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.tabComplete(UUID playerId, String commandLine) Computes command tab-completions as a synthetic player.booleanteleportPlayer(UUID uuid, String worldName, double x, double y, double z) Teleports a synthetic player.booleanunloadChunk(String worldName, int x, int z) Unloads a chunk.voidunregisterEventListener(String eventClassName) Unregisters an event listener.voidunsetPermission(UUID playerId, String permission) Removes a permission node from a synthetic player's attachment, restoring the player's default.voidwaitTicks(int ticks) Waits for a number of ticks.voidWaits for a framework condition.
-
Method Details
-
getBlock
Gets block material at a position. -
setBlock
Sets block material at a position. -
getBlockData
Gets the full block-data string at a position (every state property included). -
setBlockData
Sets a block from a full block-data string, applying type and state properties atomically. -
executePlayerCommand
Executes a command as a synthetic player. -
tabComplete
Computes command tab-completions as a synthetic player.- Returns:
- The tab-completion suggestions in server order, permission-filtered for the player.
-
grantPermission
Grants a permission node to a synthetic player by setting it totrueon the player's attachment. -
revokePermission
Revokes a permission node from a synthetic player by setting it tofalseon the player's attachment. -
unsetPermission
Removes a permission node from a synthetic player's attachment, restoring the player's default. -
hasPermission
Queries the live value of a permission node for a synthetic player. -
teleportPlayer
Teleports a synthetic player.- Returns:
- True if the teleport succeeded, false if it was blocked (e.g. a cancelled teleport event).
-
placePlayerBlock
Places a block as a synthetic player. -
loadChunk
Loads a chunk.- Returns:
- True if the chunk was loaded successfully.
-
unloadChunk
Unloads a chunk. -
isChunkLoaded
Checks if a chunk is loaded. -
leftClickBlock
Fires a left-click block interaction as a synthetic player.- Returns:
truewhen a plugin cancelled the firedPlayerInteractEvent.
-
rightClickBlock
Fires a right-click block interaction as a synthetic player.- Returns:
truewhen a plugin cancelled the firedPlayerInteractEvent.
-
clickMenuSlot
Clicks a menu slot for a synthetic player. -
dragMenuSlots
Performs a menu drag interaction for a synthetic player. -
removePlayer
Removes a synthetic player. -
waitTicks
void waitTicks(int ticks) Waits for a number of ticks. -
waitUntil
Waits for a framework condition. -
playerMessages
Gets received message history for a player. -
playerChatComponents
Gets captured chat components for a player. -
playerInventory
Gets player inventory snapshot. -
dropItem
Drops item from player's main hand.- Returns:
- The drop outcome, distinguishing a successful drop from a cancelled event and an empty hand.
-
registerEventListener
Registers an event listener. -
getCapturedEvents
Gets captured events for a class. -
clearCapturedEvents
Clears captured events for a class. -
unregisterEventListener
Unregisters an event listener. -
cancelNextEvents
Arms cancellation of the next N fired events of a class (LOWEST-priority listener). -
playerChat
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.
-