KtDataTagLib

Little wrapper of the Minecraft's Tag API made to make my life easier. Maybe it will make yours too.

Installing

build.gradle

    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }

    dependencies {
        modApi 'com.github.NathanPB:KtDataTagLib:VERSION'
        include 'com.github.NathanPB:KtDataTagLib:VERSION'
    }

See the versions in the releases page

Example Usage

class DummyData(tag: NbtCompound) : MutableCompoundData(tag) {
    val counter by persistentDefaulted(0, Serializers.INT)
    val idiotEnum by persistentDefaulted(TestEnum.A, EnumSerializer(TestEnum::class.java)) // Enums require you to manually instantiate the serializer, not big deal
    val nullable by persistent(Serializers.INT.nullable()) // Works with nullable values too
}

It works with all the primitive data types and String too, just pick the right serializer

val tag: NbtCompound = stack.orCreateTag // A NbtCompound you got from somewhere, does not matter where it came from
val data = DummyData(tag)

data.counter += 10 // I'll increment this counter because I'm such a random person
println(data.counter) // > 10

// Oh god my counter really incremented how is that possible

Supported Data Types

• Java/Kotlin's primitives (Int, Float, Double, Boolean, Byte, Short, Char, Long)
• String
• NbtCompound
• UUID
• Identifier
• ItemStack
• Enum
• BlockPos
• Vec3d
• Vec3i
• Nullable (Kotlin's ?) for all the types above
• List (for all the types above)
• Custom (You can create custom serializers as you wish, its pretty simple to implement. Just look at the existing ones)

Recommendations

Null safety can turn into a mess if you are not careful with nullable/non-nullable types.

If you wish to use persisted instead of persistedDefault make sure to use a nullable serializer too.

If you want to use a nullable serializer, so it may be a good idea to use persisted instead of persistedDefault or else you will not get any null values

For more examples check the example mod, its really idiot but it helps

Performance

The performance of this library wasn't tested yet and it may have problems, I really don't know yet.

License

Copyright 2020 Nathan P. Bombana

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.