Denizen Script Tags


Tags are always written with a <between these marks>, and are critical to scripts, as the primary way to read data.
Learn about how tags work in The Beginner's Guide.


Showing 22 out of 2454 tags...

Categories:

FlaggableObject | QueueTag


Category: FlaggableObject


Name<FlaggableObject.flag[<flag_name>]>
ReturnsObjectTag
DescriptionReturns the specified flag from the flaggable object.
If the flag is expired, will return null.
Consider also using Tag:FlaggableObject.has_flag.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L37

Name<FlaggableObject.flag_expiration[<flag_name>]>
ReturnsTimeTag
DescriptionReturns a TimeTag indicating when the specified flag will expire.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L71

Name<FlaggableObject.flag_map[<name>|...]>
ReturnsMapTag
DescriptionReturns a raw map of the objects internal flag data for the flags with the given flag name. Names must be root names (no '.').
Output is a MapTag wherein each key is a flag name, and each value is a MapTag, containing keys '__value' and '__expiration', where '__value' contains the real object value.
Output also may contain key '__clear', which is a ListTag of flags that were listed in input but weren't present in output.
Using this without a parameter to get ALL flags is allowed exclusively for debug/testing reasons, and should never be used in a real script.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L104

Name<FlaggableObject.has_flag[<flag_name>]>
ReturnsElementTag(Boolean)
DescriptionReturns true if the flaggable object has the specified flag, otherwise returns false.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L55

Name<FlaggableObject.list_flags>
ReturnsListTag
DescriptionReturns a list of the flaggable object's flags.
Note that this is exclusively for debug/testing reasons, and should never be used in a real script.
See Language:flag system.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L87


Category: QueueTag


Name<QueueTag.commands>
ReturnsListTag
DescriptionReturns a list of commands waiting in the queue.
Generated Example
- foreach <queue.commands> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L248

Name<QueueTag.definition[<definition>]>
ReturnsObjectTag
DescriptionReturns the value of the specified definition.
Returns null if the queue lacks the definition.
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L306

Name<QueueTag.definition_map>
ReturnsMapTag
DescriptionReturns a map of all definitions on the queue.
Generated Example
- foreach <queue.definition_map> key:key as:val:
    - narrate "<[key]> is set as <[val]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L296

Name<QueueTag.definitions>
ReturnsListTag
DescriptionReturns the names of all definitions that were added to the current queue.
Generated Example
- foreach <queue.definitions> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L286

Name<QueueTag.determination>
ReturnsListTag
DescriptionReturns the values that have been determined via Command:Determine
for this queue, or null if there is none.
Generated Example
- foreach <queue.determination> as:entry:
    - narrate "found <[entry]>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L317

Name<QueueTag.id>
ReturnsElementTag
DescriptionReturns the full textual id of the queue.
Generated Example
- narrate <queue.id>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L147

Name<QueueTag.is_valid>
ReturnsElementTag(Boolean)
DescriptionReturns true if the queue has not yet stopped.
Generated Example
- if <queue.is_valid>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L202

Name<QueueTag.last_command>
ReturnsElementTag
DescriptionReturns the last command executed in this queue (if any).
Generated Example
- narrate <queue.last_command>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L267

Name<QueueTag.npc>
ReturnsNPCTag
MechanismQueueTag.linked_npc
DescriptionReturns the NPCTag linked to a queue.
Generated Example
- walk <queue.npc> <player.location>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitQueueExtensions.java#L13

Name<QueueTag.numeric_id>
ReturnsElementTag(Number)
DescriptionReturns the raw numeric id of the queue. This is an incremental ID one higher than the previous queue's numeric ID.
Generated Example
- narrate "the number value is <queue.numeric_id>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L157

Name<QueueTag.player>
ReturnsPlayerTag
MechanismQueueTag.linked_player
DescriptionReturns the PlayerTag linked to a queue.
Generated Example
- heal <queue.player>
Sourcehttps://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitQueueExtensions.java#L34

Name<QueueTag.script>
ReturnsScriptTag
DescriptionReturns the script that started this queue.
Generated Example
- narrate <queue.script>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L235

Name<QueueTag.size>
ReturnsElementTag(Number)
DescriptionReturns the number of script entries in the queue.
Generated Example
- narrate "the number value is <queue.size>"
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L167

Name<QueueTag.speed>
ReturnsDurationTag
DescriptionReturns the speed of the queue as a Duration. A return of '0' implies it is 'instant'.
This is largely considered historical - most queues now default to instant.
Generated Example
- ratelimit <player> <queue.speed>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L333

Name<QueueTag.started_time>
ReturnsTimeTag
DescriptionReturns the time this queue started as a duration.
Generated Example
- flag server myflag expire:<queue.started_time>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L177

Name<QueueTag.state>
ReturnsElementTag
DescriptionReturns 'stopping', 'running', 'paused', or 'unknown'.
Generated Example
- narrate <queue.state>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L212

Name<QueueTag.time_ran>
ReturnsDurationTag
DescriptionReturns the time this queue has ran for (the length of time between now and when the queue started) as a duration.
Generated Example
- ratelimit <player> <queue.time_ran>
Sourcehttps://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/QueueTag.java#L191