trueog/DiamondBank-OG
2
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

wait -> block in Javadoc of API functions

Browse Source
This commit is contained in:
SKBotNL committed 2026-09-17 22:05:29 +02:00
1 parent cbf6a93921
commit 232e663387
3 files changed
+28 -28
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

src/main/kotlin/net/trueog/diamondbankog/api/DiamondBankAPIJava.kt
+10 -10
View File
@@ -20,7 +20,7 @@ import org.bukkit.entity.Player
class DiamondBankAPIJava {
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released.
* WARNING: if the player has a transaction lock applied this function will block until its released.
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -55,7 +55,7 @@ class DiamondBankAPIJava {
}
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -92,7 +92,7 @@ class DiamondBankAPIJava {
}
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -104,7 +104,7 @@ class DiamondBankAPIJava {
fun getBankShards(uuid: UUID): Long = getShardTypeShards(uuid, ShardType.BANK)
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -116,7 +116,7 @@ class DiamondBankAPIJava {
fun getInventoryShards(uuid: UUID): Long = getShardTypeShards(uuid, ShardType.INVENTORY)
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -128,7 +128,7 @@ class DiamondBankAPIJava {
fun getEnderChestShards(uuid: UUID): Long = getShardTypeShards(uuid, ShardType.ENDER_CHEST)
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -140,7 +140,7 @@ class DiamondBankAPIJava {
fun getTotalShards(uuid: UUID): Long = getShardTypeShards(uuid, ShardType.TOTAL)
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -184,7 +184,7 @@ class DiamondBankAPIJava {
}
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -205,7 +205,7 @@ class DiamondBankAPIJava {
}
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -257,7 +257,7 @@ class DiamondBankAPIJava {
}
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
src/main/kotlin/net/trueog/diamondbankog/api/DiamondBankAPIKotlin.kt
+9 -9
View File
@@ -18,7 +18,7 @@ import org.bukkit.entity.Player
class DiamondBankAPIKotlin {
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* @param transactionReason the reason for this transaction for in the transaction log
* @param notes any specifics for this transaction that may be nice to know for in the transaction log
@@ -51,7 +51,7 @@ class DiamondBankAPIKotlin {
}
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* @param transactionReason the reason for this transaction for in the transaction log
* @param notes any specifics for this transaction that may be nice to know for in the transaction log
@@ -84,21 +84,21 @@ class DiamondBankAPIKotlin {
}
}
/** WARNING: if the player has a transaction lock applied this function will wait until its released */
/** WARNING: if the player has a transaction lock applied this function will block until its released */
@Suppress("unused") suspend fun getBankShards(uuid: UUID): Result<Long> = getShardTypeShards(uuid, ShardType.BANK)
/** WARNING: if the player has a transaction lock applied this function will wait until its released */
/** WARNING: if the player has a transaction lock applied this function will block until its released */
@Suppress("unused")
suspend fun getInventoryShards(uuid: UUID): Result<Long> = getShardTypeShards(uuid, ShardType.INVENTORY)
/** WARNING: if the player has a transaction lock applied this function will wait until its released */
/** WARNING: if the player has a transaction lock applied this function will block until its released */
@Suppress("unused")
suspend fun getEnderChestShards(uuid: UUID): Result<Long> = getShardTypeShards(uuid, ShardType.ENDER_CHEST)
/** WARNING: if the player has a transaction lock applied this function will wait until its released */
/** WARNING: if the player has a transaction lock applied this function will block until its released */
@Suppress("unused") suspend fun getTotalShards(uuid: UUID): Result<Long> = getShardTypeShards(uuid, ShardType.TOTAL)
/** WARNING: if the player has a transaction lock applied this function will wait until its released */
/** WARNING: if the player has a transaction lock applied this function will block until its released */
@Suppress("unused")
suspend fun getAllShards(uuid: UUID): Result<PlayerShards> {
if (economyDisabled) return Result.failure(EconomyDisabledException())
@@ -144,7 +144,7 @@ class DiamondBankAPIKotlin {
}
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* @param transactionReason the reason for this transaction for in the transaction log
* @param notes any specifics for this transaction that may be nice to know for in the transaction log
@@ -198,7 +198,7 @@ class DiamondBankAPIKotlin {
}
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* WARNING: This function can return a CouldNotRemoveEnoughException, make sure you handle it properly. It has a
* field called notRemoved that has the amount of shards not removed, you should continue with the originally
src/main/kotlin/net/trueog/diamondbankog/api/README.md
+9 -9
View File
@@ -30,7 +30,7 @@ Exceptions are only applicable when using the Java API, when using the Kotlin AP
### addToPlayerShards
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released.
* WARNING: if the player has a transaction lock applied this function will block until its released.
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -54,7 +54,7 @@ public void addToPlayerBankShards(UUID uuid, long shards, String transactionReas
### subtractFromPlayerBankShards
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -79,7 +79,7 @@ public void subtractFromPlayerBankShards(UUID uuid, long shards, String transact
### getBankShards
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -99,7 +99,7 @@ public long getBankShards(UUID uuid)
### getInventoryShards
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -119,7 +119,7 @@ public long getInventoryShards(UUID uuid)
### getEnderChestShards
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -139,7 +139,7 @@ public long getEnderChestShards(UUID uuid)
### getTotalShards
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -160,7 +160,7 @@ public long getTotalShards(UUID uuid)
### getBaltop
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -180,7 +180,7 @@ public Map<@Nullable UUID, Long> getBaltop(int offset)
### consumeFromPlayer
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture
@@ -205,7 +205,7 @@ public void consumeFromPlayer(UUID uuid, long shards, String transactionReason,
### playerPayPlayer
```kotlin
/**
* WARNING: if the player has a transaction lock applied this function will wait until its released
* WARNING: if the player has a transaction lock applied this function will block until its released
*
* This function also blocks for the database call, this is so you don't have to manually run .get() on a
* CompletableFuture