ImprovedFactions

2.3.0

ImprovedFactions/io.github.toberocat.improvedfactions.factions/Faction

Faction

class Faction(id: EntityID<Int>) : IntEntity

Created: 04.08.2023

Author

Tobias Madlberger (Tobias)

Constructors

constructor(id: EntityID<Int>)

Types

object Companion : EntityClass<Int, Faction>

Properties

var _readValues: ResultRow?

accumulatedPower

val accumulatedPower: Int

var db: Database

var defaultRank: Int

factionJoinType

var factionJoinType: FactionJoinType

var icon: ItemStack

val id: EntityID<Int>

var klass: EntityClass<Int, Entity<Int>>

val maxPower: Int

var name: String

var owner: UUID

val readValues: ResultRow

val writeValues: LinkedHashMap<Column<Any?>, Any?>

Functions

acceptAllyInvite

fun Faction.acceptAllyInvite(targetFaction: Faction)

fun Faction.allies(): Set<Int>

fun Faction.anyRank(name: String): FactionRank?

fun ban(user: FactionUser)

fun bans(): SizedIterable<FactionBan>

fun broadcast(key: LocalizationKey, placeholders: Map<String, String>)

fun claim(chunk: Chunk, announce: Boolean = true): FactionClaim

fun claims(): SizedIterable<FactionClaim>

fun claimSquare(centerChunk: Chunk, squareRadius: Int, handleError: (e: LocalizedException) -> Unit): ClaimStatistics

countActiveMembers

fun countActiveMembers(ticksIntoPast: Long): Int

countInactiveMembers

fun countInactiveMembers(millisecondsIntoPast: Long): Int

fun Faction.declareWar(targetFaction: Faction)

open override fun delete()

fun Faction.enemies(): Set<Int>

open fun flush(batch: EntityBatchUpdate?): Boolean

fun generateColor(): Int

fun getDefaultRank(): FactionRank

fun Faction.getHome(): Location?

operator fun <Unwrapped, Wrapped> EntityFieldWithTransform<Unwrapped, Wrapped>.getValue(o: Entity<Int>, desc: KProperty<*>): Wrapped

operator fun <REF : Any, RID : Any, T : Entity<RID>> OptionalReference<REF, RID, T>.getValue(o: Entity<Int>, desc: KProperty<*>): T?

operator fun <REF : Any, RID : Any, T : Entity<RID>> Reference<REF, RID, T>.getValue(o: Entity<Int>, desc: KProperty<*>): T

operator fun <T> Column<T>.getValue(o: Entity<Int>, desc: KProperty<*>): T

operator fun <T> CompositeColumn<T>.getValue(o: Entity<Int>, desc: KProperty<*>): T

fun invite(inviter: UUID, invited: UUID, rankId: Int): FactionInvite

inviteToAlliance

fun Faction.inviteToAlliance(targetFaction: Faction)

fun isBanned(user: FactionUser): Boolean

fun isInactive(toMillis: Long): Boolean

fun join(uuid: UUID, rankId: Int)

fun kick(player: UUID)

fun leave(player: UUID)

fun Faction.listRanks(): SizedIterable<FactionRank>

fun <T> Column<T>.lookup(): T

lookupInReadValues

fun <T, R : Any> Column<T>.lookupInReadValues(found: (T?) -> R?, notFound: () -> R?): R?

fun members(): SizedIterable<FactionUser>

open fun refresh(flush: Boolean)

setAccumulatedPower

fun setAccumulatedPower(newAccumulatedPower: Int, reason: PowerAccumulationChangeReason)

fun Faction.setHome(location: Location)

fun setMaxPower(newMaxPower: Int)

operator fun <Unwrapped, Wrapped> EntityFieldWithTransform<Unwrapped, Wrapped>.setValue(o: Entity<Int>, desc: KProperty<*>, value: Wrapped)

operator fun <REF : Any, RID : Any, T : Entity<RID>> OptionalReference<REF, RID, T>.setValue(o: Entity<Int>, desc: KProperty<*>, value: T?)

operator fun <REF : Any, RID : Any, T : Entity<RID>> Reference<REF, RID, T>.setValue(o: Entity<Int>, desc: KProperty<*>, value: T)

operator fun <T> Column<T>.setValue(o: Entity<Int>, desc: KProperty<*>, value: T)

operator fun <T> CompositeColumn<T>.setValue(o: Entity<Int>, desc: KProperty<*>, value: T)

storeWrittenValues

fun storeWrittenValues()

transferOwnership

fun transferOwnership(newOwner: UUID)

fun unclaim(chunk: Chunk, announce: Boolean = true)

fun unclaimSquare(chunk: Chunk, squareRadius: Int, handleError: (e: LocalizedException) -> Unit): ClaimStatistics

infix fun <TID : Any, Target : Entity<TID>> EntityClass<TID, Target>.via(table: Table): InnerTableLink<Int, Entity<Int>, TID, Target>

fun <TID : Any, Target : Entity<TID>> EntityClass<TID, Target>.via(sourceColumn: Column<EntityID<Int>>, targetColumn: Column<EntityID<TID>>): InnerTableLink<Int, Entity<Int>, TID, Target>