Macrocosm/space.maxus.macrocosm.ability/FullSetBonus

FullSetBonus

open class FullSetBonus(val name: String, val description: String, val threePiece: Boolean = false) : AbilityBase(source)

A wrapper for abstract AbilityBase, which provides some minor features. Can also be inherited for more abstraction.

Note that this ability is also rendered as Full Set Bonus: <name>, and does not accept ability types, so make sure to inherit it and override the buildLore method to inject your own type.

Parameters

name

Name of the ability. Supports MM tags.

description

Description of this ability. Will be partitioned to 25 chars per line, not including MM tags

Inheritors

Constructors

FullSetBonus

constructor(name: String, description: String, threePiece: Boolean = false)

Creates a new full set bonus ability

Functions

buildLore

open override fun buildLore(lore: MutableList<Component>, player: MacrocosmPlayer?)

Builds and inserts the ability name and descriptions in provided lore list

ensureSetRequirement

fun ensureSetRequirement(player: MacrocosmPlayer): Boolean

Ensures that the provided player has set with this ability

registerListeners

open fun registerListeners()

You have to override this function, and register listeners there (net.axay.kspigot.event.listen)), this is where all the ability logic is defined at

Properties

cost

open override val cost: AbilityCost? = null

Cost to perform this ability

description

open override val description: String

Description of this ability. Will later be partitioned for every 25 characters, not including MM tags

open override val id: Identifier

ID of this ability, got from the Registry.ABILITY)

name

open override val name: String

Name of this ability. It is later parsed using MiniMessage, therefore may contain MM tags

threePiece

val threePiece: Boolean = false

type

open override val type: AbilityType

Type of this ability, only used for visual lore display