[API] jaylawl's (scoreboard) TagAPI

jaylawl's tagAPI

Dependencies:

• Spigot 1.9+
• Skript (any somewhat recent version should work)
• skript-mirror (https://forums.skunity.com/resources/skript-mirror.254/)

What are "scoreboard tags"?

Scoreboard tags are a feature added to Minecraft in version 1.9. They are strings that are saved within an entity's NBT data (and do not affect scoreboards at all). They may be added to all any kind of living entity, including players, monsters, animals, item frames and armor stands. They can not be applied to tile entities.

You may save any kind of data as a scoreboard tag, but note that it must be applied as a string/text. If you're storing a number as text, you will have to re-convert it back to a number when retrieving the data.

• Scoreboard tags persist over server restarts
• Up to 1024 tags can be stored per entity
• Tags automatically get deleted if the carrying entity dies/despawns
• Faster than file-storage (yaml/txt)
  
• Only strings can be saved as tags
• A bit slower than Skript-variable storage
• Data must be converted to/from strings
• Very useful for cross-plugin communication (for ex.: MythicMobs)

When you'd want to use this storage method is up to you. As with any other storage method, you have to consider the advantages and disadvantages in relation to your project.

Expressions:

• %entity%'s [scoreboard(-| )]tags
  Allows to be get, looped, set, added to, removed from, deleted and reset
  
  
• %entity%'s [scoreboard(-| )]tag(-| )value %string%
  allows to be get, set, deleted and reset

Conditions:

• %entity% (0¦does(n't| not) have|1¦has [got]|does have) [scoreboard(-| )]tag[s ] %strings%
• %entity% (0¦does(n't| not) have|1¦has [got]|does have) [scoreboard(-| )]tag(-| )value[s ] %strings%

Examples:

command /test:
    trigger:
 
        add "this", "is", "just", "an", "example" to command sender's tags
        loop command sender's tags:
            send "%loop-value%"
     
        remove "this", "is", "just" from command sender's tags
        send "%command sender's tags%"
 
        set command sender's tag value "IsTest" to "true"
        command sender has tag value "IsTest":
            command sender's tag value "IsTest" = "true"
            send "&atrue!, command sender has the tags: %command sender's tags%"
     
        delete command sender's tag value "IsTest"
        remove "an", "example" from command sender's tags
 
        send "%command sender's tags%"

Old function syntax (no longer supported):

addTag(entity, tag=text)

removeTag(entity, tag=text)

setTagValue(entity, tag=text, value=text)

removeTagValue(entity, tag=text)

getTags(entity)

getTagValue(entity, tag=text)

hasTag(entity, tag=text)

hasTagValue(entity, tag=text)

on spawn of villager:
    chance of 0.5
    addTag(event-entity, "no_trades")

on right click on villager:
    hasTag(event-entity, "no_trades") = true
    cancel event

on command /special:
    trigger:
        loop all entities:
            hasTag(loop-entity, "special_entity") = true
            send "A special entity already exists!"
            stop
        spawn 1 armor stand at command sender's location
        addTag(last spawned entity, "special_entity")

on damage of armor stand:
    hasTag(victim, "special_entity") = true
    cancel event

on command /findspecial:
    trigger:
        loop all entities:
            hasTag(loop-entity, "special_entity") = true
            send "Found special entity with UUID %loop-entity's uuid% at location %loop-entity's location%"
            teleport command sender to loop-entity's location
            stop

on damage:
    hasTag(victim, "golfball") = true
    getTagValue(victim, "ball-owner") != attacker's uuid:
        send "&cThat's not your ball!"
        stop

on right click on entity:
    getTagValue(event-entity, "owner") = event-player's uuid
    make event-player ride event-entity

on right click on rabbit:
    hasTagValue(event-entity, "owner") = false
    setTagValue(event-entity, "owner", "%event-player's uuid%")
    send "You tamed this rabbit!"

command "/tagwand":
Use this command to receive a wand that allows you to right click on entities to check the scoreboard tags they have. Works on all except tile-entities. Drop the item from your inventory to have it automatically destroyed.

Special thanks go to @Mr_Simba! He made something very similar to this, except that it uses SkStuff instead of skript-mirror and showed it to me a while ago on bensku's github. That gave me my original introduction to making my own functions and helped me understand Skript a lot. Thanks again!

Is this resource useful to you?
Consider buying me a coffee or pizza if it is! Paypal: https://www.paypal.me/langejulian