| Name | <AreaObject.blocks_flagged[<flag_name>]> |
| Returns | ListTag(LocationTag) |
| Description | Gets a list of all block locations with a specified flag within the area.
Searches the internal flag lists, rather than through all possible blocks. |
| Example | |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L280 |
| Name | <ChunkTag.blocks_flagged[<flag_name>]> |
| Returns | ListTag(LocationTag) |
| Description | Gets a list of all block locations with a specified flag within the CuboidTag.
Searches the internal flag lists, rather than through all possible blocks. |
| Example | |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L716 |
| Name | <FlaggableObject.flag[<flag_name>]> |
| Returns | ObjectTag |
| Description | Returns the specified flag from the flaggable object.
If the flag is expired, will return null. Consider also using FlaggableObject.has_flag. See flag system. |
| Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L37 |
| Name | <FlaggableObject.flag_expiration[<flag_name>]> |
| Returns | TimeTag |
| Description | Returns a TimeTag indicating when the specified flag will expire.
See flag system. |
| Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L71 |
| Name | <FlaggableObject.flag_map[<name>|...]> |
| Returns | MapTag |
| Description | Returns 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 flag system. |
| Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L104 |
| Name | <FlaggableObject.has_flag[<flag_name>]> |
| Returns | ElementTag(Boolean) |
| Description | Returns true if the flaggable object has the specified flag, otherwise returns false.
See flag system. |
| Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L55 |
| Name | <FlaggableObject.list_flags> |
| Returns | ListTag |
| Description | Returns 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 flag system. |
| Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/AbstractFlagTracker.java#L87 |
| Name | <server.npcs_flagged[<flag_name>]> |
| Returns | ListTag(NPCTag) |
| Description | Returns a list of all NPCs with a specified flag set.
Can use "!<flag_name>" style to only return NPCs *without* the flag. |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2396 |
| Name | <server.online_players_flagged[<flag_name>]> |
| Returns | ListTag(PlayerTag) |
| Description | Returns a list of all online players with a specified flag set.
Can use "!<flag_name>" style to only return players *without* the flag. |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1312 |
| Name | <server.players_flagged[<flag_name>]> |
| Returns | ListTag(PlayerTag) |
| Description | Returns a list of all players (online or offline) with a specified flag set.
Warning: this will cause the player flag cache to temporarily fill with ALL historical playerdata. Can use "!<flag_name>" style to only return players *without* the flag. |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1337 |
| Name | <server.spawned_npcs_flagged[<flag_name>]> |
| Returns | ListTag(NPCTag) |
| Description | Returns a list of all spawned NPCs with a specified flag set.
Can use "!<flag_name>" style to only return NPCs *without* the flag. |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L2371 |
| Name | <LocationTag.find_blocks_flagged[<flag_name>].within[<#>]> |
| Returns | ListTag(LocationTag) |
| Description | Returns a list of blocks that have the specified flag within a radius.
Note: current implementation measures the center of nearby block's distance from the exact given location. Result list is sorted by closeness (1 = closest, 2 = next closest, ... last = farthest). Searches the internal flag lists, rather than through all possible blocks. |
| Group | finding |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2608 |
| Name | <ItemTag.with_flag[<flag_set_action>]> |
| Returns | ItemTag |
| Mechanism | ItemTag.flag |
| Description | Returns a copy of the item with the specified flag data action applied to it.
For example: <[item].with_flag[myflagname]>, or <[item].with_flag[myflag:myvalue]>, or <[item].with_flag[mycounter:+:<[amount]>]> |
| Group | properties |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFlags.java#L53 |
| Name | <ItemTag.with_flag[<flag_set_action>].duration[<expire_duration>]> |
| Returns | ItemTag |
| Mechanism | ItemTag.flag |
| Description | Returns a copy of the item with the specified flag data action (and the specified expiration duration) applied to it.
For example: <[item].with_flag[myflagname].duration[5m]> |
| Group | properties |
| Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemFlags.java#L68 |
| Name | <PlayerTag.worldguard_flag[flag=<flag>(;location=<at>)]> |
| Returns | ObjectTag |
| Description | Returns the boolean state of a flag for that player at the specified location, defaults to player location.
For non-state tags, returns the current value of the flag. |
| Example | |
| Requires | Depenizen, WorldGuard |
| Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerExtensions.java#L110 |
| Name | <PlayerTag.worldguard.test_flag[<name>]> |
| Returns | ObjectTag |
| Description | Deprecated in favor of PlayerTag.worldguard_flag |
| Requires | Depenizen, WorldGuard |
| Deprecated | Use 'PlayerTag.worldguard_flag' |
| Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerExtensions.java#L51 |
| Name | <PlayerTag.worldguard.test_flag[<name>].at[<location>]> |
| Returns | ObjectTag |
| Description | Deprecated in favor of PlayerTag.worldguard_flag |
| Requires | Depenizen, WorldGuard |
| Deprecated | Use 'PlayerTag.worldguard_flag' |
| Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerExtensions.java#L70 |