201 lines
4.8 KiB
Markdown
201 lines
4.8 KiB
Markdown
# KSpigot
|
|
|
|
## About
|
|
|
|
KSpigot is a kotlin extension for the popular [spigot server software](https://spigotmc.org/) for minecraft.
|
|
KSpigot adds functionality missing in spigot and partly makes it possible to do it the kotlin way. Most of KSpigot's extensions are stable.
|
|
|
|
IMPORTANT:
|
|
Extensions marked with NMS annotations like `@NMS_GENERAL` or `@NMS_"VERSIONSTRING"` are unstable.
|
|
|
|
Extensions marked with the `@UnsafeImplementaion` annotation do not promise to always give the correct result, but are still useful and therefore included in the project. This readme DOES NOT contain any unsafe parts of KSpigot.
|
|
|
|
## First of all
|
|
|
|
**Inherit from `KSpigot` instead of `JavaPlugin` in your main class** <br>
|
|
```kotlin
|
|
class MyPluginMain : KSpigot()
|
|
```
|
|
|
|
**Replaced methods:**
|
|
(override these instead)
|
|
```kotlin
|
|
onLoad() with load()
|
|
onEnable() with startup()
|
|
onDisable() with shutdown()
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Simple runnables and schedulers:
|
|
|
|
```kotlin
|
|
bukkitAsync(kSpigot) { /* short form for async schedulers */ }
|
|
```
|
|
```kotlin
|
|
bukkitSync(kSpigot) { /* sync some code to bukkits main thread */ }
|
|
```
|
|
|
|
```kotlin
|
|
bukkitRunnable(
|
|
kSpigot,
|
|
sync = false,
|
|
howoften = 5,
|
|
delay = 25,
|
|
period = 20
|
|
) { /* runnable code */ }
|
|
```
|
|
|
|
### Powerful builders
|
|
|
|
#### For items
|
|
|
|
```kotlin
|
|
val wand = itemStack(Material.GOLD_BLOCK) {
|
|
|
|
amount = 3
|
|
|
|
addEnchantment(Enchantment.KNOCKBACK, 2)
|
|
|
|
meta {
|
|
|
|
name = "${ChatColor.GOLD}Magic wand"
|
|
isUnbreakable = true
|
|
|
|
addLore {
|
|
+ "This wand is truly special."
|
|
+ "Try it!"
|
|
}
|
|
|
|
customModel = 1001
|
|
|
|
flag(ItemFlag.HIDE_UNBREAKABLE)
|
|
|
|
}
|
|
|
|
}
|
|
```
|
|
|
|
#### For complex chat components
|
|
|
|
```kotlin
|
|
chatComponent {
|
|
|
|
text("You got a friend request! ") {
|
|
color = col("#4FEA40")
|
|
isBold = true
|
|
}
|
|
|
|
text("[Accept]") {
|
|
color = ChatColor.WHITE
|
|
clickEvent(ClickEvent.Action.RUN_COMMAND, "friend accept Foo")
|
|
hoverEventText {
|
|
text("Click here to accept the friend request!") { color = ChatColor.RED }
|
|
}
|
|
}
|
|
|
|
}
|
|
```
|
|
You can also access the builder by calling
|
|
```kotlin
|
|
commandSender.sendMessage { /* same in here as above */ }
|
|
```
|
|
|
|
#### And more
|
|
|
|
A lot of additional things are also suitable for builders. Just like fireworks etc...
|
|
|
|
### NBTData support
|
|
Typesafe and consistent
|
|
|
|
```kotlin
|
|
// load nbt
|
|
val nbt = entity.nbtData
|
|
|
|
// retrieve data via keys
|
|
val health = nbt["hearts", NBTDataType.INT]
|
|
|
|
// set data for a given key
|
|
nbt["custom", NBTDataType.DOUBLE] = 3.3
|
|
|
|
// save data to the entity
|
|
entity.nbtData = nbt
|
|
|
|
// serialization support
|
|
val serializedString = nbt.serialize()
|
|
val deserializeMethod1 = NBTData(serializedString)
|
|
val deserializeMethod2 = NBTData.deserialize(serializedString)
|
|
```
|
|
|
|
### Simple extension methods / values (with kotlin getters)
|
|
|
|
```kotlin
|
|
livingEntity.isInWater
|
|
livingEntity.isHeadInWater
|
|
entity.isFeetInWater
|
|
entity.isGroundSolid
|
|
damageable.kill()
|
|
livingEntity.heal()
|
|
player.feed()
|
|
player.saturate()
|
|
player.feedSaturate()
|
|
player.disappear(plugin)
|
|
player.appear(plugin)
|
|
vector.isFinite
|
|
playerInteractEntityEvent.interactItem
|
|
prepareItemCraftEvent.isCancelled
|
|
prepareItemCraftEvent.cancel()
|
|
```
|
|
|
|
### Direction API
|
|
Handles the hassle of struggling with direction angles for you.
|
|
|
|
```kotlin
|
|
val cardinal = CardinalDirection.fromLocation(loc) // NORTH, EAST, SOUTH, WEST
|
|
val vertical = VerticalDirection.fromLocation(loc) // UP, DOWN, STRAIGHT
|
|
|
|
// convert to BlockFace
|
|
val blockFace = cardinal.facing
|
|
```
|
|
|
|
### CustomItemIdentifiers
|
|
You want to mess with resourcepacks and extend your possibilities? <br>
|
|
Spigot is lacking a representation of custom items (via custom model data). This is what the data class `CustomItemIdentifier` is for!
|
|
|
|
```kotlin
|
|
val identifier = CustomItemIdentifier(itemStack)
|
|
// or
|
|
val identifier = CustomItemIdentifier(1001, Material.IRON_NUGGET)
|
|
|
|
// get an itemstack with the custom model data applied
|
|
val stack = identifier.itemStack
|
|
```
|
|
|
|
### Flexible and chainable geometry syntax
|
|
Makes complex modification of locations and vectors more intuitive. Also, you can use any type of number (`Short`, `Int`, `Long`, `Float`, `Double`) you want. You do not have to mess with different data types.
|
|
|
|
```kotlin
|
|
loc increaseX 3 reduce vec(3.0, 1.5f, 3) increaseYZ 5.7
|
|
loc + vecXY(3, 7f) - vecZ(3)
|
|
loc - vec(x = 3, z = 5.6f) * 3 * vecXZ(7, 3.1)
|
|
```
|
|
|
|
### Listeners made easy
|
|
Kotlins' language design allows you to create listeners in a very short way.
|
|
|
|
```kotlin
|
|
kSpigot.listen<PlayerMoveEvent> {
|
|
it.player.kick("Do not move!")
|
|
}
|
|
```
|
|
NOTE: This method automatically registers the listener.
|
|
|
|
The `listen<Event> { }` method returns the listener instance.
|
|
|
|
The following extension methods can be used on any listener:
|
|
```kotlin
|
|
listener.register(plugin)
|
|
listener.unregister()
|
|
```
|
|
|
|
> Any questions? Feel free to contact me! |