ImprovedFactions/io.github.toberocat.improvedfactions.database.storage/GameStateCommands

GameStateCommands

object GameStateCommands

Runtime mutations expressed only in immutable scalar input and executed by StorageManager.

Types

DefaultRankSpec

data class DefaultRankSpec(val name: String, val priority: Int, val allowedPermissions: Set<String>)

Functions

acceptAllyInvite

fun acceptAllyInvite(sourceId: Int, targetId: Int): CompletionStage<Unit>

acceptInvite

fun acceptInvite(inviteId: Int, playerId: UUID, factionId: Int, rankId: Int, memberPowerConstant: Double? = null): CompletionStage<Unit>

assignRank

fun assignRank(uniqueId: UUID, rankId: Int): CompletionStage<Unit>

banUser

fun banUser(factionId: Int, uniqueId: UUID): CompletionStage<Unit>

claim

fun claim(key: ClaimKey, factionId: Int, zoneType: String = "default"): CompletionStage<Unit>

claimAll

fun claimAll(keys: List<ClaimKey>, factionId: Int, accumulatedPower: Int): CompletionStage<Int>

createAllyInvite

fun createAllyInvite(sourceId: Int, targetId: Int, expiresAt: Instant): CompletionStage<Unit>

createBan

fun createBan(factionId: Int, userId: Int): CompletionStage<Unit>

createFaction

fun createFaction(owner: UUID, name: String, maximumPower: Int, ranks: List<GameStateCommands.DefaultRankSpec>, knownPermissions: Set<String>): CompletionStage<Int>

createInvite

fun createInvite(inviter: UUID, invited: UUID, factionId: Int, rankId: Int, expiresAt: Instant): CompletionStage<Unit>

createRank

fun createRank(factionId: Int, name: String, priority: Int, knownPermissions: Set<String>, allowedPermissions: Set<String> = emptySet()): CompletionStage<Unit>

createRelation

fun createRelation(sourceId: Int, targetId: Int, typeOrdinal: Int): CompletionStage<Unit>

deleteBan

fun deleteBan(banId: Int): CompletionStage<Unit>

deleteFaction

fun deleteFaction(factionId: Int): CompletionStage<Unit>

deleteFactionRelations

fun deleteFactionRelations(factionId: Int): CompletionStage<Unit>

deleteInvite

fun deleteInvite(inviteId: Int): CompletionStage<Unit>

deleteRank

fun deleteRank(rankId: Int, fallbackRankId: Int): CompletionStage<Unit>

deleteRelation

fun deleteRelation(sourceId: Int, targetId: Int, typeOrdinal: Int): CompletionStage<Unit>

renameFaction

fun renameFaction(factionId: Int, name: String): CompletionStage<Unit>

setAccumulatedPower

fun setAccumulatedPower(values: Map<Int, Int>): CompletionStage<Unit>

setDefaultRank

fun setDefaultRank(factionId: Int, rankId: Int): CompletionStage<Unit>

setHome

fun setHome(factionId: Int, home: HomeSnapshot): CompletionStage<Unit>

setIcon

fun setIcon(factionId: Int, base64: String?): CompletionStage<Unit>

setJoinType

fun setJoinType(factionId: Int, joinType: FactionJoinType): CompletionStage<Unit>

setOwner

fun setOwner(factionId: Int, owner: UUID): CompletionStage<Unit>

setPermission

fun setPermission(rankId: Int, permission: String, allowed: Boolean): CompletionStage<Unit>

setPower

fun setPower(factionId: Int, accumulated: Int? = null, maximum: Int? = null): CompletionStage<Unit>

setUserFaction

fun setUserFaction(uniqueId: UUID, factionId: Int, rankId: Int, memberPowerConstant: Double? = null): CompletionStage<Unit>

setZone

fun setZone(keys: List<ClaimKey>, zoneType: String): CompletionStage<Int>

transferOwnership

fun transferOwnership(factionId: Int, previousOwner: UUID, newOwner: UUID, removePreviousOwner: Boolean = false, memberPowerConstant: Double? = null): CompletionStage<Unit>

unclaim

fun unclaim(key: ClaimKey): CompletionStage<Unit>

unclaimAll

fun unclaimAll(keys: List<ClaimKey>, factionId: Int): CompletionStage<Int>

unclaimZone

fun unclaimZone(keys: List<ClaimKey>, defaultZoneType: String): CompletionStage<Int>

Removes an administrative zone without leaving a no-faction/default-zone claim behind. A faction claim that was temporarily made into a zone keeps its owner and simply returns to the default zone.

updateUsage

fun updateUsage(registry: String, playerId: UUID, used: Int): CompletionStage<Unit>