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 14 out of 2465 tags...

Categories:

AreaShopTag | NPCTag | PlayerTag | WorldGuardRegionTag


Category: AreaShopTag


Name<AreaShopTag.worldguard_region>
ReturnsWorldGuardRegionTag
DescriptionReturns the WorldGuardRegionTag that holds the AreaShop.
RequiresDepenizen, AreaShop
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L200


Category: NPCTag


Name<NPCTag.worldguard_wander_region>
ReturnsWorldGuardRegionTag
MechanismNPCTag.worldguard_wander_region
DescriptionIf the NPC's waypoint provider is set to wander (Tag:NPCTag.waypoint_provider),
returns the current WorldGuard region that wandering is restricted to, if any.
Generated Example
- narrate <npc.worldguard_wander_region>
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardNPCExtensions.java#L13


Category: PlayerTag


Name<PlayerTag.worldguard_can_build[<location>]>
ReturnsElementTag(Boolean)
DescriptionWhether WorldGuard allows to build at a location.
Generated Example
- if <player.worldguard_can_build[<npc.location>]>:
    - narrate "it was true!"
- else:
    - narrate "it was false!"
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerExtensions.java#L98

Name<PlayerTag.worldguard_flag[flag=<flag>(;location=<at>)]>
ReturnsObjectTag
DescriptionReturns 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
# Returns 'true' if the player can be attacked (according to WG) or 'false' if not.
- narrate <player.worldguard_flag[flag=pvp]>
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerExtensions.java#L110

Name<PlayerTag.worldguard.can_build[<location>]>
ReturnsElementTag(Boolean)
DescriptionDeprecated in favor of Tag:PlayerTag.worldguard_can_build
RequiresDepenizen, WorldGuard
DeprecatedUse 'PlayerTag.worldguard_can_build'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerExtensions.java#L32

Name<PlayerTag.worldguard.test_flag[<name>]>
ReturnsObjectTag
DescriptionDeprecated in favor of Tag:PlayerTag.worldguard_flag
RequiresDepenizen, WorldGuard
DeprecatedUse 'PlayerTag.worldguard_flag'
Sourcehttps://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>]>
ReturnsObjectTag
DescriptionDeprecated in favor of Tag:PlayerTag.worldguard_flag
RequiresDepenizen, WorldGuard
DeprecatedUse 'PlayerTag.worldguard_flag'
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerExtensions.java#L70


Category: WorldGuardRegionTag


Name<WorldGuardRegionTag.children>
ReturnsListTag(WorldGuardRegionTag)
DescriptionGets a list of all children of this region.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L208

Name<WorldGuardRegionTag.id>
ReturnsElementTag
DescriptionGets the ID name of the region.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L185

Name<WorldGuardRegionTag.members>
ReturnsListTag(PlayerTag)
DescriptionGets a list of all members of a region. (Members are permitted to build, etc.)
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L226

Name<WorldGuardRegionTag.owners>
ReturnsListTag(PlayerTag)
DescriptionGets a list of all owners of a region. (Owners are permitted to build, edit settings, etc.)
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L241

Name<WorldGuardRegionTag.parent>
ReturnsWorldGuardRegionTag
DescriptionGets the parent region of this region (if any).
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L196

Name<WorldGuardRegionTag.world>
ReturnsWorldTag
DescriptionGets the WorldTag this region is in.
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L256

Name<WorldGuardRegionTag.area>
ReturnsAreaObject
DescriptionReturns the region's block area as a CuboidTag or PolygonTag.
Groupconversion
RequiresDepenizen, WorldGuard
Sourcehttps://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L151