cn.afternode.commons.bukkit.kotlin.BukkitPluginContextExt.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bukkit-kotlin Show documentation

Utilities for Minecraft bukkit plugin (and more) developing

The newest version!

package cn.afternode.commons.bukkit.kotlin

import cn.afternode.commons.bukkit.BukkitPluginContext
import cn.afternode.commons.bukkit.message.MessageBuilder
import cn.afternode.commons.bukkit.message.TabBuilder
import cn.afternode.commons.bukkit.report.PluginReport
import net.kyori.adventure.text.TextComponent
import org.bukkit.command.CommandSender
import org.bukkit.plugin.Plugin

/**
 * Create BukkitPluginContext of current plugin
 * @see BukkitPluginContext
 */
fun Plugin.createContext() = BukkitPluginContext(this)

/**
 * Create MessageBuilder with localizations and prefix in this context
 * @param sender Sender passed to MessageBuilder
 */
fun BukkitPluginContext.message(sender: CommandSender, block: MessageBuilder.() -> Unit): TextComponent {
    val builder = message(sender)
    block(builder)
    return builder.build()
}

/**
 * Create MessageBuilder with localizations and prefix in this context and send to the sender
 * @param sender Sender passed to MessageBuilder
 */
fun BukkitPluginContext.sendMessage(sender: CommandSender, block: MessageBuilder.() -> Unit) {
    sender.sendMessage(message(sender, block))
}

/**
 * Create MessageBuilder with localizations and prefix in this context
 * @return builder
 */
fun BukkitPluginContext.message(block: MessageBuilder.() -> Unit): TextComponent {
    val builder = message()
    block(builder)
    return builder.build()
}

/**
 * Create tab completion with sender
 */
fun BukkitPluginContext.tab(sender: CommandSender, block: TabBuilder.() -> Unit): MutableList {
    val builder = TabBuilder(sender)
    block(builder)
    return builder.build()
}

/**
 * Create tab completion
 */
fun BukkitPluginContext.tab(block: TabBuilder.() -> Unit): MutableList {
    val builder = TabBuilder()
    block(builder)
    return builder.build()
}

/**
 * Create plugin report
 * @see BukkitPluginContext.createReport
 */
fun BukkitPluginContext.report(block: PluginReport.() -> Unit): PluginReport {
    val report = this.createReport()
    block(report)
    return report
}