ginloader.bukkit-api.1.13.0.source-code.Annotation.kt Maven / Gradle / Ivy

Go to download

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

Bukkit API for runtime kotlin plugin loader

There is a newer version: 3.1.0

package pluginloader.api

import org.bukkit.event.EventPriority
import org.bukkit.command.CommandSender

/**
 * Register bukkit listener
 * See also [Plugin.registerListener]
 * Extremely recommend use internal, for compatibility with java 11+
 * ```
 * @Listener
 * internal fun listen(event: PlayerJoinEvent){event.player.sendMessage("hi")}
 * ```
 * @param priority call sequence: LOW (first), NORMAL (second), HIGH (third)
 * @param ignoreCancelled if true and event cancelled, method don't call
 */
@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class Listener(
    val priority: EventPriority = EventPriority.NORMAL,
    val ignoreCancelled: Boolean = false)

/**
 * Register bukkit command. Command can be used anyone
 * See also [Plugin.registerCommand]
 * Extremely recommend use internal, for compatibility with java 11+
 * ```
 * @Command("command", aliases = ["alias"])
 * internal fun cmd(sender: Sender, args: Args){}
 * ```
 * @param name command name, /hi
 * @param op if true, only player.isOp can call this command
 * @param sender [Sender] or [CommandSender]
 * @param args [Args] /example a b -> arrayOf("a", "b")
 */
@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class Command(
    val name: String,
    val aliases: Array = [],
    val op: Boolean = false)

@Deprecated("Use plu.plu(\"configs\")")
@Target(AnnotationTarget.FIELD)
@Retention(AnnotationRetention.RUNTIME)
annotation class Config