world
out of 3884 meta-documentation entries...Name | <world[<world>]> |
Returns | WorldTag |
Description | Returns a world object constructed from the input value.
Refer to WorldTag. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L358 |
Name | CreateWorld |
Syntax | createworld [<name>] (generator:<id>) (worldtype:<type>) (environment:<environment>) (copy_from:<world>) (seed:<seed>) (settings:<json>) (generate_structures:true/false) |
Short Description | Creates a new world, or loads an existing world. |
Full Description | This command creates a new minecraft world with the specified name, or loads an existing world by that name.
Optionally specify a plugin-based world generator by its generator ID. If you want an empty void world with a void biome, you can use "denizen:void". If you want an empty void world with vanilla biomes, you can use "denizen:void_biomes". Optionally specify additional generator settings as JSON input. Optionally specify a world type which can be specified with 'worldtype:' (defaults to NORMAL). For all world types, see: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldType.html Optionally specify an environment (defaults to NORMAL, can also be NETHER, THE_END). Optionally choose whether to generate structures in this world. Optionally specify an existing world to copy files from. The 'copy_from' argument is ~waitable. Refer to ~waitable. It's often ideal to put this command inside server prestart. |
Related Tags | <server.world_types> Returns a list of all world types known to the server. (...)
<server.worlds> Returns a list of all worlds.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | loadworld |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/CreateWorldCommand.java#L35 |
Name | WorldBorder |
Syntax | worldborder [<world>/<player>|...] (center:<location>) (size:<#.#>) (current_size:<#.#>) (damage:<#.#>) (damagebuffer:<#.#>) (warningdistance:<#>) (warningtime:<duration>) (duration:<duration>) (reset) |
Short Description | Modifies a world border. |
Full Description | Modifies the world border of a specified world or a list of players.
NOTE: Modifying player world borders is client-side and will reset on death, relog, or other actions. Options are: center: Sets the center of the world border. size: Sets the new size of the world border. current_size: Sets the initial size of the world border when resizing it over a duration. damage: Sets the amount of damage a player takes when outside the world border buffer radius. damagebuffer: Sets the radius a player may safely be outside the world border before taking damage. warningdistance: Causes the screen to be tinted red when the player is within the specified radius from the world border. warningtime: Causes the screen to be tinted red when a contracting world border will reach the player within the specified time. duration: Causes the world border to grow or shrink from its current size to its new size over the specified duration. reset: Resets the world border to its vanilla defaults for a world, or to the current world border for players. |
Related Tags | <LocationTag.is_within_border> Returns whether the location is within the world border.
<WorldTag.border_size> Returns the size of the world border in this world.
<WorldTag.border_center> Returns the center of the world border in this world.
<WorldTag.border_damage> Returns the amount of damage caused by crossing the world border in this world.
<WorldTag.border_damage_buffer> Returns the damage buffer of the world border in this world.
<WorldTag.border_warning_distance> Returns the warning distance of the world border in this world.
<WorldTag.border_warning_time> Returns warning time of the world border in this world as a duration.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/WorldBorderCommand.java#L28 |
Name | worldedit |
Syntax | worldedit [create_schematic/copy_to_clipboard/paste] (file:<file path>) (cuboid:<cuboid>) (position:<location>) (rotate:<#>) (undoable) (noair) |
Short Description | Controls schematics and clipboards in WorldEdit. |
Full Description | Controls schematics and clipboards in WorldEdit. You should almost always use schematic instead of this.
The action can be create_schematic, copy_to_clipboard, or paste. For 'paste': Specify 'noair' to exclude air blocks. Specify 'rotate' to rotate the schematic when pasting it. Specify 'undoable' to attach the paste to the player's WorldEdit history which allows them to undo/redo. For 'copy_to_clipboard': Specify either a cuboid or a file. The file path starts in the folder: /plugins/Denizen/schematics/ For 'create_schematic': Either specify a cuboid, or the player's clipboard will be used. Specify a file to save to. |
Related Tags | <PlayerTag.we_selection> Returns the player's current block area selection, as a CuboidTag, EllipsoidTag, or PolygonTag.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | Depenizen |
Requires | Depenizen, WorldEdit |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/commands/worldedit/WorldEditCommand.java#L44 |
Name | entity added to world |
Event Lines | <entity> added to world |
Triggers | any time an entity is added to the world for any reason, including chunks loading pre-existing entities. |
Generated Examples | after player added to world:
after projectile added to world: |
Contexts | <context.entity> returns the EntityTag that will be added. Note that this entity will not necessarily be fully spawned yet, so usage will be limited.
<context.location> returns the LocationTag that the entity will be added at.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/events/EntityAddToWorldScriptEvent.java#L15 |
Name | entity removed from world |
Event Lines | <entity> removed from world |
Triggers | any time an entity is removed from the world for any reason, including chunks unloading. |
Generated Examples | after entity removed from world:
on arrow removed from world: |
Contexts | <context.entity> returns the EntityTag that will be removed. Note that this entity will not necessarily be fully spawned at time of firing, so usage will be limited.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/events/EntityRemoveFromWorldScriptEvent.java#L14 |
Name | world initializes |
Event Lines | <world> initializes |
Triggers | when a world is initialized. |
Generated Examples | after world initializes: |
Contexts | <context.world> returns the WorldTag that was initialized.
|
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/WorldInitsScriptEvent.java#L12 |
Name | world loads |
Event Lines | <world> loads |
Triggers | when a world is loaded. |
Generated Examples | on world_nether loads:
after world_nether loads: |
Contexts | <context.world> returns the WorldTag that was loaded.
|
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/WorldLoadsScriptEvent.java#L12 |
Name | world saves |
Event Lines | <world> saves |
Triggers | when a world is saved. |
Generated Examples | after world saves: |
Contexts | <context.world> returns the WorldTag that was saved.
|
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/WorldSavesScriptEvent.java#L12 |
Name | world unloads |
Event Lines | <world> unloads |
Triggers | when a world is unloaded. |
Generated Examples | after world unloads:
after survivalland unloads: |
Contexts | <context.world> returns the WorldTag that was unloaded.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/WorldUnloadsScriptEvent.java#L12 |
Name | gamerule changes in world |
Event Lines | gamerule changes (in <world>) |
Triggers | when a gamerule changes. |
Generated Examples | on gamerule changes: |
Has Player | when the sender of the command is a player. - this adds switches 'flagged:<flag name>' + 'permission:<node>', in addition to the '<player>' link. |
Switches | gamerule:<gamerule> to only process the event if the gamerule matches a specific gamerule. |
Contexts | <context.gamerule> returns the name of the GameRule which was changed. Refer to https://jd.papermc.io/paper/1.19/org/bukkit/GameRule.html.
<context.value> returns the new value of the GameRule.
<context.world> returns the world where the GameRule is applied.
<context.source_type> returns type of source. Can be: PLAYER, COMMAND_BLOCK, COMMAND_MINECART, SERVER.
<context.command_block_location> returns the command block's location (if the command was run from one).
<context.command_minecart> returns the EntityTag of the command minecart (if the command was run from one).
|
Determine | "VALUE:<ElementTag(Number)>" or ElementTag(Boolean) to set the value of the GameRule. |
Group | Paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/events/WorldGameRuleChangeScriptEvent.java#L25 |
Name | player changes world from world to world |
Event Lines | player changes world (from <world>) (to <world>) |
Triggers | when a player moves to a different world. |
Generated Examples | after player changes world from world to world:
after player changes world from world: |
Has Player | Always. - this adds switches 'flagged:<flag name>' + 'permission:<node>', in addition to the '<player>' link. |
Contexts | <context.origin_world> returns the WorldTag that the player was previously on.
<context.destination_world> returns the WorldTag that the player is now in.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Player |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/player/PlayerChangesWorldScriptEvent.java#L15 |
Name | time changes in world |
Event Lines | time changes (in <world>)
time <0-23> (in <world>) |
Triggers | when the current time changes in a world (once per mine-hour). |
Generated Examples | after time changes:
after time 0-23: on time changes: on time 0-23 in world: |
Contexts | <context.time> returns the current time (the hour, as a number from 0 to 23).
<context.world> returns the world.
|
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/TimeChangeScriptEvent.java#L11 |
Name | weather changes|rains|clears in world |
Event Lines | weather changes|rains|clears (in <world>) |
Triggers | when weather changes in a world. |
Generated Examples | after weather rains:
after weather changes in world: |
Contexts | <context.world> returns the WorldTag the weather changed in.
<context.weather> returns an ElementTag with the name of the new weather (rains or clears).
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/WeatherChangesScriptEvent.java#L13 |
Name | World Script Containers |
Description | World script containers are generic script containers for commands that are automatically
ran when some given event happens in the server. The only required key is 'events:', within which you can list any events to handle. World scripts can be automatically disabled by adding "enabled: false" as a root key (supports any load-time-parseable tags).
|
Group | Script Container System |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/containers/core/WorldScriptContainer.java#L9 |
Name | worldguard_wander_region |
Object | NPCTag |
Input | WorldGuardRegionTag |
Related Tags | <NPCTag.worldguard_wander_region> If the NPC's waypoint provider is set to wander (NPCTag.waypoint_provider), (...)
|
Description | If the NPC's waypoint provider is set to wander (NPCTag.waypoint_provider),
sets the current WorldGuard region that wandering is restricted to. Provide no input to remove the region restriction. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardNPCExtensions.java#L34 |
Name | advance_ticks |
Object | WorldTag |
Input | ElementTag(Number) |
Description | Advances this world's day the specified number of ticks WITHOUT firing any events.
Useful for manually adjusting the daylight cycle without firing an event every tick, for example. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1437 |
Name | allow_pvp |
Object | WorldTag |
Input | ElementTag(Boolean) |
Related Tags | <WorldTag.allows_pvp> Returns whether player versus player combat is allowed in this world.
|
Description | Sets whether player versus player combat is allowed in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1294 |
Name | ambient_spawn_limit |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.ambient_spawn_limit> Returns the number of ambient mobs that can spawn in a chunk in this world.
|
Description | Sets the limit for number of ambient mobs that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1133 |
Name | animal_spawn_limit |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.animal_spawn_limit> Returns the number of animals that can spawn in a chunk in this world.
|
Description | Sets the limit for number of animals that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1147 |
Name | auto_save |
Object | WorldTag |
Input | ElementTag(Boolean) |
Related Tags | <WorldTag.auto_save> Returns whether the world automatically saves.
|
Description | Sets whether the world will automatically save edits. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1161 |
Name | destroy |
Object | WorldTag |
Input | None |
Description | Unloads the world from the server without saving chunks, then destroys all data that is part of the world.
Require config setting 'Commands.Delete.Allow file deletion'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1216 |
Name | difficulty |
Object | WorldTag |
Input | ElementTag |
Related Tags | <WorldTag.difficulty> Returns the name of the difficulty level.
|
Description | Sets the difficulty level of this world.
Possible values: Peaceful, Easy, Normal, Hard. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1175 |
Name | duration_since_created |
Object | WorldTag |
Input | DurationTag |
Related Tags | <WorldTag.duration_since_created> Returns the total duration of time since this world was first created.
|
Description | Changes the world's internal time-since-created value. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1450 |
Name | first_dragon_killed |
Object | WorldTag |
Input | ElementTag(Boolean) |
Related Tags | <WorldTag.first_dragon_killed> Returns whether the ender dragon has been killed in this world before. (...)
|
Description | Set whether the first ender dragon was killed already.
Toggling this value won't really affect anything in the end world, but may be useful when creating custom end worlds. Only works if the world is an end world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1084 |
Name | force_unload |
Object | WorldTag |
Input | None |
Description | Unloads the world from the server without saving chunks. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1243 |
Name | full_time |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.time.full> Returns the in-game time of this world.
|
Description | Sets the in-game time on the server. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1255 |
Name | hardcore |
Object | WorldTag |
Input | ElementTag(Boolean) |
Related Tags | <WorldTag.hardcore> Returns whether the world is in hardcore mode.
|
Description | Sets whether the world is hardcore mode. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1192 |
Name | keep_spawn |
Object | WorldTag |
Input | ElementTag(Boolean) |
Related Tags | <WorldTag.keep_spawn> Returns whether the world's spawn area should be kept loaded into memory.
|
Description | Sets whether the world's spawn area should be kept loaded into memory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1268 |
Name | monster_spawn_limit |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.monster_spawn_limit> Returns the number of monsters that can spawn in a chunk in this world.
|
Description | Sets the limit for number of monsters that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1281 |
Name | no_tick_view_distance |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.no_tick_view_distance> Deprecated: replaced by Minecraft's simulation_distance and view_distance config pairing
|
Description | Deprecated: replaced by Minecraft's simulation_distance and view_distance config pairing |
Generated Example |
|
Group | paper |
Requires | Paper |
Deprecated | replaced by Minecraft's simulation_distance and view_distance config pairing |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L166 |
Name | reset_crystals |
Object | WorldTag |
Input | None |
Description | Resets the end crystals located on the obsidian pillars in this world.
Only works if the world is an end world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1046 |
Name | respawn_dragon |
Object | WorldTag |
Input | None |
Description | Initiates the respawn sequence of the ender dragon as if a player placed 4 end crystals on the portal.
Only works if the world is an end world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1029 |
Name | respawn_phase |
Object | WorldTag |
Input | ElementTag |
Description | Set the current respawn phase of the ender dragon. Valid phases can be found at https://jd.papermc.io/paper/1.21.3/org/bukkit/boss/DragonBattle.RespawnPhase.html
Only works if the world is an end world. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1063 |
Name | save |
Object | WorldTag |
Input | None |
Description | Saves the world to file. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1205 |
Name | simulation_distance |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.view_distance> Returns the view distance of this world. Chunks are visible to players inside this radius. (...)
<server.view_distance> Returns the server's current view distance.
|
Description | Sets this world's view distance. All chunks within this radius will be tracked by the server.
Input should be a number from 2 to 32. See also WorldTag.view_distance |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L140 |
Name | skip_night |
Object | WorldTag |
Input | None |
Description | Skips to the next day as if enough players slept through the night.
NOTE: This ignores the doDaylightCycle gamerule! |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1463 |
Name | spawn_gateway |
Object | WorldTag |
Input | LocationTag |
Description | Spawns a new end gateway portal at the specified location.
If no location is specified, tries to spawn a new end gateway using default game mechanics. Only works if the world is an end world. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L88 |
Name | spawn_location |
Object | WorldTag |
Input | LocationTag |
Related Tags | <WorldTag.spawn_location> Returns the spawn location of the world.
|
Description | Sets the spawn location of this world. (This ignores the world value of the LocationTag.) |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1307 |
Name | storming |
Object | WorldTag |
Input | ElementTag(Boolean) |
Related Tags | <WorldTag.has_storm> Returns whether there is currently a storm in this world. (...)
|
Description | Sets whether there is a storm. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1321 |
Name | thunder_duration |
Object | WorldTag |
Input | DurationTag |
Related Tags | <WorldTag.thunder_duration> Returns the duration of thunder.
|
Description | Sets the duration of thunder. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1334 |
Name | thundering |
Object | WorldTag |
Input | ElementTag(Boolean) |
Related Tags | <WorldTag.thundering> Returns whether it is currently thundering in this world.
|
Description | Sets whether it is thundering. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1347 |
Name | ticks_per_animal_spawns |
Object | WorldTag |
Input | DurationTag |
Related Tags | <WorldTag.ticks_per_animal_spawn> Returns the world's ticks per animal spawn value.
|
Description | Sets the time between animal spawns. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1360 |
Name | ticks_per_monster_spawns |
Object | WorldTag |
Input | DurationTag |
Related Tags | <WorldTag.ticks_per_monster_spawn> Returns the world's ticks per monster spawn value.
|
Description | Sets the time between monster spawns. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1373 |
Name | time |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.time> Returns the relative in-game time of this world.
|
Description | Sets the relative in-game time on the server. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1386 |
Name | unload |
Object | WorldTag |
Input | None |
Description | Unloads the world from the server and saves chunks. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1399 |
Name | view_distance |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.view_distance> Returns the view distance of this world. Chunks are visible to players inside this radius. (...)
<server.view_distance> Returns the server's current view distance.
|
Description | Sets this world's view distance. All chunks within this radius of a player will be visible to that player.
Input should be a number from 2 to 32. See also WorldTag.simulation_distance |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L114 |
Name | water_animal_spawn_limit |
Object | WorldTag |
Input | ElementTag(Number) |
Related Tags | <WorldTag.water_animal_spawn_limit> Returns the number of water animals that can spawn in a chunk in this world.
|
Description | Sets the limit for number of water animals that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1411 |
Name | weather_duration |
Object | WorldTag |
Input | DurationTag |
Related Tags | <WorldTag.weather_duration> Returns the duration of storms.
|
Description | Set the remaining time of the current conditions. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1424 |
Name | WorldGuardRegionTag |
Prefix | region@ |
Base Type | ElementTag |
Identity Format | The identity format for regions is <region_name>,<world_name>.
For example, 'region@spawnland,Hub'. |
Description | A WorldGuardRegionTag represents a WorldGuard region in the world. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L31 |
Name | WorldTag |
Prefix | w@ |
Base Type | ElementTag |
Implements | FlaggableObject |
Identity Format | The identity format for worlds is the name of the world it should be associated with.
For example, to reference the world named 'world1', use simply 'world1'. World names are case insensitive. |
Description | A WorldTag represents a world on the server.
This object type is flaggable. Flags on this object type will be stored in the world folder in a file named 'denizen_flags.dat', like "server/world/denizen_flags.dat". |
Matchable | WorldTag matchers, sometimes identified as "<world>":
"world" plaintext: always matches. World name: matches if the world has the given world name, using advanced matchers. "world_flagged:<flag>": a Flag Matchable for WorldTag flags. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L42 |
Name | <AreaObject.with_world[<world>]> |
Returns | AreaObject |
Description | Returns a copy of the area, with the specified world. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L335 |
Name | <AreaObject.world> |
Returns | WorldTag |
Description | Returns the area's world. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L108 |
Name | <AreaShopTag.worldguard_region> |
Returns | WorldGuardRegionTag |
Description | Returns the WorldGuardRegionTag that holds the AreaShop. |
Requires | Depenizen, AreaShop |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/areashop/AreaShopTag.java#L200 |
Name | <ChunkTag.world> |
Returns | WorldTag |
Description | Returns the world associated with the chunk. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L420 |
Name | <ElementTag.as_world> |
Returns | WorldTag |
Description | Deprecated in favor of ObjectTag.as |
Generated Example |
|
Group | conversion |
Deprecated | use as[world] |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/bukkit/BukkitElementExtensions.java#L256 |
Name | <EntityTag.world> |
Returns | WorldTag |
Description | Returns the world the entity is in. Works with offline players. |
Generated Example |
|
Group | location |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1641 |
Name | <GriefPreventionClaimTag.world> |
Returns | WorldTag |
Description | Returns the world this GriefPreventionClaim is in. |
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/griefprevention/GriefPreventionClaimTag.java#L259 |
Name | <LocationTag.distance[<location>].horizontal.multiworld> |
Returns | ElementTag(Decimal) |
Description | Returns the horizontal distance between 2 multiworld locations. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3370 |
Name | <LocationTag.distance[<location>].vertical.multiworld> |
Returns | ElementTag(Decimal) |
Description | Returns the vertical distance between 2 multiworld locations. |
Group | math |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3398 |
Name | <LocationTag.with_world[<world>]> |
Returns | LocationTag |
Description | Returns a copy of the location with a changed world value. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3272 |
Name | <LocationTag.world> |
Returns | WorldTag |
Description | Returns the world that the location is in. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3229 |
Name | <MaterialTag.is_enabled[<world>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the material is enabled in the specified world.
If experimental features are disabled in the given world, and the MaterialTag is an item or block that is only enabled by experimental features, this will return false. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/MaterialTag.java#L679 |
Name | <NPCTag.worldguard_wander_region> |
Returns | WorldGuardRegionTag |
Mechanism | NPCTag.worldguard_wander_region |
Description | If the NPC's waypoint provider is set to wander (NPCTag.waypoint_provider),
returns the current WorldGuard region that wandering is restricted to, if any. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardNPCExtensions.java#L13 |
Name | <PlayerTag.groups[(<world>)]> |
Returns | ListTag |
Description | Returns a list of all groups the player is in.
May work with offline players, depending on permission plugin. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1088 |
Name | <PlayerTag.has_permission[permission.node].world[<world>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the specified node in regards to the
specified world. (Works with offline players) (Note: This may or may not be functional with your permissions system.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1341 |
Name | <PlayerTag.in_group[<group_name>].world[<world>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the group in regards to a specific world.
(Works with offline players) (Note: This may or may not be functional with your permissions system.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1276 |
Name | <PlayerTag.plotsquared_plots[<WorldTag>]> |
Returns | ListTag(PlotSquaredPlotTag) |
Description | Returns a list of plots a player has in a world. Exclude the context to get plots in all worlds. |
Generated Example |
|
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/plotsquared/PlotSquaredPlayerProperties.java#L55 |
Name | <PlayerTag.worldguard_can_build[<location>]> |
Returns | ElementTag(Boolean) |
Description | Whether WorldGuard allows to build at a location. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://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>)]> |
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.can_build[<location>]> |
Returns | ElementTag(Boolean) |
Description | Deprecated in favor of PlayerTag.worldguard_can_build |
Requires | Depenizen, WorldGuard |
Deprecated | Use 'PlayerTag.worldguard_can_build' |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardPlayerExtensions.java#L32 |
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 |
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 | <PlotSquaredPlotTag.world> |
Returns | WorldTag |
Description | Returns the plot's world. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L178 |
Name | <server.group_prefix[<group>].world[<world>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat prefix for the specified WorldTag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1171 |
Name | <server.group_suffix[<group>].world[<world>]> |
Returns | ElementTag |
Description | Returns an ElementTag of a group's chat suffix for the specified WorldTag. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1205 |
Name | <server.world_types> |
Returns | ListTag |
Description | Returns a list of all world types known to the server.
Generally used with createworld. This is only their Bukkit enum names, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldType.html. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L944 |
Name | <server.worlds> |
Returns | ListTag(WorldTag) |
Description | Returns a list of all worlds. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1353 |
Name | <skyblock.island_world> |
Returns | WorldTag |
Description | Returns the world that A Skyblock uses for islands. |
Generated Example |
|
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ASkyBlockBridge.java#L51 |
Name | <skyblock.nether_world> |
Returns | WorldTag |
Description | Returns the world that A Skyblock uses for the nether. |
Generated Example |
|
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/ASkyBlockBridge.java#L62 |
Name | <towny.list_towns[(<world>)]> |
Returns | ListTag(TownTag) |
Description | Returns a list of all towns. Optionally specify a world name. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/TownyBridge.java#L68 |
Name | <WorldGuardRegionTag.area> |
Returns | AreaObject |
Description | Returns the region's block area as a CuboidTag or PolygonTag. |
Group | conversion |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L151 |
Name | <WorldGuardRegionTag.children> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Gets a list of all children of this region. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L208 |
Name | <WorldGuardRegionTag.id> |
Returns | ElementTag |
Description | Gets the ID name of the region. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L185 |
Name | <WorldGuardRegionTag.members> |
Returns | ListTag(PlayerTag) |
Description | Gets a list of all members of a region. (Members are permitted to build, etc.) |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L226 |
Name | <WorldGuardRegionTag.owners> |
Returns | ListTag(PlayerTag) |
Description | Gets a list of all owners of a region. (Owners are permitted to build, edit settings, etc.) |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L241 |
Name | <WorldGuardRegionTag.parent> |
Returns | WorldGuardRegionTag |
Description | Gets the parent region of this region (if any). |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L196 |
Name | <WorldGuardRegionTag.world> |
Returns | WorldTag |
Description | Gets the WorldTag this region is in. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/worldguard/WorldGuardRegionTag.java#L256 |
Name | <WorldTag.allows_animals> |
Returns | ElementTag(Boolean) |
Description | Returns whether animals can spawn in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L449 |
Name | <WorldTag.allows_monsters> |
Returns | ElementTag(Boolean) |
Description | Returns whether monsters can spawn in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L459 |
Name | <WorldTag.allows_pvp> |
Returns | ElementTag(Boolean) |
Description | Returns whether player versus player combat is allowed in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L469 |
Name | <WorldTag.ambient_spawn_limit> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.ambient_spawn_limit |
Description | Returns the number of ambient mobs that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L490 |
Name | <WorldTag.animal_spawn_limit> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.animal_spawn_limit |
Description | Returns the number of animals that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L501 |
Name | <WorldTag.auto_save> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.auto_save |
Description | Returns whether the world automatically saves. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L479 |
Name | <WorldTag.bigdoors> |
Returns | ListTag(BigDoorsDoorTag) |
Description | Returns a list of Big Doors doors in the world. |
Generated Example |
|
Requires | Depenizen, Big Doors |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/bigdoors/BigDoorsWorldProperties.java#L48 |
Name | <WorldTag.biomes> |
Returns | ListTag(BiomeTag) |
Description | Returns a list of all biomes in this world (including custom biomes). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L890 |
Name | <WorldTag.border_center> |
Returns | LocationTag |
Description | Returns the center of the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L748 |
Name | <WorldTag.border_damage_buffer> |
Returns | ElementTag(Decimal) |
Description | Returns the damage buffer of the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L768 |
Name | <WorldTag.border_damage> |
Returns | ElementTag(Decimal) |
Description | Returns the amount of damage caused by crossing the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L758 |
Name | <WorldTag.border_size> |
Returns | ElementTag(Decimal) |
Description | Returns the size of the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L738 |
Name | <WorldTag.border_warning_distance> |
Returns | ElementTag(Number) |
Description | Returns the warning distance of the world border in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L778 |
Name | <WorldTag.border_warning_time> |
Returns | DurationTag |
Description | Returns warning time of the world border in this world as a duration. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L788 |
Name | <WorldTag.can_generate_structures> |
Returns | ElementTag(Boolean) |
Description | Returns whether the world will generate structures. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L344 |
Name | <WorldTag.difficulty> |
Returns | ElementTag |
Mechanism | WorldTag.difficulty |
Description | Returns the name of the difficulty level. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L534 |
Name | <WorldTag.dragon_portal_location> |
Returns | LocationTag |
Description | Returns the location of the ender dragon exit portal, if any (only for end worlds). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L832 |
Name | <WorldTag.duration_since_created> |
Returns | DurationTag |
Mechanism | WorldTag.duration_since_created |
Description | Returns the total duration of time since this world was first created. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L589 |
Name | <WorldTag.ender_dragon> |
Returns | EntityTag |
Description | Returns the ender dragon entity currently fighting in this world, if any (only for end worlds). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L850 |
Name | <WorldTag.enough_deep_sleeping[(<#>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether enough players have been in bed long enough for the night to advance (generally 100 ticks).
Loops through all online players, so is typically used after checking WorldTag.enough_sleeping By default, automatically checks the playersSleepingPercentage gamerule, but this can optionally be overridden by specifying a percentage integer. Any integer above 100 will always yield 'false'. Requires at least one player to be sleeping to return 'true'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L953 |
Name | <WorldTag.enough_sleeping[(<#>)]> |
Returns | ElementTag(Boolean) |
Description | Returns whether enough players are sleeping to prepare for the night to advance.
Typically used before checking WorldTag.enough_deep_sleeping By default, automatically checks the playersSleepingPercentage gamerule, but this can optionally be overridden by specifying a percentage integer. Any integer above 100 will always yield 'false'. Requires at least one player to be sleeping to return 'true'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L932 |
Name | <WorldTag.entities[(<matcher>)]> |
Returns | ListTag(EntityTag) |
Description | Returns a list of entities in this world.
Optionally specify an entity type matcher to filter down to. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L252 |
Name | <WorldTag.environment> |
Returns | ElementTag |
Description | Returns the environment of the world: NORMAL, NETHER, or THE_END. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L724 |
Name | <WorldTag.first_dragon_killed> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.first_dragon_killed |
Description | Returns whether the ender dragon has been killed in this world before.
Only works if the world is an end world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L1012 |
Name | <WorldTag.gamerule_map> |
Returns | MapTag |
Description | Returns a map of all the current values of all gamerules in the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L815 |
Name | <WorldTag.gamerule[<gamerule>]> |
Returns | ElementTag |
Description | Returns the current value of the specified gamerule in the world.
Note that the name is case-sensitive... so "doFireTick" is correct, but "dofiretick" is not. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L798 |
Name | <WorldTag.gateway_count> |
Returns | ElementTag(Number) |
Description | Returns the number of end gateway portals.
Only works if the world is an end world. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L34 |
Name | <WorldTag.gateway_locations> |
Returns | ListTag(LocationTag) |
Description | Returns a list of possible gateway portal locations, if any (only for end worlds).
Not all of these will necessarily generate. In current implementation, this is a list of exactly 20 locations in a circle around the world origin (with radius of 96 blocks). |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L867 |
Name | <WorldTag.griefprevention_claims> |
Returns | ListTag(GriefPreventionClaimTag) |
Description | Returns a list of GriefPreventionClaim in this world. |
Generated Example |
|
Requires | Depenizen, GriefPrevention |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/griefprevention/GriefPreventionWorldProperties.java#L49 |
Name | <WorldTag.hardcore> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.hardcore |
Description | Returns whether the world is in hardcore mode. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L545 |
Name | <WorldTag.has_region[<name>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether a region exists in this world for the given name. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardWorldExtensions.java#L29 |
Name | <WorldTag.has_storm> |
Returns | ElementTag(Boolean) |
Description | Returns whether there is currently a storm in this world.
ie, whether it is raining. To check for thunder, use WorldTag.thundering. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L680 |
Name | <WorldTag.healing_crystals> |
Returns | ListTag(EntityTag) |
Description | Returns a ListTag of the healing end crystals located on top of the obsidian towers.
Only works if the world is an end world. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L52 |
Name | <WorldTag.is_day> |
Returns | ElementTag(Boolean) |
Description | Returns whether it is considered day in this world. Players are not allowed to sleep at this time.
Note that in certain worlds, this and WorldTag.is_night can both be 'false'! (The nether, for example!) In typical worlds, this is 'true' if WorldTag.sky_darkness is less than 4. To check the current time without storm interference, see WorldTag.time and related tags. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L986 |
Name | <WorldTag.is_night> |
Returns | ElementTag(Boolean) |
Description | Returns whether it is considered night in this world. Players are typically allowed to sleep at this time.
Note that in certain worlds, this and WorldTag.is_day can both be 'false'! (The nether, for example!) In typical worlds, this is 'true' if WorldTag.sky_darkness is 4 or higher. To check the current time without storm interference, see WorldTag.time and related tags. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L999 |
Name | <WorldTag.is_skyblock_world> |
Returns | ElementTag(Boolean) |
Description | Returns whether the world is used by A SkyBlock. |
Generated Example |
|
Requires | Depenizen, A SkyBlock |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/askyblock/ASkyBlockWorldProperties.java#L61 |
Name | <WorldTag.keep_spawn> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.keep_spawn |
Description | Returns whether the world's spawn area should be kept loaded into memory. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L556 |
Name | <WorldTag.list_regions> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Returns a list of WorldGuard regions in this world. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardWorldExtensions.java#L14 |
Name | <WorldTag.living_entities> |
Returns | ListTag(EntityTag) |
Description | Returns a list of living entities in this world.
This includes Players, mobs, NPCs, etc., but excludes dropped items, experience orbs, etc. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L271 |
Name | <WorldTag.loaded_chunks> |
Returns | ListTag(ChunkTag) |
Description | Returns a list of all the currently loaded chunks. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L354 |
Name | <WorldTag.max_height> |
Returns | ElementTag(Number) |
Description | Returns the maximum block height of the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L379 |
Name | <WorldTag.min_height> |
Returns | ElementTag(Number) |
Description | Returns the minimum block height of the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L389 |
Name | <WorldTag.monster_spawn_limit> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.monster_spawn_limit |
Description | Returns the number of monsters that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L512 |
Name | <WorldTag.moon_phase> |
Returns | ElementTag(Number) |
Description | Returns the current phase of the moon, as a number from 1 to 8. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L666 |
Name | <WorldTag.name> |
Returns | ElementTag |
Description | Returns the name of the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L425 |
Name | <WorldTag.no_tick_view_distance> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.no_tick_view_distance |
Description | Deprecated: replaced by Minecraft's simulation_distance and view_distance config pairing |
Generated Example |
|
Group | paper |
Requires | Paper |
Deprecated | replaced by Minecraft's simulation_distance and view_distance config pairing |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L17 |
Name | <WorldTag.npcs> |
Returns | ListTag(NPCTag) |
Description | Returns a list of all NPCs in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L319 |
Name | <WorldTag.players> |
Returns | ListTag(PlayerTag) |
Description | Returns a list of online players in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L286 |
Name | <WorldTag.respawn_crystals> |
Returns | ListTag(EntityTag) |
Description | Returns a ListTag of the respawn end crystals located at the end exit portal.
Only works if the world is an end world. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperWorldExtensions.java#L70 |
Name | <WorldTag.sea_level> |
Returns | ElementTag(Number) |
Description | Returns the level of the sea. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L369 |
Name | <WorldTag.seed> |
Returns | ElementTag |
Description | Returns the world seed. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L435 |
Name | <WorldTag.simulation_distance> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.simulation_distance |
Description | Returns the simulation distance of this world. Chunks inside of this radius to players are ticked and processed.
See also WorldTag.view_distance |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L918 |
Name | <WorldTag.sky_darkness> |
Returns | ElementTag(Number) |
Description | Returns the current darkness level of the sky in this world.
This is determined by an equation that factors in rain, thunder, and time of day. When 4 or higher, players are typically allowed to sleep through the night. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L974 |
Name | <WorldTag.spawn_location> |
Returns | LocationTag |
Mechanism | WorldTag.spawn_location |
Description | Returns the spawn location of the world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L399 |
Name | <WorldTag.spawned_npcs> |
Returns | ListTag(NPCTag) |
Description | Returns a list of spawned NPCs in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L302 |
Name | <WorldTag.thunder_duration> |
Returns | DurationTag |
Mechanism | WorldTag.thunder_duration |
Description | Returns the duration of thunder. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L691 |
Name | <WorldTag.thundering> |
Returns | ElementTag(Boolean) |
Mechanism | WorldTag.thundering |
Description | Returns whether it is currently thundering in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L702 |
Name | <WorldTag.ticks_per_animal_spawn> |
Returns | DurationTag |
Mechanism | WorldTag.ticks_per_animal_spawns |
Description | Returns the world's ticks per animal spawn value. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L567 |
Name | <WorldTag.ticks_per_monster_spawn> |
Returns | DurationTag |
Mechanism | WorldTag.ticks_per_monster_spawns |
Description | Returns the world's ticks per monster spawn value. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L578 |
Name | <WorldTag.time.duration> |
Returns | DurationTag |
Description | Returns the relative in-game time of this world as a duration. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L612 |
Name | <WorldTag.time.full> |
Returns | DurationTag |
Description | Returns the in-game time of this world. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L623 |
Name | <WorldTag.time.period> |
Returns | ElementTag |
Description | Returns the time as 'day', 'night', 'dawn', or 'dusk'. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L634 |
Name | <WorldTag.time> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.time |
Description | Returns the relative in-game time of this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L604 |
Name | <WorldTag.towny_enabled> |
Returns | ElementTag(Boolean) |
Description | Returns whether this world has Towny enabled. |
Generated Example |
|
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/towny/TownyWorldProperties.java#L51 |
Name | <WorldTag.view_distance> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.view_distance |
Description | Returns the view distance of this world. Chunks are visible to players inside this radius.
See also WorldTag.simulation_distance |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L904 |
Name | <WorldTag.water_animal_spawn_limit> |
Returns | ElementTag(Number) |
Mechanism | WorldTag.water_animal_spawn_limit |
Description | Returns the number of water animals that can spawn in a chunk in this world. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L523 |
Name | <WorldTag.weather_duration> |
Returns | DurationTag |
Mechanism | WorldTag.weather_duration |
Description | Returns the duration of storms. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L713 |
Name | <WorldTag.world_type> |
Returns | ElementTag |
Description | Returns the world type of the world.
Can return any enum from: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/WorldType.html |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java#L410 |
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.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.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 | AnimateChest |
Syntax | animatechest [<location>] ({open}/close) (sound:{true}/false) (<player>|...) |
Short Description | Makes a chest appear to open or close. |
Full Description | This command animates a chest at a specified location in the world opening or closing.
By default, the chest will animate opening. Optionally, specify whether to play a sound with the animation. By default this will play. Optionally, specify a player or list of players that the animation should be visible to. By default, only the linked player can see the animation. Note that this uses a generic 'block action' packet internally, which means other block types may also react to this command. |
Related Tags | None
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/AnimateChestCommand.java#L30 |
Name | ChunkLoad |
Syntax | chunkload ({add}/remove/removeall) [<chunk>|...] (duration:<value>) |
Short Description | Keeps a chunk actively loaded and allowing activity. |
Full Description | Forces a chunk to load and stay loaded in the world for the duration specified or until removed.
This will not persist over server restarts. If no duration is specified it defaults to 0 (forever). While a chunk is loaded all normal activity such as crop growth and npc activity continues, other than activity that requires a nearby player. |
Related Tags | <WorldTag.loaded_chunks> Returns a list of all the currently loaded chunks.
<ChunkTag.is_loaded> Returns true if the chunk is currently loaded into memory.
<ChunkTag.force_loaded> Returns whether the chunk is forced to stay loaded at all times.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/ChunkLoadCommand.java#L41 |
Name | CopyBlock |
Syntax | copyblock [<location>] [to:<location>] (remove_original) |
Short Description | Copies a block to another location, keeping metadata when possible. |
Full Description | Copies a block to another location.
You may also use the 'remove_original' argument to delete the original block. This effectively moves the block to the target location. |
Related Tags | <LocationTag.material> Returns the material of the block at the location.
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/CopyBlockCommand.java#L29 |
Name | Drop |
Syntax | drop [<entity_type>/xp/<item>|...] (<location>) (quantity:<#>) (speed:<#.#>) (delay:<duration>) |
Short Description | Drops an item, entity, or experience orb on a location. |
Full Description | To drop an item, just specify a valid item object. To drop an entity, specify a generic entity object.
Drop can also reward players with experience orbs by using the 'xp' argument. For all three usages, you can optionally specify an integer with 'quantity:' prefix to drop multiple items/entities/xp. For items, you can add 'speed:' to modify the launch velocity. You can also add 'delay:' to set the pickup delay of the item. |
Related Tags | <entry[saveName].dropped_entities> returns a list of entities that were dropped.
<entry[saveName].dropped_entity> returns a single entity that was dropped (if only one).
<EntityTag.item> (Property) An entity's item, which can be: (...)
<EntityTag.experience> Returns the experience value of this experience orb entity.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/DropCommand.java#L34 |
Name | Explode |
Syntax | explode (power:<#.#>) (<location>) (fire) (breakblocks) (source:<entity>) |
Short Description | Causes an explosion at the location. |
Full Description | This command causes an explosion at the location specified (or the npc / player location).
By default, this will not destroy blocks or set fire to blocks within the explosion. Specify the 'fire' argument to set blocks on fire within the explosion radius. Specify the 'breakblocks' argument to cause the explosion to break blocks within the power radius. If no power is specified, the default power will be 1. If no location is given, the default will be the linked NPC or player's location. It is highly recommended you specify a location to be safe. Optionally specify a source entity that will be tracked as the damage cause. |
Related Tags | None
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | detonate, bomb, tnt |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/ExplodeCommand.java#L22 |
Name | Firework |
Syntax | firework (<location>) (power:<#>) (<type>/random) (primary:<color>|...) (fade:<color>|...) (flicker) (trail) (life:<duration>) |
Short Description | Launches a firework with customizable style. |
Full Description | This command launches a firework from the specified location.
If no location is given, the linked NPC or player's location will be used by default. The power option, which defaults to 1 if left empty, specifies the 'power' integer of the firework, which mainly controls how high the firework will go before exploding. Alternately, the "life" option allows you to manually specify a specific duration. The type option which specifies the shape the firework will explode with. If unspecified, 'ball' will be used. Can be any of: ball, ball_large, star, burst, or creeper The primary option specifies what color the firework explosion will start with, as a ColorTag. If unspecified, 'yellow' will be used. The fade option specifies what color the firework explosion will fade into, as a ColorTag. The trail option means the firework will leave a trail behind it. The flicker option means the firework will explode with a flicker effect. |
Related Tags | <EntityTag.firework_item> If the entity is a firework, returns the firework item used to launch it.
<ItemTag.is_firework> Returns whether the item is a firework. (...)
<ItemTag.firework> Returns the firework's property value as a list, matching the non-MapTag format of the mechanism. (...)
<entry[saveName].launched_firework> returns a EntityTag of the firework that was launched.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/FireworkCommand.java#L38 |
Name | Gamerule |
Syntax | gamerule [<world>] [<rule>] [<value>] |
Short Description | Sets a gamerule on the world. |
Full Description | Sets a gamerule on the world. A list of valid gamerules can be found here: https://minecraft.wiki/w/Game_rule
Note: Be careful, gamerules are CASE SENSITIVE. |
Related Tags | <WorldTag.gamerule[<gamerule>]> Returns the current value of the specified gamerule in the world. (...)
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/GameRuleCommand.java#L24 |
Name | Light |
Syntax | light [<location>] [<#>/reset] (duration:<duration>) |
Short Description | Creates a light source at the location with a specified brightness. |
Full Description | This command can create and reset a light source at a specified location, regardless of the type of block.
It will be shown to all players near the location until it is reset. The brightness must be between 0 and 15, inclusive. Optionally, specify the amount of time the light should exist before being removed. Note that lights do not persist across server restarts, but will still be visible in the world after a restart until there is a block change near the location (to reset the light). |
Related Tags | <LocationTag.light> Returns the total amount of light on the location.
<LocationTag.light.blocks> Returns the amount of light from light blocks that is (...)
|
Usage Example |
|
Usage Example |
|
Group | world |
Warning(s) | May cause lag spikes, use carefully.
Incompatible with Paper in 1.17+. Use Spigot, or use vanilla Light blocks. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/LightCommand.java#L24 |
Name | Midi |
Syntax | midi [cancel/<file> (tempo:<#.#>) (volume:<#.#>)] (<location>/<entity>|...) |
Short Description | Plays a midi file at a given location or to a list of players using note block sounds. |
Full Description | This will fully load a midi song file stored in the '../plugins/Denizen/midi/' folder.
The file must be a valid midi file with the extension '.mid'. It will continuously play the song as noteblock songs at the given location or group of players until the song ends. If no location or entity is specified, by default this will play for the attached player. Also, an example Midi song file has been included: "Denizen" by Black Coyote. He made it just for us! Check out more of his amazing work at: http://www.youtube.com/user/BlaCoyProductions The midi command is ~waitable. Refer to ~waitable. |
Related Tags | None
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | music |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/MidiCommand.java#L30 |
Name | ModifyBlock |
Syntax | modifyblock [<location>|.../<ellipsoid>/<cuboid>] [<material>|...] (no_physics/naturally:<tool>) (delayed) (<script>) (<percent chance>|...) (source:<player>) (max_delay_ms:<#>) |
Short Description | Modifies blocks. |
Full Description | Changes blocks in the world based on the criteria given.
Use 'no_physics' to place the blocks without physics taking over the modified blocks. This is useful for block types such as portals or water. This does NOT control physics for an extended period of time. Specify (<percent chance>|...) to give a chance of each material being placed (in any material at all). Use 'naturally:' when setting a block to air to break it naturally, meaning that it will drop items. Specify the tool item that should be used for calculating drops. Use 'delayed' to make the modifyblock slowly edit blocks at a time pace roughly equivalent to the server's limits. Optionally, specify 'max_delay_ms' to control how many milliseconds the 'delayed' set can run for in any given tick (defaults to 50). Note that specifying a list of locations will take more time in parsing than in the actual block modification. Optionally, specify a script to be ran after the delayed edits finish. (Doesn't fire if delayed is not set.) Optionally, specify a source player. When set, Bukkit events will fire that identify that player as the source of a change, and potentially cancel the change. The source argument might cause weird interoperation with other plugins, use with caution. The modifyblock command is ~waitable. Refer to ~waitable. |
Related Tags | <LocationTag.material> Returns the material of the block at the location.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | setblock, changeblock, placeblock, breakblock |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/ModifyBlockCommand.java#L62 |
Name | PlayEffect |
Syntax | playeffect [effect:<name>] [at:<location>|...] (data:<#.#>) (special_data:<map>) (visibility:<#.#>) (quantity:<#>) (offset:<#.#>,<#.#>,<#.#>) (targets:<player>|...) (velocity:<vector>) |
Short Description | Plays a visible or audible effect at the location. |
Full Description | Allows the playing of particle effects anywhere without the need of the source it comes from originally.
The particles you may use, can come from sources such as a potion effect or a portal/Enderman with their particles respectively. Some particles have different data which may include different behavior depending on the data. Default data is 0 Specifying a visibility value changes the sight radius of the effect. For example if visibility is 15; Targeted players won't see it unless they are 15 blocks or closer. You can add a quantity value that allow multiple of the same effect played at the same time. If an offset is set, each particle will be played at a different location in the offset area. Everyone will see the particle effects unless a target has been specified. See Particle Effects for a list of valid effect names. Version change note: The original PlayEffect command raised all location inputs 1 block-height upward to avoid effects playing underground when played at eg a player's location. This was found to cause too much confusion, so it is no longer on by default. However, it will still happen for older commands. The distinction is in whether you include the (now expected to use) "at:" prefix on your location argument. If you do not have this prefix, the system will assume your command is older, and will apply the 1-block height offset. Some particles will require input to the "special_data" argument. The data input is a MapTag with different keys per particle. - For DUST particles, the input is of format [size=<size>;color=<color>], e.g. "[size=1.2;color=red]". - For DUST_COLOR_TRANSITION particles, the input is of format [size=<size>;from=<color>;to=<color>], e.g "[size=1.2;from=red;to=blue]". - For BLOCK, BLOCK_CRUMBLE, BLOCK_MARKER, DUST_PILLAR, or FALLING_DUST particles, the input is of format [material=<material>], e.g. [material=stone] - For VIBRATION particles, the input is of format [origin=<location>;destination=<location/entity>;duration=<duration>], for example: [origin=<player.location>;destination=<player.cursor_on>;duration=5s] - For ITEM particles, the input is of format [item=<item>], e.g. "[item=stick]". - For TRAIL particles, the input is of format [color=<color>;target=<location>;duration=<duration>], e.g. "[color=red;target=<player.cursor_on>;duration=20s]". - For ENTITY_EFFECT particles, the input is of format [color=<color>], e.g. "[color=green]". - For SHRIEK particles, the input is of format [duration=<duration>], e.g. "[duration=1m]". - For SCULK_CHARGE particles, the input is of format [radians=<element>], e.g. "[radians=<element[90].to_radians>]". Optionally specify a velocity vector for standard particles to move. Note that this ignores the 'data' input if used. |
Related Tags | <server.effect_types> Returns a list of all 'effect' types known to the server. (...)
<server.particle_types> Returns a list of all particle effect types known to the server. (...)
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | particle |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/PlayEffectCommand.java#L55 |
Name | PlaySound |
Syntax | playsound (<location>|...) (<player>|...) [sound:<name>] (volume:<#.#>) (pitch:<#.#>) (custom) (sound_category:<category_name>) |
Short Description | Plays a sound at the location or to a list of players. |
Full Description | Plays a sound to a player or nearby players at a location.
The sound is played through the player's client just like any other sounds in Minecraft. For a list of all sounds, check https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html Sounds are by default played under their normal sound type (eg zombie sounds are under the type Mobs/Animals). You can optionally instead specify an alternate sound category to use. For a list of all valid sound categories, check https://hub.spigotmc.org/javadocs/spigot/org/bukkit/SoundCategory.html Specifying a player or list of players will only play the sound for each player, from their own location (but will not follow them if they move). If a location is specified, it will play the sound for any players that are near the location specified. If both players and locations are specified, will play the sound for only those players at those locations. Optionally, specify 'custom' to play a custom sound added by a resource pack, changing the sound name to something like 'random.click' Optionally specify a pitch value (defaults to 1.0). A pitch from 0.0 to 1.0 will be deeper (sounds like a demon), and above 1.0 will be higher pitched (sounds like a fairy). Optionally specify a volume value (defaults to 1.0). A volume from 0.0 to 1.0 will be quieter than normal. A volume above 1.0 however will not be louder - instead it will be audible from farther (approximately 1 extra chunk of distance per value, eg 2.0 is 2 more chunks, 5.0 is 5 more chunks, etc.). |
Related Tags | <server.sound_types> Deprecated in favor of server.sound_keys on MC 1.21+.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | noise |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/PlaySoundCommand.java#L32 |
Name | Schematic |
Syntax | schematic [create/load/unload/rotate/save/flip_x/flip_y/flip_z/paste (fake_to:<player>|... fake_duration:<duration>) (noair) (mask:<material_matcher>)] [name:<name>] (filename:<name>) (angle:<#>) (<location>) (area:<area>) (delayed) (max_delay_ms:<#>) (entities) (flags) |
Short Description | Creates, loads, pastes, and saves schematics (Sets of blocks). |
Full Description | Creates, loads, pastes, and saves schematics. Schematics are files containing info about blocks and the order of those blocks.
Denizen offers a number of tools to manipulate and work with schematics. Schematics can be rotated, flipped, pasted with no air, or pasted with a delay. All schematic command usages must specify the "name" argument, which is a unique global identifier of the schematic in memory. This will be created by "create" or "load" options, and persist in memory until "unload" is used (or the server is restarted). The 'create' option requires an area and a center location as input. The area can be defined as any valid AreaObject, such as a CuboidTag. Note that all schematics are internally tracked as cuboids, and other area shapes will only constrain the copy region. Note that the block boundaries of non-cuboid regions are defined by whether the region definition contains the center of a block. This will create a new schematic in memory based on world data. The "rotate angle:#" and "flip_x/y/z" options will apply the change to the copy of the schematic in memory, to later be pasted or saved. This will rotate the set of blocks itself, the relative origin, and any directional blocks inside the schematic. Rotation angles must be a multiple of 90 degrees. When using 'paste', you can specify 'angle:#' to have that paste rotated, without rotating the original schematic. The "delayed" option makes the command non-instant. This is recommended for large schematics. For 'save', 'load', and 'rotate', this processes async to prevent server lockup. For 'paste' and 'create', this delays how many blocks can be processed at once, spread over many ticks. Optionally, specify 'max_delay_ms' to control how many milliseconds the 'delayed' set can run for in any given tick (defaults to 50) (for create/paste only). The "load" option by default will load '.schem' files. If no '.schem' file is available, will attempt to load a legacy '.schematic' file instead. For load and save, the "filename" option is available to specify the name of the file to look for. If unspecified, the filename will default to the same as the "name" input. The "noair" option skips air blocks in the pasted schematics- this means those air blocks will not replace any blocks in the target location. The "mask" option can be specified to limit what block types the schematic will be pasted over. When using "create" and "mask", any block that doesn't match the mask will become a structure void. The "fake_to" option can be specified to cause the schematic paste to be a fake (packet-based, see showfake) block set, instead of actually modifying the blocks in the world. This takes an optional duration as "fake_duration" for how long the fake blocks should remain. The "create" and "paste" options allow the "entities" argument to be specified - when used, entities will be copied or pasted. At current time, entity types included will be: Paintings, ItemFrames, ArmorStands. The "create" option allows the "flags" argument to be specified - when used, block location flags will be copied. The schematic command is ~waitable as an alternative to 'delayed' argument. Refer to ~waitable. To delete a schematic file, use server.delete_file. |
Related Tags | <schematic[<name>].height> Returns the height (Y) of the schematic.
<schematic[<name>].length> Returns the length (Z) of the schematic.
<schematic[<name>].width> Returns the width (X) of the schematic.
<schematic[<name>].block[<location>]> Returns the material for the block at the location in the schematic. (...)
<schematic[<name>].origin> Returns the origin location of the schematic.
<schematic[<name>].blocks> Returns the number of blocks in the schematic.
<schematic[<name>].exists> Returns whether the schematic exists.
<schematic[<name>].cuboid[<origin_location>]> Returns a cuboid of where the schematic would be if it was pasted at an origin.
<schematic.list> Returns a list of all loaded schematics.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L58 |
Name | Sign |
Syntax | sign (type:{automatic}/sign_post/wall_sign) (material:<material>) [<line>|...] [<location>] (direction:north/east/south/west) |
Short Description | Modifies a sign. |
Full Description | Modifies a sign that replaces the text shown on it. If no sign is at the location, it replaces the location with the modified sign.
Specify 'automatic' as a type to use whatever sign type and direction is already placed there. If there is not already a sign there, defaults to a sign_post. Optionally specify a material to use. If not specified, will use an oak sign (unless the block is already a sign, and 'type' is 'automatic'). The direction argument specifies which direction the sign should face. If a direction is not specified, and there is not already a sign there for 'automatic', the direction defaults to south. If a sign_post is placed, you can specify any specific blockface value as the direction, eg "SOUTH_WEST". See also MaterialTag.valid_directions (test in-game for example via "/ex narrate <material[oak_sign].valid_directions>"). |
Related Tags | <LocationTag.sign_contents> Returns a list of lines on a sign.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SignCommand.java#L29 |
Name | Strike |
Syntax | strike [<location>] (no_damage) (silent) |
Short Description | Strikes lightning down upon the location. |
Full Description | Causes lightning to strike at the specified location, which can optionally have damage disabled.
The lightning will still cause fires to start, even without the 'no_damage' argument. Lightning caused by this command will cause creepers to activate. Using the no_damage argument makes the lightning do no damage to the player or any other entities, and means creepers struck will not activate. Use 'silent' to remove the sound of the lightning strike. NOTE: The 'silent' option appears to have been removed in a Minecraft update and thus lightning will be audible until/unless Mojang re-adds it. |
Related Tags | None
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | lightning, electrocute |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/StrikeCommand.java#L20 |
Name | Switch |
Syntax | switch [<location>|...] (state:{toggle}/on/off) (duration:<value>) (no_physics) |
Short Description | Switches state of the block. |
Full Description | Changes the state of a block at the given location, or list of blocks at the given locations.
Optionally specify "state:on" to turn a block on (or open it, or whatever as applicable) or "state:off" to turn it off (or close it, etc). By default, will toggle the state (on to off, or off to on). Optionally specify the "duration" argument to set a length of time after which the block will return to the original state. Works on any interactable blocks, including: - the standard toggling levers, doors, gates... - Single-use interactables like buttons, note blocks, dispensers, droppers, ... - Redstone interactables like repeaters, ... - Special interactables like tripwires, ... - Bells as a special case will ring when you use 'switch' on them, ... - Almost any other block with an interaction handler. This will generally (but not always) function equivalently to a user right-clicking the block (so it will open and close doors, flip levers on and off, press and depress buttons, ...). Optionally specify 'no_physics' to not apply a physics update after switching. |
Related Tags | <LocationTag.switched> Returns whether the block at the location is considered to be switched on. (...)
<MaterialTag.switched> Returns whether a material is 'switched on', which has different semantic meaning depending on the material type. (...)
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | toggle, lever, activate, power, redstone |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SwitchCommand.java#L37 |
Name | tick |
Syntax | tick [rate/step/sprint/freeze/reset] (amount:<#.#>/cancel) |
Short Description | Controls the server's tick rate. |
Full Description | Controls the server's tick rate. MC versions 1.20+ only.
The tick rate affects things such as entity movement (including player movement), entity animations, plant growth, etc. Be careful when setting the tick rate, as a high tick rate can overload the server. If tick rate is high, crops will grow faster, animations will speed up, and so forth. Conversely, if the tick rate is low, crops will grow slower, animations will slow down, and entity movement (including player movement) will slow down and appear to be in slow motion. For a list of all the things that the tick rate affects, see https://minecraft.wiki/w/Tick To change the tick rate, use the 'rate' argument and input the amount using 'amount'. The tick rate must be a number between 1.0 and 10000.0 (inclusive). To reset the tick rate to the normal value (20.0), use the 'reset' argument. To freeze the tick rate, use the 'freeze' argument. To unfreeze, add the 'cancel' argument. Freezing the tick rate will cause all entities (except for players and entities that a player is riding) to stop ticking. This means that entity movement and animations will stop, as well as stop things like crop growth, daylight cycle, etc. To step the tick rate while the server is frozen for a specific amount of time, use the 'step' argument and input the amount of ticks using 'amount'. Tick rate stepping is allowing the tick rate to resume for a specific amount of ticks while the server is frozen. After the amount of specified ticks have passed, the tick rate will refreeze. Step input should not be a number less than one. If the server is not frozen when trying to use the 'step' argument, nothing will happen. To make the tick rate as fast as possible for a specific amount of time, use the 'sprint' argument and input the amount of ticks using 'amount'. The tick rate will increase as much as possible without overloading the server for the amount of specified ticks. Sprint input should be not be a number less than one. For example, if you want to sprint 200 ticks, the tick rate will run 200 ticks as fast as possible and then return to the previous tick rate. To stop stepping or sprinting early, use the 'cancel' argument. The tick rate resets to 20.0 on server restart. For information about tick rate arguments, see https://minecraft.wiki/w/Commands/tick |
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Warning(s) | Be careful, this command will affect plugins that depend on tick rate and may cause them to break. For example, setting the tick rate to 1 will cause the tick event to fire once per second. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/TickCommand.java#L11 |
Name | Time |
Syntax | time ({global}/player) [<time-duration>/reset] (<world>) (reset:<duration>) (freeze) |
Short Description | Changes the current time in the minecraft world. |
Full Description | Changes the current time in a world or the time that a player sees the world in.
If no world is specified, defaults to the NPCs world. If no NPC is available, defaults to the player's world. If no player is available, an error will be thrown. If 'player' is specified, this will change their personal time. This is separate from the global time, and does not affect other players. When that player logs off, their time will be reset to the global time. Additionally, you may instead specify 'reset' to return the player's time back to global time. If you specify a custom time, optionally specify 'reset:<duration>' to set a time after which the player's time will reset (if not manually changed again before then). Optionally specify 'freeze' to lock a player's time in at the specified time value. |
Related Tags | <WorldTag.time> Returns the relative in-game time of this world.
<WorldTag.time.period> Returns the time as 'day', 'night', 'dawn', or 'dusk'.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/TimeCommand.java#L28 |
Name | Weather |
Syntax | weather ({global}/player) [sunny/storm/thunder/reset] (<world>) (reset:<duration>) |
Short Description | Changes the current weather in the minecraft world. |
Full Description | By default, changes the weather in the specified world.
If you specify 'player', this will change the weather in that player's view. This is separate from the global weather, and does not affect other players. When that player logs off, their weather will be reset to the global weather. Additionally, you may instead specify 'reset' to return the player's weather back to global weather. If you specify a custom weather, optionally specify 'reset:<duration>' to set a time after which the player's weather will reset (if not manually changed again before then). Note that 'thunder' is no different from 'storm' when used on a single player. |
Related Tags | <BiomeTag.downfall_type> Deprecated in favor of BiomeTag.downfall_at on 1.19+, as downfall is block-specific now. (...)
<PlayerTag.weather> Returns the type of weather the player is experiencing. This will be different (...)
<WorldTag.has_storm> Returns whether there is currently a storm in this world. (...)
<WorldTag.weather_duration> Returns the duration of storms.
<WorldTag.thundering> Returns whether it is currently thundering in this world.
<WorldTag.thunder_duration> Returns the duration of thunder.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/WeatherCommand.java#L28 |
Name | structure/plant grows naturally |
Event Lines | <structure/plant> grows (naturally)
<structure/plant> grows from bonemeal |
Triggers | when a structure (a tree or a mushroom) grows in a world. |
Generated Examples | after structure/plant grows naturally:
after structure/plant grows from bonemeal: after structure/plant grows: |
Has Player | when a player caused the structure growth to occur (eg with bonemeal). - this adds switches 'flagged:<flag name>' + 'permission:<node>', in addition to the '<player>' link. |
Contexts | <context.world> returns the WorldTag the structure grew in.
<context.location> returns the LocationTag the structure grew at.
<context.structure> returns an ElementTag of the structure's type. Refer to https://hub.spigotmc.org/javadocs/spigot/org/bukkit/TreeType.html.
<context.blocks> returns a ListTag of all block locations to be modified.
<context.new_materials> returns a ListTag of the new block materials, to go with <context.blocks>.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/StructureGrowsScriptEvent.java#L20 |
Name | chunk loads for the first time |
Event Lines | chunk loads (for the first time) |
Triggers | when a new chunk is loaded |
Generated Examples | after chunk loads for the first time: |
Contexts | <context.chunk> returns the loading chunk.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Warning(s) | This event will fire *extremely* rapidly and often when using 'for the first time'.
When not using that, it will fire so rapidly that lag is almost guaranteed. Use with maximum caution. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/ChunkLoadScriptEvent.java#L12 |
Name | chunk loads entities |
Event Lines | chunk loads entities |
Triggers | when a chunk loads in its entities. |
Generated Examples | on chunk loads entities:
after chunk loads entities: |
Switches | entity_type:<type-matcher> to only fire in the chunk contains an entity that matches the given entity matcher.
include_empty:<true/false> defaults to false, set to 'true' to include chunks loading an empty set of entities. |
Contexts | <context.chunk> returns the loading chunk.
<context.entities> returns a ListTag of all entities to be loaded.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Warning(s) | This event will fire very rapidly. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/ChunkLoadEntitiesScriptEvent.java#L15 |
Name | chunk unloads |
Event Lines | chunk unloads |
Triggers | when a chunk is unloaded |
Generated Examples | on chunk unloads:
after chunk unloads: |
Contexts | <context.chunk> returns the unloading chunk.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Warning(s) | This event will fire *extremely* rapidly and often! |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/ChunkUnloadScriptEvent.java#L12 |
Name | chunk unloads entities |
Event Lines | chunk unloads entities |
Triggers | when a chunk unloads in its entities. Note that this is basically a notification - it's already too late to change entity data. |
Generated Examples | on chunk unloads entities:
after chunk unloads entities: |
Switches | entity_type:<type-matcher> to only fire in the chunk contains an entity that matches the given entity matcher.
include_empty:<true/false> defaults to false, set to 'true' to include chunks loading an empty set of entities. |
Contexts | <context.chunk> returns the unloading chunk.
<context.entities> returns a ListTag of all entities being unloaded.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Warning(s) | This event will fire very rapidly. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/ChunkUnloadEntitiesScriptEvent.java#L15 |
Name | generic game event |
Event Lines | generic game event |
Triggers | when the minecraft world experiences a generic minecraft game event. This is normally used for sculk sensors. |
Generated Examples | on generic game event: |
Switches | type:<game_event_name> to only process the event when a specific game event is fired. |
Contexts | <context.location> returns the location of the event.
<context.entity> returns the entity that triggered the event, if any.
<context.game_event> returns the name of the Minecraft game event, for example "minecraft:block_change". See https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/GameEvent.html.
<context.radius> returns the radius, in blocks, that the event is broadcast to.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/GenericGameEventScriptEvent.java#L16 |
Name | lightning strikes |
Event Lines | lightning strikes |
Triggers | when lightning strikes in a world. |
Generated Examples | after lightning strikes: |
Contexts | <context.lightning> returns the EntityTag of the lightning.
<context.location> returns the LocationTag where the lightning struck.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/LightningStrikesScriptEvent.java#L13 |
Name | lingering potion splash|splashes |
Event Lines | lingering potion splash|splashes
lingering <item> splash|splashes |
Triggers | when a lingering splash potion breaks open |
Generated Examples | on lingering potion splashes:
on lingering waxed_copper_trapdoor splash: after lingering potion splashes: on lingering item splash: |
Contexts | <context.potion> returns an ItemTag of the potion that broke open.
<context.location> returns the LocationTag the splash potion broke open at.
<context.entity> returns an EntityTag of the splash potion.
<context.cloud> returns the EntityTag of the area of effect cloud.
<context.radius> returns the radius of the effect cloud.
<context.duration> returns the lingering duration of the effect cloud.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/LingeringPotionSplashScriptEvent.java#L16 |
Name | loot generates |
Event Lines | loot generates |
Triggers | when loot is generated somewhere in the world (like a vanilla chest being opened for the first time). |
Generated Examples | on loot generates:
after loot generates: |
Has Player | when the linked entity is a player. - this adds switches 'flagged:<flag name>' + 'permission:<node>', in addition to the '<player>' link. |
Switches | for:<type> to only process the event if a certain inventory type is receiving loot (like 'for:chest'). |
Contexts | <context.entity> returns an entity that caused loot generation, if any.
<context.inventory> returns the InventoryTag that loot is generating into.
<context.items> returns a ListTag of the items being generated.
<context.loot_table_id> returns an element indicating the minecraft key for the loot-table that was generated.
|
Determine | "LOOT:<ListTag(ItemTag)>" to change the list of items that will generate as loot. |
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/LootGenerateScriptEvent.java#L22 |
Name | portal created because reason |
Event Lines | portal created (because <reason>) |
Triggers | when a portal is created. |
Generated Examples | after portal created: |
Contexts | <context.entity> returns the EntityTag that created the portal.
<context.world> returns the WorldTag the portal was created in.
<context.reason> returns an ElementTag of the reason the portal was created. (FIRE, NETHER_PAIR, END_PLATFORM)
<context.blocks> returns a ListTag of all the blocks that will become portal blocks.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/PortalCreateScriptEvent.java#L17 |
Name | potion splash|splashes |
Event Lines | potion splash|splashes
<item> splash|splashes |
Triggers | when a splash potion breaks open. |
Example |
|
Contexts | <context.potion> returns an ItemTag of the potion that broke open.
<context.entities> returns a ListTag of affected entities.
<context.location> returns the LocationTag the splash potion broke open at.
<context.entity> returns an EntityTag of the splash potion.
<context.intensity> returns an ListTag(MapTag) of the intensity for all affected entities.
|
Determine | INTENSITY:<ListTag(MapTag)>" to set the intensity of specified entities. |
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/PotionSplashScriptEvent.java#L25 |
Name | raid finishes |
Event Lines | raid finishes |
Triggers | when a village raid finishes normally. |
Generated Examples | after raid finishes:
on raid finishes: |
Contexts | <context.raid> returns the raid data. See Raid Event Data.
<context.winners> returns the ListTag of players who completed the raid. This is separate from the raid's heroes in that the winners are guaranteed to be online.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/RaidFinishesScriptEvent.java#L13 |
Name | raid spawns wave |
Event Lines | raid spawns wave |
Triggers | when a village raid spawns a new wave of raiders. |
Generated Examples | after raid spawns wave: |
Contexts | <context.raid> returns the raid data. See Raid Event Data.
<context.leader> returns the EntityTag of the patrol leader of the wave.
<context.new_raiders> returns the ListTag of all new raiders.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/RaidSpawnsWaveScriptEvent.java#L13 |
Name | raid stops |
Event Lines | raid stops |
Triggers | when a village raid stops for any reason. |
Generated Examples | on raid stops:
after raid stops: |
Switches | reason:<reason> to only process the event if the raid stopped for a certain reason. |
Contexts | <context.raid> returns the raid data. See Raid Event Data.
<context.reason> returns the reason for stopping. See https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/event/raid/RaidStopEvent.Reason.html.
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/RaidStopsScriptEvent.java#L11 |
Name | spawn changes |
Event Lines | spawn changes |
Triggers | when the world's spawn point changes. |
Generated Examples | after spawn changes:
on spawn changes: |
Switches | for:<world> to only process the event when a specified world's spawn changes. |
Contexts | <context.world> returns the WorldTag that the spawn point changed in.
<context.old_location> returns the LocationTag of the old spawn point.
<context.new_location> returns the LocationTag of the new spawn point.
|
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/SpawnChangeScriptEvent.java#L13 |
Name | thunder changes|begins|clears |
Event Lines | thunder changes|begins|clears |
Triggers | when thunder starts or stops in a world. |
Generated Examples | after thunder begins:
after thunder changes: |
Switches | in:<world> to only run the event if it applies to a specific world. |
Contexts | <context.world> returns the WorldTag the thunder changed in.
<context.thunder> returns true if thunder is starting, or false if thunder is stopping.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Group | World |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/ThunderChangesScriptEvent.java#L13 |
Name | <LocationTag.age> |
Returns | DurationTag |
Mechanism | LocationTag.age |
Description | Returns the age of an end gateway. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4041 |
Name | <LocationTag.attached_to> |
Returns | LocationTag |
Description | Returns the block this block is attached to.
(For buttons, levers, signs, torches, etc). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3920 |
Name | <LocationTag.beacon_primary_effect> |
Returns | ElementTag |
Mechanism | LocationTag.beacon_primary_effect |
Description | Returns the primary effect of the beacon. The return is simply a potion effect type name. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3888 |
Name | <LocationTag.beacon_secondary_effect> |
Returns | ElementTag |
Mechanism | LocationTag.beacon_secondary_effect |
Description | Returns the secondary effect of the beacon. The return is simply a potion effect type name. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3904 |
Name | <LocationTag.beacon_tier> |
Returns | ElementTag(Number) |
Description | Returns the tier level of a beacon pyramid (0-4). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3877 |
Name | <LocationTag.biome> |
Returns | BiomeTag |
Mechanism | LocationTag.biome |
Description | Returns the biome at the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3500 |
Name | <LocationTag.block_facing> |
Returns | LocationTag |
Mechanism | LocationTag.block_facing |
Description | Returns the relative location vector of where this block is facing.
Only works for block types that have directionality (such as signs, chests, stairs, etc.). This can return for example "1,0,0" to mean the block is facing towards the positive X axis. You can use <some_block_location.add[<some_block_location.block_facing>]> to get the block directly in front of this block (based on its facing direction). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L845 |
Name | <LocationTag.brewing_fuel_level> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.brewing_fuel_level |
Description | Returns the level of fuel a brewing stand has. Each unit of fuel can power one brewing operation. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3817 |
Name | <LocationTag.brewing_time> |
Returns | DurationTag |
Mechanism | LocationTag.brewing_time |
Description | Returns the brewing time a brewing stand has left. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3805 |
Name | <LocationTag.campfire_items> |
Returns | ListTag(ItemTag) |
Mechanism | LocationTag.campfire_items |
Description | Returns a list of items currently in this campfire.
This list has air items in empty slots, and is always sized exactly the same as the number of spaces a campfire has. (A standard campfire has exactly 4 slots). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4113 |
Name | <LocationTag.command_block_name> |
Returns | ElementTag |
Mechanism | LocationTag.command_block_name |
Description | Returns the name a command block is set to. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3775 |
Name | <LocationTag.command_block> |
Returns | ElementTag |
Mechanism | LocationTag.command_block |
Description | Returns the command a command block is set to. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3790 |
Name | <LocationTag.custom_name> |
Returns | ElementTag |
Mechanism | LocationTag.custom_name |
Description | Returns the custom name of this block.
Only works for nameable blocks, such as chests and dispensers. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3976 |
Name | <LocationTag.drops[(<item>)]> |
Returns | ListTag(ItemTag) |
Description | Returns what items the block at the location would drop if broken naturally.
Optionally specifier a breaker item. Not guaranteed to contain exactly correct or contain all possible drops (for things like plants that drop only when grown, ores that drop random amounts, etc). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1443 |
Name | <LocationTag.exit_location> |
Returns | LocationTag |
Mechanism | LocationTag.exit_location |
Description | Returns the exit location of an end gateway block. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4077 |
Name | <LocationTag.facing_blocks[(<#>)]> |
Returns | ListTag(LocationTag) |
Description | Finds all block locations in the direction this location is facing,
optionally with a custom range (default is 100). For example a location at 0,0,0 facing straight up will include 0,1,0 0,2,0 and so on. This is an imperfect block line tracer. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2102 |
Name | <LocationTag.flood_fill[<limit>].types[<matcher>]> |
Returns | ListTag(LocationTag) |
Description | Returns the set of all blocks, starting at the given location,
that can be directly reached in a way that only travels through blocks that match the given LocationTag matcher. This will not travel diagonally, only the 6 cardinal directions (N/E/S/W/Up/Down). As this is potentially infinite for some block types (like air, stone, etc.) should there be any opening however small, a limit must be given. The limit value can be: a CuboidTag, an EllipsoidTag, or an ElementTag(Decimal) to use as a radius. Note that the returned list will not be in any particular order. The result will be an empty list if the block at the start location is not one of the input materials. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2555 |
Name | <LocationTag.flood_fill[<limit>]> |
Returns | ListTag(LocationTag) |
Description | Returns the set of all blocks, starting at the given location,
that can be directly reached in a way that only travels through blocks of the same type as the starting block. For example, if starting at an air block inside an enclosed building, this will return all air blocks inside the building (but none outside, and no non-air blocks). As another example, if starting on a block of iron_ore in the ground, this will find all other blocks of iron ore that are part of the same vein. This will not travel diagonally, only the 6 cardinal directions (N/E/S/W/Up/Down). As this is potentially infinite should there be any opening however small, a limit must be given. The limit value can be: a CuboidTag, an EllipsoidTag, or an ElementTag(Decimal) to use as a radius. Note that the returned list will not be in any particular order. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2514 |
Name | <LocationTag.furnace_burn_duration> |
Returns | DurationTag |
Mechanism | LocationTag.furnace_burn_duration |
Description | Returns the burn time a furnace has left. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3829 |
Name | <LocationTag.furnace_cook_duration_total> |
Returns | DurationTag |
Mechanism | LocationTag.furnace_cook_duration_total |
Description | Returns the total cook time a furnace has left. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3861 |
Name | <LocationTag.furnace_cook_duration> |
Returns | DurationTag |
Mechanism | LocationTag.furnace_cook_duration |
Description | Returns the cook time a furnace has been cooking its current item for. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3845 |
Name | <LocationTag.has_inventory> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location has an inventory. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1145 |
Name | <LocationTag.has_loot_table> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.clear_loot_table |
Description | Returns an element indicating whether the chest at this location has a loot-table set. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3722 |
Name | <LocationTag.head_rotation> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.head_rotation |
Description | Gets the rotation of the head at this location. Can be 1-16. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1220 |
Name | <LocationTag.highest> |
Returns | LocationTag |
Description | Returns the location of the highest solid block at the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1133 |
Name | <LocationTag.hive_bee_count> |
Returns | ElementTag(Number) |
Description | Returns the number of bees inside a hive. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1482 |
Name | <LocationTag.hive_max_bees> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.hive_max_bees |
Description | Returns the maximum number of bees allowed inside a hive. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1493 |
Name | <LocationTag.inventory> |
Returns | InventoryTag |
Description | Returns the InventoryTag of the block at the location. If the
block is not a container, returns null. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1156 |
Name | <LocationTag.is_exact_teleport> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.is_exact_teleport |
Description | Returns whether an end gateway is 'exact teleport' - if false, the destination will be randomly chosen *near* the destination. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4059 |
Name | <LocationTag.is_liquid> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location is a liquid. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3600 |
Name | <LocationTag.is_lockable> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.lock |
Description | Returns whether the container is lockable. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1431 |
Name | <LocationTag.is_locked> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.lock |
Description | Returns whether the container is locked. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1416 |
Name | <LocationTag.is_passable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at this location is non-solid and can be walked through.
Note that for example an open door is still solid, and thus will return false. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1186 |
Name | <LocationTag.is_spawnable> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is safe to spawn at, for a player or player-like entity.
Specifically this verifies that: - The block above this location is air. - The block at this location is non-solid. - The block below this location is solid. - All relevant blocks are not dangerous (like fire, lava, etc.), or unstable/small/awkward (like fences, doors, etc.) or otherwise likely to go wrong (like pressure plates). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4136 |
Name | <LocationTag.is_within_border> |
Returns | ElementTag(Boolean) |
Description | Returns whether the location is within the world border. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3426 |
Name | <LocationTag.jukebox_is_playing> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.jukebox_play |
Description | Returns whether the jukebox is currently playing a song. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4023 |
Name | <LocationTag.jukebox_record> |
Returns | ItemTag |
Mechanism | LocationTag.jukebox_record |
Description | Returns the record item currently inside the jukebox.
If there's no record, will return air. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4004 |
Name | <LocationTag.lectern_page> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.lectern_page |
Description | Deprecated in favor of LocationTag.page. |
Generated Example |
|
Group | world |
Deprecated | Use 'LocationTag.page' |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3689 |
Name | <LocationTag.light.blocks> |
Returns | ElementTag(Number) |
Description | Returns the amount of light from light blocks that is
on the location. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3634 |
Name | <LocationTag.light.sky> |
Returns | ElementTag(Number) |
Description | Returns the amount of light from the sky that is
on the location. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3647 |
Name | <LocationTag.light> |
Returns | ElementTag(Number) |
Description | Returns the total amount of light on the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3621 |
Name | <LocationTag.local_difficulty> |
Returns | ElementTag(Decimal) |
Description | Returns the local difficulty (damage scaler) at the location.
This is based internally on multiple factors, including ChunkTag.inhabited_time and WorldTag.difficulty. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3992 |
Name | <LocationTag.lock> |
Returns | ElementTag |
Mechanism | LocationTag.lock |
Description | Returns the password to a locked container. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1400 |
Name | <LocationTag.loot_table_id> |
Returns | ElementTag |
Mechanism | LocationTag.loot_table_id |
Description | Returns an element indicating the minecraft key for the loot-table for the chest at this location (if any). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3738 |
Name | <LocationTag.map_color> |
Returns | ColorTag |
Description | Returns the color of the block at the location, as seen in a map. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4187 |
Name | <LocationTag.material> |
Returns | MaterialTag |
Description | Returns the material of the block at the location. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1171 |
Name | <LocationTag.other_block> |
Returns | LocationTag |
Description | If the location is part of a double-block structure (double chests, double plants, doors, beds, etc),
returns the location of the other block in the double-block structure. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3955 |
Name | <LocationTag.page> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.page |
Description | Returns the current page on display in the book on this Lectern block. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3707 |
Name | <LocationTag.patterns> |
Returns | ListTag |
Mechanism | LocationTag.patterns |
Description | Lists the patterns of the banner at this location in the form "COLOR/PATTERN|COLOR/PATTERN" etc.
For the list of possible colors, see https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html. For the list of possible patterns, see https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1202 |
Name | <LocationTag.power> |
Returns | ElementTag(Number) |
Description | Returns the current redstone power level of a block. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3668 |
Name | <LocationTag.precise_cursor_on_block[(<range>)]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with input setting [return=block]. |
Generated Example |
|
Group | world |
Deprecated | use "ray_trace[return=block]" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1909 |
Name | <LocationTag.precise_cursor_on[(<range>)]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with all default settings (no input other than optionally the range). |
Generated Example |
|
Group | world |
Deprecated | use "ray_trace" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1930 |
Name | <LocationTag.precise_impact_normal[(<range>)]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with input setting [return=normal]. |
Generated Example |
|
Group | world |
Deprecated | use "ray_trace[return=normal]" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1888 |
Name | <LocationTag.precise_target_list[<range>]> |
Returns | ListTag(EntityTag) |
Description | Returns a list of all entities this location is pointing directly at (using precise ray trace logic), up to a given range limit. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1951 |
Name | <LocationTag.precise_target_position[(<range>)].type[<entity_type>|...]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with "entities=" set to your input types as a matcher. |
Group | world |
Deprecated | use "ray_trace[entities=(your_types)]" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2032 |
Name | <LocationTag.precise_target_position[(<range>)]> |
Returns | LocationTag |
Description | Deprecated in favor of LocationTag.ray_trace with input of [entities=*] |
Generated Example |
|
Group | world |
Deprecated | use "ray_trace[entities=*]" instead. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L2017 |
Name | <LocationTag.precise_target[(<range>)].type[<entity_type>|...]> |
Returns | EntityTag |
Description | Returns the entity this location is pointing at, using precise ray trace logic.
Optionally, specify a maximum range to find the entity from (defaults to 100). Accepts a list of types to trace against (types not listed will be ignored). |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1991 |
Name | <LocationTag.precise_target[(<range>)]> |
Returns | EntityTag |
Description | Returns the entity this location is pointing at, using precise ray trace logic.
Optionally, specify a maximum range to find the entity from (defaults to 100). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1977 |
Name | <LocationTag.ray_trace_target[(range=<#.#>/{200});(blocks=<{true}/false>);(fluids=<true/{false}>);(nonsolids=<true/{false}>);(entities=<matcher>);(ignore=<entity>|...);(raysize=<#.#>/{0})]> |
Returns | EntityTag |
Description | Traces a line from this location towards the direction it's facing, returning the first hit entity (if any).
This is similar to LocationTag.precise_target and PlayerTag.target, except offering more options for how the ray trace is performed. For ray tracing locations, see LocationTag.ray_trace. Optionally specify: range: (defaults to 200) a maximum distance (in blocks) to trace before giving up. blocks: (defaults to true) specify "false" to ignore all blocks, solid or nonsolid or fluid, between this location and the target entity. fluids: (defaults to false) specify "true" to count fluids like water as solid, or "false" to ignore them. nonsolids: (defaults to false) specify "true" to count passable blocks (like tall_grass) as solid, or "false" to ignore them. entities: (defaults to none) specify an entity matcher for entities to ray trace for. Any non-matching entities along the way are ignored. Leave blank to match any entity. ignore: (defaults to none) optional list of EntityTags to ignore even if they match the matcher. raysize: (defaults to 0) sets the radius of the ray being used to trace entities. |
Example |
|
Example |
|
Example |
|
Synonyms (Search Aid) | locationtag.raycast_target, locationtag.raytrace_target, locationtag.ray_cast_target |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1824 |
Name | <LocationTag.ray_trace[(range=<#.#>/{200});(return=<{precise}/block/normal>);(default=<{null}/air>);(fluids=<true/{false}>);(nonsolids=<true/{false}>);(entities=<matcher>);(ignore=<entity>|...);(raysize=<#.#>/{0})]> |
Returns | LocationTag |
Description | Traces a line from this location towards the direction it's facing, returning the location of the first hit block or (optionally) entity.
This tag has also been referred to as 'cursor_on' or 'precise_cursor_on' in the past. For ray tracing entities, see LocationTag.ray_trace_target. Using 'return=normal' instead replaces the old 'precise_impact_normal' tag. Optionally specify: range: (defaults to 200) a maximum distance (in blocks) to trace before giving up. return: (defaults to precise) specify "precise" to return the exact location of the hit (if it hits a block, returns a location along the edge of the block -- but if it hits an entity, returns a location along the body of the entity) "normal" to return the normal vector of the impact location, or "block" to return the location of the block hit (if it hits an entity, returns equivalent to 'precise') For "precise" and "block", the location's direction is set to the direction of the block face hit (or entity bounding box face), pointing exactly away from whatever was hit (the 'normal' direction). default: (defaults to "null") specify "null" to return null when nothing is hit, or "air" to return the location of the air at the end of the trace (NOTE: can potentially be in water or other ignored block type, not just literal air). fluids: (defaults to false) specify "true" to count fluids like water as solid, or "false" to ignore them. nonsolids: (defaults to false) specify "true" to count passable blocks (like tallgrass) as solid, or false to ignore them. entities: (defaults to none) specify an entity matcher for entities to count as blocking the trace, "*" for any entity counts, or leave off (or empty) to ignore entities. ignore: (defaults to none) optional list of EntityTags to ignore even if they match the matcher. raysize: (defaults to 0) sets the radius of the ray being used to trace entities (and NOT for blocks!). |
Example |
|
Example |
|
Example |
|
Synonyms (Search Aid) | locationtag.raycast, locationtag.raytrace, locationtag.ray_cast |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1728 |
Name | <LocationTag.sign_contents> |
Returns | ListTag |
Mechanism | LocationTag.sign_contents |
Description | Returns a list of lines on a sign. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1245 |
Name | <LocationTag.sign_glow_color> |
Returns | ElementTag |
Mechanism | LocationTag.sign_glow_color |
Description | Returns the name of the glow-color of the sign at the location.
See also LocationTag.sign_glowing |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4169 |
Name | <LocationTag.sign_glowing> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.sign_glowing |
Description | Returns whether the location is a Sign block that is glowing. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4152 |
Name | <LocationTag.skull_name> |
Returns | ElementTag |
Mechanism | LocationTag.skull_skin |
Description | Returns the name of the skin the skull is displaying. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1521 |
Name | <LocationTag.skull_skin.full> |
Returns | ElementTag |
Mechanism | LocationTag.skull_skin |
Description | Returns the skin the skull item is displaying - just the name or UUID as text, not a player object,
along with the permanently cached texture property. In format "uuid|texture" - separated by a pipe, but not a ListTag. |
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1564 |
Name | <LocationTag.skull_skin> |
Returns | ElementTag |
Mechanism | LocationTag.skull_skin |
Description | Returns the skin the skull is displaying - just the name or UUID as text, not a player object. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1545 |
Name | <LocationTag.skull_type> |
Returns | ElementTag |
Description | Returns the type of the skull. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1505 |
Name | <LocationTag.spawner_count> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_count |
Description | Returns the spawn count for the spawner. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1385 |
Name | <LocationTag.spawner_display_entity> |
Returns | EntityTag |
Description | Returns the full "display entity" for the spawner. This can contain more data than just a type. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1278 |
Name | <LocationTag.spawner_max_nearby_entities> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_max_nearby_entities |
Description | Returns the maximum nearby entities for the spawner (the radius mobs will spawn in). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1370 |
Name | <LocationTag.spawner_maximum_spawn_delay> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_delay_data |
Description | Returns the maximum spawn delay for the mob spawner. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1325 |
Name | <LocationTag.spawner_minimum_spawn_delay> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_delay_data |
Description | Returns the minimum spawn delay for the mob spawner. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1310 |
Name | <LocationTag.spawner_player_range> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_player_range |
Description | Returns the maximum player range for the spawner (ie how close a player must be for this spawner to be active). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1340 |
Name | <LocationTag.spawner_range> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_range |
Description | Returns the spawn range for the spawner (the radius mobs will spawn in). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1355 |
Name | <LocationTag.spawner_spawn_delay> |
Returns | ElementTag(Number) |
Mechanism | LocationTag.spawner_delay_data |
Description | Returns the current spawn delay for the spawner.
This changes over time between LocationTag.spawner_minimum_spawn_delay and LocationTag.spawner_maximum_spawn_delay. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1294 |
Name | <LocationTag.spawner_type> |
Returns | EntityTag |
Mechanism | LocationTag.spawner_type |
Description | Returns the type of entity spawned by a mob spawner, if any. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1262 |
Name | <LocationTag.structure_block_data> |
Returns | MapTag |
Mechanism | LocationTag.structure_block_data |
Description | Returns the structure block data of the structure block at the location as a map with the following keys:
- author: ElementTag: The name of the structure's creator. set to "?" for most vanilla structures. - integrity: ElementTag(Decimal): The integrity of the structure (0-1). Lower integrity values will result in more blocks being removed when loading a structure. used with the seed to determine which blocks are randomly removed to mimic "decay". - metadata: ElementTag: Only applies in DATA mode, sets specific functions that can be applied to the structure, check the Minecraft wiki (https://minecraft.wiki/w/Structure_Block#Data) for more information. - mirror: ElementTag: How the structure is mirrored; "NONE", "LEFT_RIGHT", or "FRONT_BACK". - box_position: LocationTag: The position of the structure's bounding box, relative to the position of the structure block. Maximum allowed distance is 48 blocks in any direction. - rotation: ElementTag: The rotation of the structure; "NONE", "CLOCKWISE_90", "CLOCKWISE_180", or "COUNTERCLOCKWISE_90". - seed: ElementTag(Number): The seed used to determine how many blocks are removed upon loading of this structure (see "integrity" for more information). - structure_name: ElementTag: The name of the structure. - size: LocationTag: The size of the structure's bounding box, The maximum structure size is 48,48,48. - mode: ElementTag: The structure block's mode; "CORNER", "DATA", "LOAD", or "SAVE". See also MaterialTag.mode. - box_visible: ElementTag(Boolean): Whether the structure's bounding box is visible, only applies in LOAD mode. - ignore_entities: ElementTag(Boolean): Whether entities in the structure are ignored, only applies in SAVE mode. - show_invisible: ElementTag(Boolean): Whether invisible blocks in the structure are shown. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4202 |
Name | <LocationTag.switched> |
Returns | ElementTag(Boolean) |
Description | Returns whether the block at the location is considered to be switched on.
(For buttons, levers, etc.) To change this, see Switch |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1232 |
Name | <LocationTag.tree_distance> |
Returns | ElementTag(Number) |
Description | Deprecated in favor of MaterialTag.distance
Used like <[location].material.distance> |
Generated Example |
|
Group | world |
Deprecated | Use MaterialTag.distance |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3757 |
Name | <LocationTag.waxed> |
Returns | ElementTag(Boolean) |
Mechanism | LocationTag.waxed |
Description | If the location is a sign block, returns whether it is waxed (locked to prevent players editing the text). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4454 |
Name | <LocationTag.with_facing_direction> |
Returns | LocationTag |
Description | Returns the location with its direction set to the block's facing direction.
Only works for block types that have directionality (such as signs, chests, stairs, etc.). You can use <some_block_location.with_facing_direction.forward[1]> to get the block directly in front of this block (based on its facing direction). |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L869 |
Name | <LocationTag.xp_drop[(<item>)]> |
Returns | ElementTag(Number) |
Description | Returns how much experience, if any, the block at the location would drop if broken naturally.
Returns 0 if a block wouldn't drop xp. Optionally specifier a breaker item. Not guaranteed to contain exactly the amount that actual drops if then broken later, as the value is usually randomized. |
Generated Example |
|
Group | world |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1464 |
Name | CustomEvent |
Syntax | customevent [id:<id>] (context:<map>) |
Short Description | Fires a custom world script event. |
Full Description | Fires a custom world script event.
Input is an ID (the name of your custom event, choose a constant name to use), and an optional MapTag of context data. Linked data (player, npc, ...) is automatically sent across to the event. Use with custom event |
Related Tags | <entry[saveName].any_ran> returns a boolean indicating whether any events ran as a result of this command.
<entry[saveName].was_cancelled> returns a boolean indicating whether the event was cancelled.
<entry[saveName].determination_list> returns a ListTag of determinations to this event. Will be an empty list if 'determine output:' is never used.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | core |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/core/CustomEventCommand.java#L23 |
Name | block fades |
Event Lines | <block> fades |
Triggers | when a block fades, melts, or disappears based on world conditions. |
Generated Examples | on block fades:
after dried_kelp_block fades: |
Contexts | <context.location> returns the LocationTag the block faded at.
<context.material> returns the MaterialTag of the block that faded.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Block |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockFadesScriptEvent.java#L13 |
Name | block forms |
Event Lines | <block> forms |
Triggers | when a block is formed based on world conditions, EG, when snow forms in a snow storm or ice forms in a cold biome. |
Generated Examples | on waxed_copper_block forms:
after conduit forms: |
Contexts | <context.location> returns the LocationTag the block that is forming.
<context.material> returns the MaterialTag of the block that is forming.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Block |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockFormsScriptEvent.java#L13 |
Name | block grows |
Event Lines | <block> grows |
Triggers | when a block grows naturally in the world, EG, when wheat, sugar canes, cacti, watermelons or pumpkins grow. |
Generated Examples | after yellow_stained_glass_pane grows:
on block grows: |
Switches | from:<age> to only process the event if the material started at a specific age.
to:<age> to only process the event if the material ended at a specific age. |
Contexts | <context.location> returns the LocationTag of the block that grew (still at original material state when event fires).
<context.material> returns the MaterialTag of the block's newly grown state.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Block |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockGrowsScriptEvent.java#L15 |
Name | entity despawns |
Event Lines | <entity> despawns |
Triggers | when an entity despawns permanently from the world. May fire repeatedly for one entity. |
Generated Examples | after entity despawns:
after projectile despawns: |
Has NPC | when the entity that despawned is an NPC. |
Switches | cause:<cause> to only process the event when it came from a specified cause. |
Contexts | <context.entity> returns the entity that despawned.
<context.cause> returns the reason the entity despawned. Can be: DEATH, CHUNK_UNLOAD, CITIZENS, or OTHER
|
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Entity |
Warning(s) | this event fires very rapidly. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/entity/EntityDespawnScriptEvent.java#L12 |
Name | block spreads |
Event Lines | block spreads |
Triggers | when a block spreads based on world conditions, EG, when fire spreads, or when mushrooms spread, or when vines grow. |
Generated Examples | on block spreads: |
Switches | type:<block> to only run if the block spreading matches the material input. |
Contexts | <context.source_location> returns the LocationTag of the block that spread.
<context.location> returns the LocationTag of the new block.
<context.material> returns the MaterialTag of the block that spread.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Block |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/block/BlockSpreadsScriptEvent.java#L14 |
Name | system time hh:mm |
Event Lines | system time <HH:MM>
system time hourly|minutely|secondly |
Triggers | when the system time changes to the specified value.
The system time is the real world time set in the server's operating system. It is not necessarily in sync with the game server time, which may vary (for example, when the server is lagging). For events based on in-game time passage, use delta time or wait. |
Example |
|
Example |
|
Example |
|
Switches | every:<count> to only run the event every *count* times (like "on system time secondly every:5" for every 5 seconds). |
Contexts | <context.hour> returns the exact hour of the system time.
<context.minute> returns the exact minute of the system time.
|
Synonyms (Search Aid) | cron |
Group | Core |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/events/core/SystemTimeScriptEvent.java#L11 |
Name | Hurt |
Syntax | hurt (<#.#>) ({player}/<entity>|...) (cause:<cause>) (source:<entity>/<location>) |
Short Description | Hurts the player or a list of entities. |
Full Description | Does damage to a list of entities, or to any single entity.
If no entities are specified: if there is a linked player, the command targets that. If there is no linked player but there is a linked NPC, the command targets the NPC. If neither is available, the command will error. Does a specified amount of damage usually, but, if no damage is specified, does precisely 1HP worth of damage (half a heart). Optionally, specify (source:<entity>) to make the system treat that entity as the attacker. If using a block-type cause such as "contact", you *must* specify (source:<location>) to set that block location as the attacker. The block can be any block, even just "<player.location>" (as long as the player in inside a world). You may also specify a damage cause to fire a proper damage event with the given cause, only doing the damage if the event wasn't cancelled. Calculates the 'final damage' rather than using the raw damage input number. See damage cause for damage causes. Using a valid 'cause' value is best when trying to replicate natural damage, excluding it is best when trying to force the raw damage through. Note that using invalid or impossible causes may lead to bugs |
Related Tags | <EntityTag.health> Returns the current health of the entity.
<EntityTag.last_damage.amount> Returns the amount of the last damage taken by the entity.
<EntityTag.last_damage.cause> Returns the cause of the last damage taken by the entity.
<EntityTag.last_damage.duration> Returns the duration of the last damage taken by the entity.
<EntityTag.last_damage.max_duration> Returns the maximum duration of the last damage taken by the entity.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | damage, injure |
Group | entity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/entity/HurtCommand.java#L31 |
Name | Map |
Syntax | map [<#>/new:<world>] (reset:<location>) (scale:<value>) (tracking) (image:<file>) (resize) (script:<script>) (dot:<color>) (radius:<#>) (x:<#>) (y:<#>) (text:<text>) |
Short Description | Modifies a new or existing map by adding images or text. |
Full Description | This command modifies an existing map, or creates a new one. Using this will override existing non-Denizen map renderers with Denizen's custom map renderer.
You must specify at least one of 'reset', 'script', 'image', 'dot', 'text'. You can specify multiple at once if you prefer. When using 'reset', you can specify optionally 'scale' and/or 'tracking'. When using 'image' you can optionally specify 'resize'. When using 'dot', you can specify any valid ColorTag (it will be compressed to map's color space), and you can optionally also specify 'radius' as a number. Use "radius:0" with dot to set on a single pixel. 1 or higher will make a circle centered on the x/y given. You can reset this at any time by using the 'reset:<location>' argument, which will remove all images and texts on the map and show the default world map at the specified location. You can also specify 'reset' without a location. The 'scale' argument takes input of one of the values listed here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/map/MapView.Scale.html The 'tracking' argument determines if the map will track its location on the map it displays. This is often the player holding the map's location. Note that all maps have a size of 128x128. The file path is relative to the 'plugins/Denizen/images/' folder. Instead of a local file path, an http(s) URL can be used, which will automatically download the image from the URL given. If the file path points to a .gif, the map will automatically be animated. Use escaping to let the image and text arguments have tags based on the player viewing the map. Custom maps will persist over restarts using the 'maps.yml' save file in the Denizen plugins folder. |
Related Tags | <entry[saveName].created_map> returns the map created by the 'new:' argument if used.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | item |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/item/MapCommand.java#L33 |
Name | Permission |
Syntax | permission [add/remove] [permission] (group:<name>) (<world>) |
Short Description | Gives or takes a permission node to/from the player or group. |
Full Description | Adds or removes a permission node from a player or group.
Accepts a world for world-based permissions plugins. By default changes the attached player's permissions. Accepts the 'group:<name>' argument to change a group's permission nodes rather than a player's. Note: This requires a permissions plugin and Vault. |
Related Tags | <PlayerTag.has_permission[permission.node]> Returns whether the player has the specified node. (...)
<PlayerTag.has_permission[permission.node].global> Returns whether the player has the specified node, regardless of world. (...)
<PlayerTag.has_permission[permission.node].world[<world>]> Returns whether the player has the specified node in regards to the (...)
<server.has_permissions> Returns whether the server has a known permission plugin loaded. (...)
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | player |
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/player/PermissionCommand.java#L24 |
Name | region |
Syntax | region [{add} <cuboid>/remove <world>] [id:<name>] |
Short Description | Adds or removes a protected region. |
Full Description | Adds a protected region to a region manager based on the specified cuboid,
or removes a protected region from a region manager based on the specified world. Currently, this command only supports cuboid-shaped regions. |
Related Tags | None
|
Usage Example |
|
Usage Example |
|
Group | Depenizen |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/commands/worldguard/RegionCommand.java#L27 |
Name | Remove |
Syntax | remove [<entity>|...] (world:<world>) |
Short Description | Despawns an entity or list of entities, permanently removing any NPCs. |
Full Description | Removes the selected entity. May also take a list of entities to remove.
Any NPC removed this way is completely removed, as if by '/npc remove'. For temporary NPC removal, see despawn. If a generic entity name is given (like 'zombie'), this will remove all entities of that type from the given world. Optionally, you may specify a world to target. (Defaults to the world of the player running the command) |
Related Tags | <EntityTag.is_spawned> Returns whether the entity is spawned.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | entity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/entity/RemoveCommand.java#L28 |
Name | Teleport |
Syntax | teleport (<entity>|...) [<location>] (cause:<cause>) (entity_options:<option>|...) (relative) (relative_axes:<axis>|...) (offthread_repeat:<#>) (offthread_yaw) (offthread_pitch) |
Short Description | Teleports the entity(s) to a new location. |
Full Description | Teleports the entity or entities to the new location.
Entities can be teleported between worlds using this command. You may optionally specify a teleport cause for player entities, allowing proper teleport event handling. When not specified, this is "PLUGIN". See teleport cause for causes. Instead of a valid entity, an unspawned NPC or an offline player may also be used. Optionally specify "relative" to use relative teleportation (Paper only). This is primarily useful only for players, but available for all entities. Relative teleports are smoother for the client when teleporting over short distances. Optionally, you may use "relative_axes:" to specify a set of axes to move relative on (and other axes will be treated as absolute), as any of "X", "Y", "Z", "YAW", "PITCH". Optionally, you may use "offthread_repeat:" with the relative arg when teleporting a player to smooth out the teleport with a specified number of extra async packets sent within a single tick. Optionally, specify "offthread_yaw" or "offthread_pitch" while using offthread_repeat to smooth the player's yaw/pitch to the new location's yaw/pitch. Optionally, specify additional teleport options using the 'entity_options:' arguments (Paper only). This allows things like retaining an open inventory when teleporting - see the links below for more information. See https://jd.papermc.io/paper/1.19/io/papermc/paper/entity/TeleportFlag.EntityState.html for all possible options. Note that the API this is based on is marked as experimental in Paper, and so may change in the future. |
Related Tags | <EntityTag.location> Returns the location of the entity. (...)
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | tp |
Group | entity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/entity/TeleportCommand.java#L39 |
Name | Wait |
Syntax | wait (<duration>) (queue:<name>) (system/{delta}) |
Short Description | Delays a script for a specified amount of time. |
Full Description | Pauses the script queue for the duration specified. If no duration is specified it defaults to 3 seconds.
Accepts the 'queue:<name>' argument which allows the delay of a different queue. Accepts a 'system' argument to delay based on system time (real-world time on a clock). When that argument is not used, waits based on delta time (in-game time tracking, which tends to vary by small amounts, especially when the server is lagging). Generally, do not use the 'system' argument unless you have a specific good reason you need it. |
Related Tags | <QueueTag.speed> Returns the speed of the queue as a Duration. A return of '0' implies it is 'instant'. (...)
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | delay |
Group | queue |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/queue/WaitCommand.java#L22 |
Name | Yaml |
Syntax | yaml [create]/[load:<file>]/[loadtext:<text> raw_format]/[unload]/[savefile:<file>]/[copykey:<source_key> <target_key> (to_id:<name>)]/[set <key>([<#>])(:<action>):<value> (data_type:{string}/integer/double/boolean/auto)] [id:<name>] |
Short Description | Edits YAML data, especially for YAML files. |
Full Description | Edits YAML configuration data.
This commands exists primarily for interoperability with pre-existing data files and other plugins. It should never be used for storing data that only Denizen needs to use. Consider instead using flag. Use waitable syntax ("- ~yaml load:...") with load or savefile actions to avoid locking up the server during file IO. Refer to ~waitable. For loading and saving, the starting path is within 'plugins/Denizen'. The file path follows standard system file path rules. That means '/' separators folders, and '..' as a folder name means go-up-one folder, for example '../WorldGuard/config.yml' would load the WorldGuard plugin config. Also be aware that some servers (Linux/Mac based) have case sensitive file systems while others (Windows based) don't. Generally, when using existing paths, make sure your casing is correct. When creating new paths, prefer all-lowercase to reduce risk of issues. Please note that all usages of the YAML command except for "load" and "savefile" arguments are purely in memory. That means, if you use "set" to make changes, those changes will not be saved to any file, until you use "savefile". Similarly, "create" does not create any file, instead it only creates a YAML object in RAM. When loading, optionally specify 'raw_format' to indicate that this YAML file needs to maintain compatibility with some external system using raw YAML data (for example, when altering YAML data files used by external plugins). Note that this can have side effects of custom data disappearing (for example, the value "yes" gets magically converted to "true") or strange data parsing in. In-memory changes to a loaded YAML object will mark that object as having changes. Before saving, you can check whether the YAML object needs to be written to disk with the has_changes tag. Note that the '.yml' extension is not automatically appended, and you will have to include that in filenames. All usages of the YAML command must include the "id:" argument. This is any arbitrary name, as plaintext or from a tag, to uniquely and globally identify the YAML object in memory. This ID can only be used by one YAML object at a time. IDs are stored when "create" or "load" arguments are used, and only removed when "unload" is used. If, for example, you have a unique YAML data container per-player, you might use something like "id:myscript_<player>". For ways to use the "set" argument, refer to data actions. When setting a value directly, you can optionally specify "data_type" as "string", "integer", "double", "boolean", or "auto", to force the input to a specific data type, which may be needed for compatibility with some external YAML files. Only applicable when setting a single value, not lists/maps/etc. 'Auto' will attempt to choose the best type for the value. |
Related Tags | <yaml[<idname>].contains[<path>]> Returns true if the file has the specified path. (...)
<yaml[<idname>].read[<path>]> Returns the value from a data key on the YAML document as an ElementTag, ListTag, or MapTag.
<yaml[<idname>].list_keys[<path>]> Returns a ListTag of all the keys at the path (and not sub-keys). (...)
<yaml[<idname>].has_changes> Returns whether this YAML object has had changes since the last save or load.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | file |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/file/YamlCommand.java#L44 |
Name | entity enters|exits area |
Event Lines | <entity> enters|exits <area> |
Triggers | when an entity enters or exits a noted area (cuboid, ellipsoid, or polygon). On Spigot servers, only fires for players. Paper is required for other mob types. |
Generated Examples | on entity enters area:
on ominous_item_spawner exits area: |
Has Player | When the entity is a player. - this adds switches 'flagged:<flag name>' + 'permission:<node>', in addition to the '<player>' link. |
Contexts | <context.area> returns the area object that was entered or exited.
<context.cause> returns the cause of the event. Can be: WALK, WORLD_CHANGE, JOIN, QUIT, TELEPORT, VEHICLE.
<context.to> returns the location the entity moved to (might not be available in exit events).
<context.from> returns the location the entity moved from (when available, depending on cause).
<context.entity> returns the entity that entered/exited an area.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Group | Entity |
Warning(s) | cancelling this event will have different results depending on the cause. Teleporting the entity away 1 tick later might be safer. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/entity/AreaEnterExitScriptEvent.java#L29 |
Name | entity teleported by portal |
Event Lines | <entity> teleported by portal |
Triggers | When an entity is about to be teleported by a portal (currently only fires for nether portals). |
Generated Examples | on entity teleported by portal:
on item_frame teleported by portal: |
Switches | to:<world> to only process the event if the world the entity is being teleported to matches the specified WorldTag matcher.
portal_type:<type> to only process the event if the portal's type matches the specified portal type. |
Contexts | <context.entity> returns an EntityTag of the entity being teleported.
<context.target_world> returns a WorldTag of the world the entity is being teleported to.
<context.portal_type> returns an ElementTag of the portal's type. Will be one of https://jd.papermc.io/paper/1.19/org/bukkit/PortalType.html.
|
Determine | "TARGET_WORLD:<WorldTag>" to set the world the entity will be teleported to.
"REMOVE_TARGET_WORLD" to remove the target world. Should usually cancel the event instead of using this. |
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/events/EntityTeleportedByPortalScriptEvent.java#L14 |
Name | player right clicks entity |
Event Lines | player right clicks <entity> |
Triggers | when a player right clicks on an entity. |
Generated Examples | on player right clicks item_display:
after player right clicks pufferfish: |
Has Player | Always. - this adds switches 'flagged:<flag name>' + 'permission:<node>', in addition to the '<player>' link. |
Switches | with:<item> to only process the event when the player is holding a specified item.
type:<entity> to only run if the entity clicked matches the entity input. |
Contexts | <context.entity> returns the EntityTag the player is clicking on.
<context.item> returns the ItemTag the player is clicking with.
<context.hand> returns "offhand" or "mainhand" to indicate which hand was used to fire the event. Some events fire twice - once for each hand.
<context.click_position> returns a LocationTag of the click position (as a world-less vector, relative to the entity's center). This is only available when clicking armor stands.
|
Cancellable | True - This adds <context.cancelled> and determine 'cancelled' or 'cancelled:false' |
Has Location | True - This adds the switches 'in:<area>', 'location_flagged:<flag>', ... |
Group | Player |
Warning(s) | this event may in some cases double-fire, requiring usage of the 'ratelimit' command (like 'ratelimit <player> 1t') to prevent doubling actions. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/player/PlayerRightClicksEntityScriptEvent.java#L21 |
Name | /npc constant command |
Description | The /npc constants command configures a NPC's constants. Uses Denizen's ConstantTrait to keep track of
NPC-specific constants. This provides seamless integration with an assignment script's 'Default Constants' in which text variables can be stored and retrieved with the use of 'replaceable tags', or API. Constants set at the NPC level override any constants from the NPC's assignment script. Constants may be used in several ways: Setting, Removing, and Viewing To set a constant, all that is required is a name and value. Use the Bukkit command in the following manner: (Note the use of quotes on multi world values) /npc constant --set constant_name --value 'multi word value' Removing a constant from an NPC only requires a name. Note: It is not possible to remove a constant set by the NPCs Assignment Script, except by modifying the script itself. /npc constant --remove constant_name Viewing constants is easy, just use '/npc constant #', specifying a page number. Constants which have been overridden by the NPC are formatted with a strike-through to indicate this case. To reference a constant value, use the replaceable tag to get the NPCs 'constant' attribute. For example: <npc.constant[constant_name]>. Constants may also have other tags in their value, which will be replaced whenever the constant is used, allowing the use of dynamic information. |
Group | Console Commands |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/command/NPCCommandHandler.java#L117 |
Name | Advanced Object Matchables |
Description | Script events have a variety of matchable object inputs, and the range of inputs they accept may not always be obvious.
For example, an event might be "player clicks <block>"... what can "<block>" be filled with? "<block>" usually indicates that a LocationTag and/or MaterialTag will be matched against. This means you can specify any valid block material name, like "stone" or "air", like "on player clicks stone:" (will only run the event if the player is clicking stone) You can also use a catch-all such as "block", like "on player clicks block:" (will always run the event when the player clicks anything/anywhere) You can also use some more complicated matchables such as "vanilla_tagged:", like "on player clicks vanilla_tagged:mineable/axe:" (will run if the block is mineable with axes) (For more block-related options, refer to the LocationTag and MaterialTag matchers lists.) Many object types can be used for matchables, the valid inputs are unique depending on the object type involved. Some inputs don't refer to any object at all - they're just advanced matchers for some generic plaintext, for example "<cause>" implies an enumeration of causes will be matched against. Many inputs support advanced matchers. For details on that, see Advanced Object Matching. A common matchable type found among different objects is a Flag Matchable. This usually looks like "item_flagged:<flag>" This matches if the object has the specified flag, and fails to match if the object doesn't have that flag. You can specify multiple required flags with '|', like "item_flagged:a|b|c", which will match if-and-only-if the item has ALL the flags named. They can also be used to require the object does NOT have the flag with a "!" like "item_flagged:!<flag>". When using multiple flags with "|", the "!" is per-entry, so "item_flagged:!a|b" requires the item DOES have 'b' but does NOT have 'a'. Note also that in addition to events, tags often also have matchables as input params, usually documented like ".types[<matcher>]", with tag documentation specifying what matcher is used, or like "<material_matcher>" to indicate in this example specifically MaterialTag matchables are allowed. Not all object types have defined matchable options, and those that do list them in their ObjectType meta. For an example of this, check ItemTag. As a special case, "in:<area>" style matchable listings in event conform to the following option set: "biome:<name>": matches if the location is in a given biome, using advanced matchers. "cuboid" plaintext: matches if the location is in any noted cuboid. "ellipsoid" plaintext: matches if the location is in any noted ellipsoid. "polygon" plaintext: matches if the location is in any noted polygon. "chunk_flagged:<flag>": a Flag Matchable for ChunkTag flags. "area_flagged:<flag>": a Flag Matchable for AreaObject flags. Area note name: matches if an AreaObject note that matches the given advanced matcher contains the location. If none of the above are used, uses WorldTag matchers. |
Group | Object System |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/BukkitScriptEvent.java#L45 |
Name | Assignment Script Containers |
Description | Assignment script-containers provide functionality to NPCs by 'assignment' of the container. Assignment
scripts are meant to be used when customizing the normal behavior of NPCs. This can be used on a 'per-NPC' basis, but the encouraged approach is to design assignment scripts in a way that they can be used for multiple NPCs, perhaps with the use of constants or flags to determine specific information required by the scripts. Features unique to assignment script-containers include 'actions' and 'interact script' assignment. Like any script, the ability to run local utility scripts can be accomplished as well. This allows fully interactive NPCs to be built purely with Assignment Scripts, and for advanced situations, world scripts and interact scripts can provide more functionality. See also interact script containers Assignments scripts can be automatically disabled by adding "enabled: false" as a root key (supports any load-time-parseable tags). This will disable any "actions" on the script (but not interact scripts steps - disable the interact for that). Basic structure of an assignment script:
Though note that almost always you should include the 'actions:' key, usually with the 'on assignment:' action (if using triggers). Refer to assignment. |
Group | Script Container System |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/containers/core/AssignmentScriptContainer.java#L13 |
Name | Economy Script Containers |
Description | Economy script containers
Economy script containers provide a Vault economy, which can be used in scripts by PlayerTag.money and money and as well by any other plugin that relies on economy functionality (such as shop plugins). Note that vault economy bank systems are not currently supported. Per-world economies are also not currently supported. Note that in most cases, you do not want to have multiple economy providers, as only one will actually be in use. ALL SCRIPT KEYS ARE REQUIRED. Economy scripts can be automatically disabled by adding "enabled: false" as a root key (supports any load-time-parseable tags).
|
Group | Script Container System |
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/containers/core/EconomyScriptContainer.java#L32 |
Name | Enchantment Script Containers |
Description | Enchantment script containers allow you to register custom item enchantments.
For the most part, they work similarly to vanilla enchantments, albeit with some limitations. These can be attached to enchanted books and used in anvils, and can be generated by the enchanting table (requires discoverable: true and treasure_only: false). In current implementation, custom enchantments do not appear in lore on their own, and will need fake lore added in their place. This might be fixed in the future. It may be beneficial in some cases to restart your server after making changes to enchantments, rather than just reloading scripts. Rarity, Category, and Slots do not apply changes to an already-loaded script until the next restart (except when the script is newly added). Using these may cause unpredictable compatibility issues with external plugins. Enchantment scripts can be automatically disabled by adding "enabled: false" as a root key (supports any load-time-parseable tags).
|
Group | Script Container System |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/containers/core/EnchantmentScriptContainer.java#L33 |
Name | Inventory Actions |
Description | Used by some inventory world events to describe the action of the inventory event.
Actions, as described by the bukkit javadocs: CLONE_STACK A max-size stack of the clicked item is put on the cursor. COLLECT_TO_CURSOR The inventory is searched for the same material, and they are put on the cursor up to MaterialTag.max_stack_size. DROP_ALL_CURSOR The entire cursor item is dropped. DROP_ALL_SLOT The entire clicked slot is dropped. DROP_ONE_CURSOR One item is dropped from the cursor. DROP_ONE_SLOT One item is dropped from the clicked slot. HOTBAR_MOVE_AND_READD The clicked item is moved to the hotbar, and the item currently there is re-added to the player's inventory. HOTBAR_SWAP The clicked slot and the picked hotbar slot are swapped. MOVE_TO_OTHER_INVENTORY The item is moved to the opposite inventory if a space is found. NOTHING Nothing will happen from the click. PICKUP_ALL All of the items on the clicked slot are moved to the cursor. PICKUP_HALF Half of the items on the clicked slot are moved to the cursor. PICKUP_ONE One of the items on the clicked slot are moved to the cursor. PICKUP_SOME Some of the items on the clicked slot are moved to the cursor. PLACE_ALL All of the items on the cursor are moved to the clicked slot. PLACE_ONE A single item from the cursor is moved to the clicked slot. PLACE_SOME Some of the items from the cursor are moved to the clicked slot (usually up to the max stack size). SWAP_WITH_CURSOR The clicked item and the cursor are exchanged. UNKNOWN An unrecognized ClickType. |
Group | Useful Lists |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/player/PlayerClicksInInventoryScriptEvent.java#L20 |
Name | Map Script Containers |
Description | Map scripts allow you define custom in-game map items, for usage with the map command.
The following is the format for the container.
A list of cursor types is available through server.map_cursor_types. |
Group | Script Container System |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/containers/core/MapScriptContainer.java#L23 |
Name | ObjectTags |
Description | ObjectTags are a system put into place by Denizen that make working with things, or 'objects',
in Minecraft and Denizen easier. Many parts of scripts will require some kind of object as an argument, identifier/type, or such as in world events, part of an event name. The ObjectTags notation system helps both you and Denizen know what type of objects are being referenced and worked with. So when should you use ObjectTags? In arguments, event names, replaceable tags, configs, flags, and more! If you're just a beginner, you've probably been using them without even realizing it! ObjectTag is a broader term for a 'type' of object that more specifically represents something, such as a LocationTag or ScriptTag, often times just referred to as a 'location' or 'script'. Denizen employs many object types that you should be familiar with. You'll notice that many times objects are referenced with their 'ObjectTag notation' which is in the format of 'x@', the x being the specific notation of an object type. Example: player objects use the p@ notation, and locations use l@. This notation is automatically generated when directly displaying objects, or saving them into data files. It should never be manually typed into a script. Let's take the tag system, for example. It uses the ObjectTags system pretty heavily. For instance, every time you use <player.name> or <npc.id>, you're using a ObjectTag, which brings us to a simple clarification: Why <player.name> and not <PlayerTag.name>? That's because Denizen allows Players, NPCs and other 'in-context objects' to be linked to certain scripts. In short, <player> already contains a reference to a specific player, such as the player that died in a world event 'on player dies'. <PlayerTag.name> is instead the format for documentation, with "PlayerTag" simply indicating 'any player object here'. ObjectTags can be used to CREATE new instances of objects, too! Though not all types allow 'new' objects to be created, many do, such as ItemTags. With the use of tags, it's easy to reference a specific item, say -- an item in the Player's hand -- items are also able to use a constructor to make a new item, and say, drop it in the world. Take the case of the command/usage '- drop diamond_ore'. The item object used is a brand new diamond_ore, which is then dropped by the command to a location of your choice -- just specify an additional location argument. There's a great deal more to learn about ObjectTags, so be sure to check out each object type for more specific information. While all ObjectTags share some features, many contain goodies on top of that! |
Group | Object System |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/utilities/CommonRegistries.java#L29 |
Name | Procedure Script Containers |
Description | Procedure script containers are used to define a script that can be ran through a tag.
Generally called via proc or proc.context. The only required key is 'script:'. Note that procedure scripts must NEVER change external state. That is, a procedure script cannot change anything at all, ONLY determine a value. Setting a flag, loading a YAML document, placing a block, etc. are all examples of external changes that are NOT allowed. This restriction comes from two main reasons: - Tags run in arbitrary conditions. They may be read asynchronously or in other weird circumstances that can result in applied changes crashing your server or other unexpected side effects. - Tags can run for a variety of reasons. If you were to make a proc script 'spawn_entity' that actually spawns an entity into the world, you would likely end up with a *lot* of unintentional entity spawns. Some tags will be read multiple times when theoretically ran once, in some circumstances a tag read might even be based on user input! (Particularly if you ever make use of the '.parsed' tag, or the list.parse/filter/sort_by_number tags). Imagine if for example, a tag can be read when users input a specific custom command, and a clever user finds out they can type "/testcommand 32 <proc[spawn_entity].context[creeper]>" to spawn a creeper ... that would be a major problem! In general, maximum caution is the best for situations like this... simply *never* make a procedure that executes external changes.
|
Group | Script Container System |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/containers/core/ProcedureScriptContainer.java#L9 |
Name | Script |
Description | A somewhat vague term used to describe a collection of script entries and other script parts.
For example, 'Hey, check out this script I just wrote!', probably refers to a collection of script entries that make up some kind of script container. Perhaps it is a NPC Assignment Script Container that provides waypoint functionality, or a world script that implements and keeps track of a new player stat. 'Script' can refer to a single container, as well as a collection of containers that share a common theme. Scripts that contain a collection of containers are typically kept to a single file. Multiple containers are permitted inside a single file, but it should be noted that container names are stored on a global level. That is, naming scripts should be done with care to avoid duplicate script names. |
Group | Denizen Scripting Language |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L28 |
Name | Script Event After vs On |
Description | Modern ScriptEvents let you choose between "on" and "after".
An "on" event looks like "on player breaks block:" while an "after" event looks like "after player breaks block:". An "on" event fires *before* the event actually happens in the world. This means some relevant data won't be updated (for example, "<context.location.material>" would still show the block type that is going to be broken) and the result of the event can be changed (eg the event can be cancelled to stop it from actually going through). An "after" event, as the name implies, fires *after* the event actually happens. This means data will be already updated to the new state (so "<context.location.material>" would now show air) but could potentially contain an arbitrary new state from unrelated changes (for example "<context.location.material>" might now show a different block type, or the original one, if the event was changed, or another thing happened right after the event but before the 'after' event ran). This also means you cannot affect the outcome of the event at all (you can't cancel it or anything else - the "determine" command does nothing). See also Safety In Events |
Group | Script Events |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/events/ScriptEvent.java#L361 |
Name | Script Syntax |
Description | The syntax of Denizen is broken into multiple abstraction layers.
At the highest level, Denizen scripts are stored in script files, which use the '.dsc' suffix Denizen script syntax is approximately based on YAML configuration files, and is intended to seem generally as easy to edit as a YAML configuration. However, several key differences exist between the Denizen script syntax and YAML syntax. In particular, there are several changes made to support looser syntax rules and avoid some of the issues that would result from writing code directly into a plain YAML file. Within those 'script files' are 'script containers', which are the actual unit of separating individual 'scripts' apart. (Whereas putting containers across different files results in no actual difference: file and folder separation is purely for your own organization, and doesn't matter to the Denizen parser). Each script container has a 'type' such as 'task' or 'world' that defines how it functions. Within a script container are individual script paths, such as 'script:' in a 'task' script container, or 'on player breaks block:' which might be found within the 'events:' section of a 'world' script container. These paths are the points that might actually be executed at any given time. When a path is executed, a 'script queue' is formed to process the contents of that script path. Within any script path is a list of 'script entries', which are the commands to be executed. These can be raw commands themselves (like 'narrate') with their arguments, or commands that contain additional commands within their entry (as 'if' and 'foreach' for example both do). |
Group | Denizen Scripting Language |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L54 |
Name | Unique Objects vs Generic Objects |
Description | There are a lot of object types in the Denizen object system, and not all of them behave the same way.
It can be useful to separate object types into categories to better understand how objects work, and how Denizen as a whole works. While there are some hardlined separations, there are also some generalizations that don't necessarily hold exactly, but are still helpful. One such generalization is the separation between Unique and Generic object types. A UNIQUE object is the way you might assume all objects are. Unique objects most notably include EntityTag objects and the derivative NPCTag / PlayerTag objects. An entity object identifies in a form like 'e@<uuid>', where '<uuid>' is some unique ID that looks something like 'abc123-4d5e6f'. This ID is randomly generated by the Minecraft server and is used to identify that one entity in the world separately from any other. 'e@abc123' is not "a creeper" to the engine, it is "that specific creeper over there". An object that is unique must have some way to specify the exact single instance of it in the world, like the UUID used by entities. A GENERIC object can be said to be a 'description' of a unique object. A generic form of an EntityTag might look like 'e@creeper'. Instead of "that specific creeper over there", it is instead "the concept of a creeper mob". There is no way for the engine to read only the word 'creeper' and find out which specific creeper in the world it came from... it could be any of them, there's often hundreds of creepers spawned somewhere in the world at any time. Objects like items and materials are always generic. There is no unique identifier for any item, there is only the description. An item usually looks something like 'i@stick'. ItemTag objects can include more detail, like 'i@stick[lore=hi;display_name=My Stick;enchantments=[sharpness=5]]'... but this is still just a description, and there could still be many items out there that match this description. The consequences of this mostly relate to: - How you adjust an object (eg change the lore of an item, or teleport an entity). For example: you can't teleport the generic concept of a creeper, but you can certainly teleport a specific single creeper in the world. - How reliable tags on the object are. For example: the result of 'ItemTag.lore' on the item 'i@stick[lore=hi]' will always be 'hi' (because ItemTags are generic), but the result of 'EntityTag.location' on the entity 'e@abc123' will change every tick as the entity moves, or even become invalid if the entity dies (because that EntityTag is unique). Here's where the separation gets muddy: First, as mentioned, an EntityTag can either be unique ('e@abc123', 'n@42', etc.) OR generic ('e@creeper', 'e@zombie[custom_name=Bob]', etc). Second, some object types exhibit a bit of both. For example, a LocationTag refers to a unique block in the world (like, 'l@1,2,3,world' is always that specific block at that position), but also is a generic object in terms of the location object itself - if for example you want to change the angle of a location, you have to essentially 'create' a new location, that is an exact copy of the previous one but with a new yaw or pitch value. |
Group | Object System |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/ObjectTag.java#L43 |
Name | Virtual Inventories |
Description | Virtual inventories are inventories that have no attachment to anything within the world of Minecraft.
They can be used for a wide range of purposes - from looting fallen enemies to serving as interactive menus with item 'buttons'. In Denizen, all noted inventories (saved by the Note command) are automatically converted into a virtual copy of the saved inventory. This enables you to open and edit the items inside freely, with automatic saving, as if it were a normal inventory. Noting is not the only way to create virtual inventories, however. Using 'generic' along with inventory properties will allow you to create temporary custom inventories to do with as you please. The properties that can be used like this are: size=<size> contents=<item>|... title=<title> holder=<inventory type> For example, the following task script opens a virtual inventory with 18 slots, where the second slot is a snowball, all the rest are empty, and the title is "My Awesome Inventory" with some colors in it.
|
Group | Inventory System |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/item/InventoryCommand.java#L65 |
Name | regenerate |
Object | ChunkTag |
Input | None |
Description | Causes the chunk to be entirely deleted and reformed from the world's seed.
At time of writing this method only works as expected on Paper, and will error on Spigot. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L889 |
Name | auto_expire |
Object | EntityTag |
Input | ElementTag(Boolean) |
Related Tags | <EntityTag.auto_expire> Returns whether a falling_block will auto-expire (after 30 seconds, or 5 when outside the world). (...)
|
Description | Sets whether a falling_block will auto-expire (after 30 seconds, or 5 when outside the world).
See also EntityTag.time_lived |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityAutoExpire.java#L76 |
Name | explored_locations |
Object | EntityTag |
Input | ListTag(LocationTag) |
Related Tags | <EntityTag.explored_locations> (Property) Returns a sniffer's explored locations.
|
Description | (Property) Sets a sniffer's explored locations.
Note that if the sniffer is not in the same world as the input LocationTag(s), then the LocationTag(s) will not be added to the list of explored locations. |
Group | Properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/entity/EntityExploredLocations.java#L11 |
Name | left_shoulder |
Object | EntityTag |
Input | EntityTag |
Related Tags | <EntityTag.left_shoulder> Returns the entity on the entity's left shoulder. (...)
|
Description | Sets the entity's left shoulder entity.
Only applies to player-typed entities. Provide no input to remove the shoulder entity. NOTE: This mechanism will remove the current shoulder entity from the world. Also note the client will currently only render parrot entities. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L3667 |
Name | right_shoulder |
Object | EntityTag |
Input | EntityTag |
Related Tags | <EntityTag.right_shoulder> Returns the entity on the entity's right shoulder. (...)
|
Description | Sets the entity's right shoulder entity.
Only applies to player-typed entities. Provide no input to remove the shoulder entity. NOTE: This mechanism will remove the current shoulder entity from the world. Also note the client will currently only render parrot entities. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L3691 |
Name | full_render |
Object | ItemTag |
Input | ElementTag |
Related Tags | <ItemTag.map> Returns the ID number of the map item's map.
<ItemTag.map_scale> Returns the scale of the map, from 0 (smallest) to 4 (largest).
|
Description | Fully renders all or part of a map item's view of the world.
Be warned that this can run very slowly on large maps. Input can be nothing to render the full map, or a comma separated set of integers to render part of the map, in format x1,z1,x2,z2. Input numbers are pixel indices within the map image - so, any integer from 0 to 128. The input for a full map render would be 0,0,128,128. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L167 |
Name | fake_op_level |
Object | PlayerTag |
Input | ElementTag(Number) |
Description | Sends a fake operator level to the client, enabling clientside op-required features like the debug gamemode hotkey (F3+F4).
Input should be a number from 0 to 4, 0 indicating not op and 4 indicating maximum level op. The input number value corresponds to "op-permission-level" in the server.properties. See also https://minecraft.wiki/w/Permission_level This will be reset when a player rejoins, changes world, has their real op status changed, ... |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L134 |
Name | redirect_logging |
Object | system |
Input | ElementTag(Boolean) |
Description | Tells the server to redirect logging to a world event or not.
Note that this redirects *all console output* not just Denizen output. Note: don't enable /denizen debug -e while this is active. Requires config file setting "Debug.Allow console redirection"! |
Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/tags/core/UtilTagBase.java#L1005 |
Name | AreaObject |
Prefix | None |
Identity Format | N/A |
Description | "AreaObject" is a pseudo-ObjectType that represents any object that indicates a world-space area, such as a CuboidTag. |
Matchable | AreaObject matchers (applies to CuboidTag, EllipsoidTag, PolygonTag, ...), sometimes identified as "<area>":
"cuboid" plaintext: matches if the area is a CuboidTag. "ellipsoid" plaintext: matches if the area is an EllipsoidTag. "polygon" plaintext: matches if the area is a PolygonTag. "area_flagged:<flag>": a Flag Matchable for AreaObject flags. Area note name: matches if the AreaObject's note name matches the given advanced matcher. |
Extended By | CuboidTag, EllipsoidTag, PolygonTag |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/AreaContainmentObject.java#L28 |
Name | BiomeTag |
Prefix | b@ |
Base Type | ElementTag |
Implements | FlaggableObject |
Identity Format | The identity format for biomes is a world name, then a comma, then the biome key. For example: 'hub,desert', or 'space,minecraft:desert'. |
Description | A BiomeTag represents a world biome type. Vanilla biomes are globally available, however some biomes are world-specific when added by datapacks.
A list of all vanilla biomes can be found at https://minecraft.wiki/w/Biome#Biome_IDs. BiomeTags without a specific world will work as though they are in the server's default world. This object type is flaggable. Flags on this object type will be stored in the server saves file, under special sub-key "__biomes" |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L33 |
Name | ChunkTag |
Prefix | ch@ |
Base Type | ElementTag |
Implements | FlaggableObject |
Identity Format | The identity format for chunks is <x>,<z>,<world>
For example, 'ch@5,3,world'. |
Description | A ChunkTag represents a chunk in the world.
Note that the X/Z pair are chunk coordinates, not block coordinates. To convert from block coordinates to chunk coordinates, divide by 16 and round downward. Note that negative chunks are one unit lower than you might expect. To understand why, simply look at chunks on a number line... x x x x x -2 -1 b 0 a 1 2 The block 'a' at block position '1' is in chunk '0', but the block 'b' at block position '-1' is in chunk '-1'. As otherwise (if 'b' was in chunk '0'), chunk '0' would be double-wide (32 blocks wide instead of the standard 16). For example, block at X,Z 32,67 is in the chunk at X,Z 2,4 And the block at X,Z -32,-67 is in the chunk at X,Z -2,-5 This object type is flaggable. Flags on this object type will be stored in the chunk file inside the world folder. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L33 |
Name | CuboidTag |
Prefix | cu@ |
Base Type | ElementTag |
Implements | FlaggableObject, AreaObject |
Identity Format | The identity format for cuboids is <world>,<x1>,<y1>,<z1>,<x2>,<y2>,<z2>
Multi-member cuboids can simply continue listing x,y,z pairs. For example, 'cu@space,1,2,3,4,5,6'. |
Description | A CuboidTag represents a cuboidal region in the world.
The word 'cuboid' means a less strict cube. Basically: a "cuboid" is to a 3D "cube" what a "rectangle" is to a 2D "square". One 'cuboid' consists of two points: the low point and a high point. a CuboidTag can contain as many cuboids within itself as needed (this allows forming more complex shapes from a single CuboidTag). Note that the coordinates used are inclusive, meaning that a CuboidTag always includes the blocks identified as the low and high corner points. This means for example that a cuboid from "5,5,5" to "5,5,5" will contain one full block, and have a size of "1,1,1". This object type can be noted. This object type is flaggable when it is noted. Flags on this object type will be stored in the notables.yml file. |
Matchable | Refer to areaobject's matchable list. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/CuboidTag.java#L35 |
Name | EllipsoidTag |
Prefix | ellipsoid@ |
Base Type | ElementTag |
Implements | FlaggableObject, AreaObject |
Identity Format | The identity format for ellipsoids is <x>,<y>,<z>,<world>,<x-radius>,<y-radius>,<z-radius>
For example, 'ellipsoid@1,2,3,space,7,7,7'. |
Description | An EllipsoidTag represents an ellipsoidal region in the world.
The word 'ellipsoid' means a less strict sphere. Basically: an "ellipsoid" is to a 3D "sphere" what an "ellipse" (or "oval") is to a 2D "circle". This object type can be noted. This object type is flaggable when it is noted. Flags on this object type will be stored in the notables.yml file. |
Matchable | Refer to areaobject's matchable list. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L29 |
Name | EntityTag |
Prefix | e@ |
Base Type | ElementTag |
Implements | FlaggableObject, PropertyHolderObject |
Identity Format | The identity format for entities is a spawned entity's UUID, or an entity type.
For example, 'e@abc123' or 'e@zombie'. |
Description | An EntityTag represents a spawned entity, or a generic entity type.
Note that players and NPCs are valid EntityTags, but are generally represented by the more specific PlayerTag and NPCTag objects. Note that a spawned entity can be a living entity (a player, NPC, or mob) or a nonliving entity (a painting, item frame, etc). This object type is flaggable. Flags on this object type will be stored in the world chunk files as a part of the entity's NBT. |
Matchable | EntityTag matchers, sometimes identified as "<entity>", "<projectile>", or "<vehicle>":
"entity" plaintext: always matches. "player" plaintext: matches any real player (not NPCs). "npc" plaintext: matches any Citizens NPC. "vehicle" plaintext: matches for any vehicle type (minecarts, boats, horses, etc). "fish" plaintext: matches for any fish type (cod, pufferfish, etc). "projectile" plaintext: matches for any projectile type (arrow, trident, fish hook, snowball, etc). "hanging" plaintext: matches for any hanging type (painting, item_frame, etc). "monster" plaintext: matches for any monster type (creepers, zombies, etc). "animal" plaintext: matches for any animal type (pigs, cows, etc). "mob" plaintext: matches for any mob type (creepers, pigs, etc). "living" plaintext: matches for any living type (players, pigs, creepers, etc). "vanilla_tagged:<tag_name>": matches if the given vanilla tag applies to the entity. Allows advanced matchers, for example: "vanilla_tagged:axolotl_*". "entity_flagged:<flag>": a Flag Matchable for EntityTag flags. "player_flagged:<flag>": a Flag Matchable for PlayerTag flags (will never match non-players). "npc_flagged:<flag>": a Flag Matchable for NPCTag flags (will never match non-NPCs). "npc_<type>": matches if the NPC is the given entity type (like "npc_cow" or "npc_mob" or "npc_player"). Any entity type name: matches if the entity is of the given type, using advanced matchers. |
Extended By | NPCTag, PlayerTag |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L68 |
Name | FlaggableObject |
Prefix | None |
Identity Format | N/A |
Description | "FlaggableObject" is a pseudo-ObjectType that represents any type of object that can hold flags,
for use with flag or any other flag related tags and mechanisms. Just because an ObjectType implements FlaggableObject, does not mean a specific instance of that object type is flaggable. For example, LocationTag implements FlaggableObject, but a LocationTag-Vector (a location without a world) cannot hold a flag. |
Extended By | GriefPreventionClaimTag, NationTag, TownTag, DiscordBotTag, DiscordChannelTag, DiscordCommandTag, DiscordGroupTag, DiscordInteractionTag, DiscordMessageTag, DiscordReactionTag, DiscordRoleTag, DiscordUserTag, BiomeTag, ChunkTag, CuboidTag, EllipsoidTag, EnchantmentTag, EntityTag, InventoryTag, ItemTag, LocationTag, MaterialTag, NPCTag, PlayerTag, PluginTag, PolygonTag, WorldTag, QueueTag, ScriptTag, TimeTag |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/flags/FlaggableObject.java#L7 |
Name | InventoryTag |
Prefix | in@ |
Base Type | ElementTag |
Implements | FlaggableObject, PropertyHolderObject |
Identity Format | The identity format for inventories is the classification type of inventory to use. All other data is specified through properties. |
Description | An InventoryTag represents an inventory, generically or attached to some in-the-world object.
Inventories can be generically designed using inventory script containers, and can be modified using the inventory command. Valid inventory type classifications: "npc", "player", "crafting", "enderchest", "workbench", "entity", "location", "generic" This object type can be noted. This object type is flaggable when it is noted. Flags on this object type will be stored in the notables.yml file. |
Matchable | InventoryTag matchers, sometimes identified as "<inventory>":
"inventory" plaintext: always matches. "note" plaintext: matches if the inventory is noted. Inventory script name: matches if the inventory comes from an inventory script of the given name, using advanced matchers. Inventory note name: matches if the inventory is noted with the given name, using advanced matchers. Inventory type: matches if the inventory is of a given type, using advanced matchers. "inventory_flagged:<flag>": a Flag Matchable for InventoryTag flags. "gui" plaintext: matches if the inventory is a GUI (see inventory script containers). |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/InventoryTag.java#L59 |
Name | LocationTag |
Prefix | l@ |
Base Type | ElementTag |
Implements | FlaggableObject, VectorObject |
Identity Format | The identity format for locations is <x>,<y>,<z>,<pitch>,<yaw>,<world>
Note that you can leave off the world, and/or pitch and yaw, and/or the z value. You cannot leave off both the z and the pitch+yaw at the same time. For example, 'l@1,2.15,3,45,90,space' or '[email protected],99,3.2' |
Description | A LocationTag represents a point in the world.
Note that 'l' prefix is a lowercase 'L', the first letter in 'location'. This object type is flaggable. Flags on this object type will be stored in the chunk file inside the world folder. |
Matchable | LocationTag matchers, sometimes identified as "<location>" or "<block>":
"location" plaintext: always matches. "block_flagged:<flag>": a Flag Matchable for location flags at the given block location. "location_in:<area>": runs AreaObject checks, as defined below. If none of the above are used, and the location is at a real block, a MaterialTag matchable is used. Refer to MaterialTag matchable list. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L65 |
Name | MobArenaArenaTag |
Prefix | mobarena@ |
Base Type | ElementTag |
Identity Format | The identity format for arenas is <arena_name>
For example, 'mobarena@my_arena'. |
Description | A MobArenaArenaTag represents a mob arena in the world. |
Requires | Depenizen, MobArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mobarena/MobArenaArenaTag.java#L18 |
Name | MythicMobsMobTag |
Prefix | mythicmob@ |
Base Type | ElementTag |
Identity Format | The identity format for MythicMobsMobTag is <uuid>
For example, 'mythicmob@1234-1234-1234'. |
Description | A MythicMobsMobTag represents a Mythic mob entity in the world. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicMobsMobTag.java#L31 |
Name | MythicSpawnerTag |
Prefix | mythicspawner@ |
Base Type | ElementTag |
Identity Format | The identity format for a MythicSpawner is its name.
For example, 'mythicspawner@AngrySludgeSpawner1'. |
Description | A MythicSpawnerTag represents a MythicMobs spanwer in the world. |
Requires | Depenizen, MythicMobs |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/mythicmobs/MythicSpawnerTag.java#L28 |
Name | PlotSquaredPlotTag |
Prefix | plotsquaredplot@ |
Base Type | ElementTag |
Identity Format | The identity format for plots is <x>,<z>,<world>
For example, 'plotsquaredplot@5,10,Hub'. |
Description | A PlotSquaredPlotTag represents a PlotSquared plot in the world. |
Requires | Depenizen, PlotSquared |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/plotsquared/PlotSquaredPlotTag.java#L25 |
Name | PolygonTag |
Prefix | polygon@ |
Base Type | ElementTag |
Implements | FlaggableObject, AreaObject |
Identity Format | The identity format for polygons is <world>,<y-min>,<y-max>,<x1>,<z1>,... (the x,z pair repeats for as many points as the polygon has). |
Description | A PolygonTag represents a polygonal region in the world.
The word 'polygon' means an arbitrary 2D shape. PolygonTags, in addition to a 2D polygon, contain a minimum and maximum Y coordinate, to allow them to function in 3D. PolygonTags are NOT polyhedra. A PolygonTag with 4 points at right angles would cover an area also possible to be defined by a CuboidTag, however all other shapes a PolygonTag can form are unique. Compared to CuboidTags, PolygonTags are generally slower to process and more complex to work with, but offer the benefit of supporting more intricate shapes. Note that forming invalid polygons (duplicate corners, impossible shapes, etc) will not necessarily give any error message, and may cause weird results. This object type can be noted. This object type is flaggable when it is noted. Flags on this object type will be stored in the notables.yml file. |
Matchable | Refer to areaobject's matchable list. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L29 |
Name | PVPArenaArenaTag |
Prefix | pvparena@ |
Base Type | ElementTag |
Identity Format | The identity format for arenas is <arena_name>
For example, 'pvparena@myarena'. |
Description | A PVPArenaArenaTag represents a PvP Arena in the world. |
Requires | Depenizen, PvPArena |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/pvparena/PVPArenaArenaTag.java#L17 |
Name | ResidenceTag |
Prefix | residence@ |
Base Type | ElementTag |
Identity Format | The identity format for residences is just the name.
For example, 'residence@myresidence'. |
Description | A ResidenceTag represents a Residence in the world. |
Matchable | ResidenceTag matchers, sometimes identified as "<residence>":
"residence" plaintext: always matches. Residence name: matches if the residence is named matches the input, using advanced matchers. |
Requires | Depenizen, Residence |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/residence/ResidenceTag.java#L24 |
Name | ShopKeeperTag |
Prefix | shopkeeper@ |
Base Type | ElementTag |
Identity Format | The identity format for shopkeepers is <uuid>
For example, 'shopkeeper@1234-1234-1234'. |
Description | A ShopKeeperTag represents a ShopKeeper entity in the world. |
Requires | Depenizen, Shopkeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L26 |
Name | TimeTag |
Prefix | time@ |
Base Type | ElementTag |
Implements | FlaggableObject |
Identity Format | The identity format for TimeTags is "yyyy/mm/dd_hh:mm:ss:mill_offset"
So, for example, 'time@2020/05/23_02:20:31:123_-07:00' |
Description | A TimeTag represents a real world date/time value.
TimeTags can also be constructed from 'yyyy/mm/dd', 'yyyy/mm/dd_hh:mm:ss', or 'yyyy/mm/dd_hh:mm:ss:mill'. (Meaning: the offset is optional, the milliseconds are optional, and the time-of-day is optional, but if you exclude an optional part, you must immediately end the input there, without specifying more). This object type is flaggable. Flags on this object type will be stored in the server saves file, under special sub-key "__time" |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/TimeTag.java#L25 |
Name | TownTag |
Prefix | town@ |
Base Type | ElementTag |
Implements | FlaggableObject |
Identity Format | The identity format for towns is <town_uuid>
For example, 'town@123-abc'. |
Description | A TownTag represents a Towny town in the world.
This object type is flaggable. Flags on this object type will be stored in the server saves file, under special sub-key "__depenizen_towny_towns_uuid" |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L29 |
Name | <BiomeTag.downfall_at[<location>]> |
Returns | ElementTag |
Description | Returns this biome's downfall type at a location (for when a world has weather).
This can be RAIN, SNOW, or NONE. Generally LocationTag.downfall_type should be preferred, other than some special cases. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L307 |
Name | <BiomeTag.downfall_type> |
Returns | ElementTag |
Mechanism | BiomeTag.downfall_type |
Description | Deprecated in favor of BiomeTag.downfall_at on 1.19+, as downfall is block-specific now.
Returns this biome's downfall type for when a world has weather. This can be RAIN, SNOW, or NONE. |
Example |
|
Deprecated | Minecraft changed the way biome downfall works, use BiomeTag.downfall_at on 1.19+. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L168 |
Name | <BiomeTag.temperature_at[<location>]> |
Returns | ElementTag(Decimal) |
Description | Returns the temperature of a specific location in this biome.
If this is less than 0.15, snow will form on the ground when weather occurs in the world and a layer of ice will form over water. Generally LocationTag.temperature should be preferred, other than some special cases. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/BiomeTag.java#L291 |
Name | <ChunkTag.simple> |
Returns | ElementTag |
Description | Returns the X,Z coordinates and world name of the chunk in the format "X,Z,world". |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/ChunkTag.java#L448 |
Name | <ElementTag.after[<element>]> |
Returns | ElementTag |
Description | Returns the portion of an element after the first occurrence of a specified element.
For example: HelloWorld .after[Hello] returns World. |
Group | element manipulation |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L1192 |
Name | <ElementTag.regex[<regex>].group[<group>]> |
Returns | ElementTag |
Description | Returns the specific group from a regex match.
Specify group 0 for the whole match. For example, <element[hello5world].regex[.*(\d).*].group[1]> returns '5'. |
Group | element checking |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ElementTag.java#L975 |
Name | <EllipsoidTag.include[<location>]> |
Returns | EllipsoidTag |
Description | Returns a copy of this ellipsoid, with the size value adapted to include the specified world location. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EllipsoidTag.java#L480 |
Name | <EntityTag.auto_expire> |
Returns | ElementTag(Boolean) |
Mechanism | EntityTag.auto_expire |
Description | Returns whether a falling_block will auto-expire (after 30 seconds, or 5 when outside the world).
See also EntityTag.time_lived |
Generated Example |
|
Group | properties |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/EntityAutoExpire.java#L39 |
Name | <EntityTag.collides_at[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns whether the entity's bounding box would collide if the entity was moved to the given location.
This checks for any colliding entities (like boats and shulkers), the world border and regular blocks. (Note that this won't load chunks at the location.) |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperEntityExtensions.java#L146 |
Name | <EntityTag.last_attack> |
Returns | MapTag |
Description | Returns an interaction entity's last attack interaction, if any.
The returned map contains: - 'player' (PlayerTag): the player who interacted - 'duration' (DurationTag): the amount of time since the interaction. Note that this is a delta time (same limitations as delta time), and may become inaccurate if the interaction entity changes worlds. - 'raw_game_time' (ElementTag(Number)): the raw game time the interaction occurred at, used to calculate the time above. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2892 |
Name | <EntityTag.last_interaction> |
Returns | MapTag |
Description | Returns an interaction entity's last right click interaction, if any.
The returned map contains: - 'player' (PlayerTag): the player who interacted - 'duration' (DurationTag): the amount of time since the interaction. Note that this is a delta time (same limitations as delta time), and may become inaccurate if the interaction entity changes worlds. - 'raw_game_time' (ElementTag(Number)): the raw game time the interaction occurred at, used to calculate the time above. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L2910 |
Name | <EntityTag.left_shoulder> |
Returns | EntityTag |
Mechanism | EntityTag.left_shoulder |
Description | Returns the entity on the entity's left shoulder.
Only applies to player-typed entities. NOTE: The returned entity will not be spawned within the world, so most operations are invalid unless the entity is first spawned in. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1784 |
Name | <EntityTag.right_shoulder> |
Returns | EntityTag |
Mechanism | EntityTag.right_shoulder |
Description | Returns the entity on the entity's right shoulder.
Only applies to player-typed entities. NOTE: The returned entity will not be spawned within the world, so most operations are invalid unless the entity is first spawned in. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/EntityTag.java#L1805 |
Name | <ItemTag.map_center> |
Returns | LocationTag |
Mechanism | ItemTag.map_center |
Description | Returns the center location on the map's display.
Note that there is no Y value (it's always 0), only X, Z, and a World. |
Generated Example |
|
Group | properties |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/properties/item/ItemMap.java#L99 |
Name | <LocationTag.downfall_type> |
Returns | ElementTag |
Description | Returns a location's downfall type (for when a world has weather), based on the biome it's in.
This can be RAIN, SNOW, or NONE. See also BiomeTag.downfall_at. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4268 |
Name | <LocationTag.format[<format>]> |
Returns | ElementTag |
Description | Formats a LocationTag according to a specified format input.
You can request x, y, z, yaw, or pitch as full "f", short "s", or block "b" format. eg "fx" for "full X coordinate" (like 1.051234), "syaw" for "short yaw" (like 1.03), or "bz" for "block Z coordinate" (like 1). "world" is also available to get the world name. If "$" is in the format, only codes prefixed with "$" will be replaced, eg "$bx but not bx" will become "5 but not bx" (allowing the safe use of unpredictable text inside the format block). |
Example |
|
Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3151 |
Name | <LocationTag.formatted.citizens> |
Returns | ElementTag |
Description | Returns the location formatted for a Citizens command.
In the format: x.x:y.y:z.z:world For example: 1.0:2.0:3.0:world_nether |
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3188 |
Name | <LocationTag.formatted> |
Returns | ElementTag |
Description | Returns the formatted version of the LocationTag.
In the format: X 'x.x', Y 'y.y', Z 'z.z', in world 'world' For example: X '1.0', Y '2.0', Z '3.0', in world 'world_nether' |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L3178 |
Name | <LocationTag.simple.formatted> |
Returns | ElementTag |
Description | Returns the formatted simple version of the LocationTag's block coordinates.
In the format: X 'x', Y 'y', Z 'z', in world 'world' For example, X '1', Y '2', Z '3', in world 'world_nether' |
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1703 |
Name | <LocationTag.simple> |
Returns | ElementTag |
Description | Returns a simple version of the LocationTag's block coordinates.
In the format: x,y,z,world For example: 1,2,3,world_nether |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L1693 |
Name | <LocationTag.temperature> |
Returns | ElementTag(Decimal) |
Description | Returns a location's temperature, based on the biome it's in.
If this is less than 0.15, snow will form on the ground when weather occurs in the world and a layer of ice will form over water. See also BiomeTag.temperature_at. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/LocationTag.java#L4251 |
Name | <NPCTag.pose[<name>]> |
Returns | LocationTag |
Description | Returns the pose as a LocationTag with x, y, and z set to 0, and the world set to the first
possible available world Bukkit knows about. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/NPCTag.java#L667 |
Name | <PlayerTag.has_permission[permission.node].global> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the specified node, regardless of world.
(Works with offline players) (Note: this may or may not be functional with your permissions system.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1319 |
Name | <PlayerTag.in_group[<group_name>].global> |
Returns | ElementTag(Boolean) |
Description | Returns whether the player has the group with no regard to the
player's current world. (Works with offline players) (Note: This may or may not be functional with your permissions system.) |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L1260 |
Name | <PlayerTag.time> |
Returns | ElementTag(Number) |
Description | Returns the time the player is currently experiencing.
This time could differ from the time that the rest of the world is currently experiencing if time is being used on the player. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2154 |
Name | <PlayerTag.view_distance> |
Returns | ElementTag(Number) |
Mechanism | PlayerTag.view_distance |
Description | Returns this player's view distance, or the view distance of the world they're in if unset. |
Generated Example |
|
Group | paper |
Requires | Paper |
Source | https://github.com/DenizenScript/Denizen/blob/dev/paper/src/main/java/com/denizenscript/denizen/paper/properties/PaperPlayerExtensions.java#L82 |
Name | <PlayerTag.we_brush_info[(<item>)]> |
Returns | ListTag |
Description | Returns information about a player's current brush for an item.
If no item is specified, will be based on their held item. Output is in format: type|size|range|material Note that some values may be listed as "unknown" or strange values due to WorldEdit having a messy API (no way to automatically stringify brush data). |
Generated Example |
|
Requires | Depenizen, WorldEdit |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldedit/WorldEditPlayerProperties.java#L81 |
Name | <PlayerTag.weather> |
Returns | ElementTag |
Description | Returns the type of weather the player is experiencing. This will be different
from the weather currently in the world that the player is residing in if the weather is currently being forced onto the player. Returns null if the player does not currently have any forced weather. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PlayerTag.java#L2165 |
Name | <PolygonTag.blocks_inclusive[(<matcher>)]> |
Returns | ListTag(LocationTag) |
Description | Returns each block location within the polygon.
Optionally, specify a material matcher to only return locations with that block type. Uses block-inclusive containment: contains a wider section of blocks along the edge (this mode is equivalent to WorldEdit's block selection). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L875 |
Name | <PolygonTag.contains_inclusive[<location>]> |
Returns | ElementTag(Boolean) |
Description | Returns a boolean indicating whether the specified location is inside this polygon.
Uses block-inclusive containment: contains a wider section of blocks along the edge (this mode is equivalent to WorldEdit's block selection). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L859 |
Name | <PolygonTag.shell_inclusive> |
Returns | ListTag(LocationTag) |
Description | Returns each block location on the 3D outer shell of the polygon.
Uses block-inclusive containment: contains a wider section of blocks along the edge (this mode is equivalent to WorldEdit's block selection). |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/objects/PolygonTag.java#L901 |
Name | <region[<region>]> |
Returns | WorldGuardRegionTag |
Description | Returns a WorldGuard region object constructed from the input value.
Refer to WorldGuardRegionTag. |
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/bridges/WorldGuardBridge.java#L33 |
Name | <ScriptTag.container_type> |
Returns | ElementTag |
Description | Returns the type of script container that is associated with this ScriptTag object. For example: 'task', or
'world'. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/ScriptTag.java#L234 |
Name | <server.generate_loot_table[id=<id>;location=<location>;(killer=<entity>);(entity=<entity>);(loot_bonus=<#>/{-1});(luck=<#.#>/{0})]> |
Returns | ListTag(ItemTag) |
Description | Returns a list of items from a loot table, given a map of input data.
Required input: id: the loot table ID, location: the location where it's being generated (LocationTag). Optional inputs: killer: an online player (or player-type NPC) that is looting, entity: a dead entity being looted from (a valid EntityTag instance that is or was spawned in the world), loot_bonus: the loot bonus level (defaults to -1) as an integer number, luck: the luck potion level (defaults to 0) as a decimal number. Some inputs will be strictly required for some loot tables, and ignored for others. A list of valid loot tables can be found here: https://minecraft.wiki/w/Loot_table#List_of_loot_tables Note that the tree view represented on the wiki should be split by slashes for the input - for example, "cow" is under "entities" in the tree so "entities/cow" is how you input that. CAUTION: Invalid loot table IDs will generate an empty list rather than an error. |
Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L1786 |
Name | <server.material_types> |
Returns | ListTag(MaterialTag) |
Description | Returns a list of all materials known to the server.
Generally used with MaterialTag. This is only types listed in the Bukkit Material enum, as seen at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html. Note: Some materials might be disabled in specific worlds, check using MaterialTag.is_enabled. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java#L803 |
Name | <ShopKeeperTag.is_active> |
Returns | ElementTag(Boolean) |
Description | Returns whether the Shopkeeper is active (has been spawned and is still valid and present in the world). |
Requires | Depenizen, ShopKeepers |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/shopkeepers/ShopKeeperTag.java#L108 |
Name | <TownTag.cuboids> |
Returns | ListTag(CuboidTag) |
Description | Returns a list of plot cuboids claimed by the town.
Note that the cuboids may be in separate worlds if the town has outposts. |
Requires | Depenizen, Towny |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/objects/towny/TownTag.java#L506 |
Name | <VectorObject.xyz> |
Returns | ElementTag |
Description | Returns the basic vector in "x,y,z" format.
For example: 1,2,3 Other values, such as world, yaw, and pitch will be excluded from this output. |
Generated Example |
|
Group | identity |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/objects/core/VectorObject.java#L110 |
Name | AdjustBlock |
Related Guide Page | https://guide.denizenscript.com/guides/basics/mechanisms.html |
Syntax | adjustblock [<location>|...] [<mechanism>](:<value>) (no_physics) |
Short Description | Adjusts a mechanism on the material of a block at the location. |
Full Description | Adjusts a mechanism on the material of a block at the location.
That is, an equivalent to adjust, but that directly applies a "MaterialTag" mechanism onto a block. Input a location or list of locations, and the mechanism to apply. Use the "no_physics" argument to indicate that the change should not apply a physics update. If not specified, physics will apply to the block and nearby blocks. |
Related Tags | <LocationTag.material> Returns the material of the block at the location.
|
Usage Example |
|
Usage Example |
|
Group | core |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/AdjustBlockCommand.java#L30 |
Name | Advancement |
Syntax | advancement [id:<name>] (delete/grant:<players>/revoke:<players>/{create}) (parent:<name>) (icon:<item>) (title:<text>) (description:<text>) (background:<key>) (frame:<type>) (toast:<boolean>) (announce:<boolean>) (hidden:<boolean>) (x:<offset>) (y:<offset>) (progress_length:<#>) |
Short Description | Controls a custom advancement. |
Full Description | Controls custom Minecraft player advancements. You should generally create advancements manually on server start.
Currently, the ID argument may only refer to advancements added through this command. The default action is to create and register a new advancement. You may also delete an existing advancement, in which case do not provide any further arguments. You may grant or revoke an advancement for a list of players, in which case do not provide any further arguments. The parent argument sets the root advancement in the advancements menu, in the format "namespace:key". If no namespace is specified, the parent is assumed to have been created through this command. The icon argument sets the icon displayed in toasts and the advancements menu. As of MC 1.20, an icon is required. Dirt will be used if it is missing. The title argument sets the title that will show on toasts and in the advancements menu. The description argument sets the information that will show when scrolling over a chat announcement or in the advancements menu. The background argument sets the image to use if the advancement goes to a new tab. If the background is unspecified, defaults to "minecraft:textures/gui/advancements/backgrounds/stone.png". The frame argument sets the type of advancement - valid arguments are CHALLENGE, GOAL, and TASK. The toast argument sets whether the advancement should display a toast message when a player completes it. Default is true. The announce argument sets whether the advancement should display a chat message to the server when a player completes it. Default is true. The hidden argument sets whether the advancement should be hidden until it is completed. The x and y arguments are offsets based on the size of an advancement icon in the menu. They are required for custom tabs to look reasonable. When creating an advancement, optionally specify 'progress_length' to make it require multiple parts. When granting an advancement, optionally specify 'progress_length' to only grant partial progress. To award a pre-existing vanilla advancement, instead use PlayerTag.award_advancement WARNING: Failure to re-create advancements on every server start may result in loss of data - use server prestart. If you mess with datapacks, you will also need to re-create advancements during server resources reloaded |
Related Tags | <PlayerTag.has_advancement[<advancement>]> Returns whether the player has completed the specified advancement.
<PlayerTag.advancements> Returns a list of the names of all advancements the player has completed.
<server.advancement_types> Returns a list of all registered advancement names. (...)
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | player |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/player/AdvancementCommand.java#L33 |
Name | Compass |
Syntax | compass [<location>/reset] |
Short Description | Redirects the player's compass to target the given location. |
Full Description | Redirects the compass of the player, who is attached to the script queue.
This is not the compass item, but the command is controlling the pointer the item should direct at. This means that all item compasses will point the same direction but differently for each player. To affect an individual compass item, use ItemTag.lodestone_location The y-axis is not used but its fine to be included in the location argument. Reset argument will turn the direction to default (spawn or bed) |
Related Tags | <PlayerTag.compass_target> Returns the location of the player's compass target.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | player |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/player/CompassCommand.java#L23 |
Name | Determine |
Related Guide Page | https://guide.denizenscript.com/guides/first-steps/world-script.html |
Syntax | determine (passively) [<value>] |
Short Description | Sets the outcome of a script. |
Full Description | Sets the outcome of a script.
The most common use case is within script events (for example, to cancel the event). This is also required for all procedure scripts. It may be useful in other cases (such as a task script that returns a result, via the save argument). By default, the determine command will end the queue (similar to stop). If you wish to prevent this, specify the "passively" argument. To make multiple determines, simply use the determine command multiple times in a row, with the "passively" argument on each. |
Related Tags | <QueueTag.determination> Returns the values that have been determined via Determine (...)
|
Usage Example |
|
Usage Example |
|
Synonyms (Search Aid) | return |
Group | queue |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/queue/DetermineCommand.java#L23 |
Name | discordcommand |
Related Guide Page | https://guide.denizenscript.com/guides/expanding/ddiscordbot.html |
Syntax | discordcommand (id:<bot>) [create/delete] (group:<group>) (name:<name>) (type:{slash}/user/message) (description:<description>) (options:<options>) |
Short Description | Manages Discord application commands. |
Full Description | Manages Discord application commands.
You can create a new command, edit the permissions of an existing command, or delete an existing command. To create (or delete) a command in a specific Discord guild, use the "group" argument. If not present, a global command will be created. NOTE: Global commands take up to an hour to register. When creating, both a name and description are required. Commands can be slash commands - activated via typing "/", message commands - activated by right-clicking a message, or user commands - activated by right-clicking a user. "Description" and "options" are only valid for slash commands. The "options" argument controls the command parameters. It is a MapTag of ordered MapTags that can sometimes hold ordered MapTags. It is recommended to use definemap or a data script key when creating commands. All option MapTags must have "type", "name", and "description" keys, with an optional "required" key (defaulting to true). The "type" key can be one of: STRING, INTEGER, BOOLEAN, USER, CHANNEL, ROLE, MENTIONABLE, NUMBER, ATTACHMENT. Additionally, the option map can include a "choices" key, which is a MapTag of ordered MapTags that have a "name" (what displays to the user) and a "value" (what gets passed to the client). Instead of choices, the option map can also include an "autocomplete" key controlling whether dynamic suggestions can be provided to the client (defaulting to false). See on discord command autocomplete. Editing application command permissions has been moved to the "Integrations" section in the server settings. Read more about it here: https://discord.com/blog/slash-commands-permissions-discord-apps-bots You DO NOT need to create a command on startup every time! Once a command is created, it will persist until you delete it. Using the "create" instruction on an existing command will update it. Commands and replies to interactions have limitations. See https://gist.github.com/MinnDevelopment/b883b078fdb69d0e568249cc8bf37fe9. See also Discord's internal API documentation for commands: https://discord.com/developers/docs/interactions/application-commands Generally used alongside discordinteraction The command should usually be ~waited for. See ~waitable. |
Related Tags | <entry[saveName].command> returns the DiscordCommandTag of a command upon creation, when the command is ~waited for.
|
Usage Example |
|
Usage Example |
|
Group | external |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordCommandCommand.java#L40 |
Name | discordinteraction |
Related Guide Page | https://guide.denizenscript.com/guides/expanding/ddiscordbot.html |
Syntax | discordinteraction [defer/reply/delete] [interaction:<interaction>] (ephemeral) (rows:<rows>) (<message>) (embed:<embed>|...) (attach_files:<map>) |
Short Description | Manages Discord interactions. |
Full Description | Manages Discord interactions.
You can defer, reply to, edit, or delete an interaction. These instructions all require the "interaction" argument. The "ephemeral" argument can be used to have the reply message be visible to that one user. You can defer an interaction before replying, which is useful if your reply may take more than a few seconds to be selected. If you defer, the 'ephemeral' option can only be set by the defer - you cannot change it with the later reply. Replying to an interaction uses similar logic to normal messaging. See discordmessage. If you deferred without using 'ephemeral', the 'delete' option will delete the "Thinking..." message. Ephemeral replies cannot have files. Slash commands, and replies to interactions, have limitations. See https://gist.github.com/MinnDevelopment/b883b078fdb69d0e568249cc8bf37fe9. Generally used alongside discordcommand The command can be ~waited for. See ~waitable. |
Related Tags | <entry[saveName].command> returns the DiscordCommandTag of a slash command upon creation, when the command is ~waited for.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | external |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordInteractionCommand.java#L31 |
Name | discordmessage |
Related Guide Page | https://guide.denizenscript.com/guides/expanding/ddiscordbot.html |
Syntax | discordmessage (id:<id>) [reply:<message>/edit:<message>/channel:<channel>/user:<user>] (<message>) (no_mention) (rows:<rows>) (embed:<embed>|...) (attach_files:<map>) (post_title:<name>) |
Short Description | Sends a message to a Discord channel. |
Full Description | Sends a message to a Discord channel.
Command may fail if the bot does not have permission within the Discord group to send a message in that channel. You can send the message to: a channel, user, or in reply to a previous message. If sending as a reply, optionally use "no_mention" to disable the default reply pinging the original user. Channels can be specified as either a copied ID, or using any tag that returns a valid DiscordChannelTag. To get IDs, enable "Developer Mode" in your Discord settings, then right click on the channel and press "Copy ID". You can edit an existing message by using "edit:<message>". You can use "attach_file_name:<name>" and "attach_file_text:<text>" to attach a text file with longer content than a normal message allows. Alternatively, you can use "attach_files:<map>" to attach files as a MapTag of the name of the file to the text or a BinaryTag. To send embeds, use "embed:<embed>|...". You can use "rows" to attach action rows of components, such as buttons to the message, using DiscordButtonTag, and DiscordSelectionTag. You can send a message into a Forum Channel with "post_title" specified to create a post in that forum. The command can be ~waited for. See ~waitable. |
Related Tags | <entry[saveName].message> returns the DiscordMessageTag of the sent message, when the command is ~waited for.
<discord[mybot].group[Denizen].channel[bot-spam]> is an example of a tag that will return an appropriate channel object for a named channel in a named group.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | external |
Requires | dDiscordBot |
Source | https://github.com/DenizenScript/dDiscordBot/blob/master/src/main/java/com/denizenscript/ddiscordbot/commands/DiscordMessageCommand.java#L43 |
Name | Flag |
Related Guide Page | https://guide.denizenscript.com/guides/basics/flags.html |
Syntax | flag [<object>|...] [<name>([<#>])](:<action>)[:<value>] (expire:<time>) |
Short Description | Sets or modifies a flag on any flaggable object. |
Full Description | The flag command sets or modifies custom data values stored on any flaggable object (the server, a player/NPC/entity, a block location, ...).
See also flag system. This command supports data actions, see data actions. Flags by default are added permanently (or for the lifetime of the object they're attached to). You can optionally specify a system time the flag will expire at, using either a DurationTag or a TimeTag. If a DurationTag is used, it will be equivalent to: <util.time_now.add[<your_duration_here>]> |
Related Tags | <FlaggableObject.flag[<flag_name>]> Returns the specified flag from the flaggable object. (...)
<FlaggableObject.has_flag[<flag_name>]> Returns true if the flaggable object has the specified flag, otherwise returns false. (...)
<FlaggableObject.flag_expiration[<flag_name>]> Returns a TimeTag indicating when the specified flag will expire. (...)
<FlaggableObject.list_flags> Returns a list of the flaggable object's flags. (...)
<server.online_players_flagged[<flag_name>]> Returns a list of all online players with a specified flag set. (...)
<server.players_flagged[<flag_name>]> Returns a list of all players (online or offline) with a specified flag set. (...)
<server.spawned_npcs_flagged[<flag_name>]> Returns a list of all spawned NPCs with a specified flag set. (...)
<server.npcs_flagged[<flag_name>]> Returns a list of all NPCs with a specified flag set. (...)
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | core |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/core/FlagCommand.java#L88 |
Name | Group |
Syntax | group [add/remove/set] [<group>] (<world>) |
Short Description | Adds a player to, removes a player from, or sets a player's permissions group. |
Full Description | Controls a player's permission groups, which the ability to add, remove or set a player's groups.
The 'add' argument adds the player to the group and any parent groups, and the 'remove' command does the opposite, removing the player from the group and any inheriting groups. The set command removes all existing groups and sets the player's group. Note: This requires a permissions plugin and Vault. |
Related Tags | <PlayerTag.in_group[<group>]> Returns whether the player is in the specified group. (...)
<PlayerTag.in_group[<group>].global> Returns whether the player has the group with no regard to the (...)
<PlayerTag.in_group[<group>].world> Returns whether the player has the group in regards to a specific world. (...)
<PlayerTag.groups[(<world>)]> Returns a list of all groups the player is in. (...)
<server.permission_groups> Returns a list of all permission groups on the server.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | player |
Requires | Vault |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/player/GroupCommand.java#L24 |
Name | Narrate |
Syntax | narrate [<text>] (targets:<player>|...) (format:<script>) (per_player) (from:<uuid>) |
Short Description | Shows some text to the player. |
Full Description | Prints some text into the target's chat area. If no target is specified it will default to the attached player or the console.
Accepts the 'format:<script>' argument, which will reformat the text according to the specified format script. See Format Script Containers. Optionally use 'per_player' with a list of player targets, to have the tags in the text input be reparsed for each and every player. So, for example, "- narrate 'hello <player.name>' targets:<server.online_players>" would normally say "hello bob" to every player (every player sees the exact same name in the text, ie bob sees "hello bob", steve also sees "hello bob", etc) but if you use "per_player", each player online would see their own name (so bob sees "hello bob", steve sees "hello steve", etc). Optionally, specify 'from:<uuid>' to indicate that message came from a specific UUID (used for things like the vanilla client social interaction block option). |
Related Tags | None
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | player |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/player/NarrateCommand.java#L38 |
Name | ReflectionSet |
Syntax | reflectionset [object:<object>] [field:<name>] (value:<value>) |
Short Description | Sets a field on an object to a given value, or null. |
Full Description | Give a JavaReflectedObjectTag as the object, a field name, and a value (or leave off for null) to set the value of a field on that object.
Uses reflection to set, and so can bypass 'private' or 'final' field limits if permitted by config. If the value is fed as a general ObjectTag, automatic conversion will be attempted. If automatic conversion is not possible, you must pass a JavaReflectedObjectTag with the appropriate type as the value. Requires config setting "Reflection.Allow set command". |
Related Tags | <ObjectTag.reflected_internal_object> Returns the reflected internal Java object for a given ObjectTag.
|
Usage Example |
|
Group | core |
Source | https://github.com/DenizenScript/Denizen-Core/blob/master/src/main/java/com/denizenscript/denizencore/scripts/commands/core/ReflectionSetCommand.java#L30 |
Name | Scoreboard |
Syntax | scoreboard ({add}/remove) (viewers:<player>|...) (lines:<player>/<text>|...) (id:<value>/player/{main}) (objective:<value>) (criteria:<criteria>/{dummy}) (score:<#>) (displayslot:<value>/{sidebar}/none) (displayname:<name>) (rendertype:<type>) |
Short Description | Add or removes viewers, objectives and scores from scoreboards. |
Full Description | Lets you make players see a certain scoreboard and then a certain objective in that scoreboard.
Please note that a 'scoreboard' is NOT a 'sidebar' - if you want that thing where text is on the right side of the screen, use sidebar. 'Scoreboard' is the underlying internal system that powers sidebars, below_name plates, team prefixing, and a lot of other systems. Generally, you should avoid using this command directly. The ID can be 'main' for the global default scoreboard, 'player' for the attached player's current scoreboard, or any other value for a custom named scoreboard. There are currently three slots where objectives can be displayed: in the sidebar on the right of the screen, below player names and in the player list that shows up when you press Tab. The names of these slots can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/scoreboard/DisplaySlot.html Every objective has several lines of scores. Technically, the lines track players, but fake player names can be used by Denizen to let you call the lines anything you want. When using the sidebar as the display slot, all the scores set for an objective will be displayed there, but you will need to put actual player names in the lines to be able to use the below_name display slot (which displays each player's score underneath his/her name) and the player_list display slot (which displays each player's score to the right of his/her name in the player list). If you do not specify a display slot, the sidebar will be used. You can also use "none" as the display slot if you want to add a hidden objective without automatically making it get displayed. If the object already exists, and you don't specify the display slot, it will use the existing setting. When setting an objective, you can also optionally set the display name by using the "displayname:" argument. "Rendertype" can be "INTEGER" or "HEARTS". Defaults to integer. You can set scores manually, or you can use different Minecraft criteria that set and update the scores automatically. A list of these criteria can be found here: https://minecraft.wiki/w/Scoreboard#Objectives If the object already exists, and you don't specify the criteria, it will use the existing setting. You can use the "remove" argument to remove different parts of scoreboards. The more arguments you use with it, the more specific your removal will be. For example, if you only use the "remove" argument and the "id" argument, you will completely remove all the objectives in a scoreboard, but if you specify an objective as well, you will only delete that one objective from that scoreboard, and if you also specify certain lines, you will only delete those specific lines from that objective. Similarly, if you use the "remove" argument along with the "id" and "viewers" arguments, you will only remove those viewers from the scoreboard, not the entire scoreboard. |
Related Tags | <server.scoreboard[(<board>)].exists> Returns whether a given scoreboard exists on the server.
<server.scoreboard[(<board>)].team[<team>].members> Returns a list of all members of a scoreboard team. Generally returns as a list of names or text entries. (...)
<PlayerTag.scoreboard_id> Returns the ID of the scoreboard from scoreboard that a player is currently viewing, if any.
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | server |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/server/ScoreboardCommand.java#L34 |
Name | Sidebar |
Syntax | sidebar (add/remove/{set}/set_line) (title:<title>) (scores:<#>|...) (values:<line>|...) (start:<#>/{num_of_lines}) (increment:<#>/{-1}) (players:<player>|...) (per_player) |
Short Description | Controls clientside-only sidebars. |
Full Description | This command was created as a simpler replacement for using the Scoreboard command to display per-player sidebars.
By using packets and dummies, it enables you to have non-flickering, fully functional sidebars, without wasting processing speed and memory on creating new Scoreboards for every single player. Using this command, you can add, remove, or set lines on the scoreboard. To set the title of the sidebar, use the 'title:' parameter in any case where the action is 'set'. By default, the score numbers descend from the total line count to 1. To customize the automatic score values, use the 'start:' and 'increment:' arguments in any case where the action is 'set'. 'Start' is the score where the first line will be shown with. The default 'start' value is determined by how many items are specified in 'values:'. 'Increment' is the difference between each score and the default is -1. To instead set entirely custom numbers, use the 'scores:' input with a list of numbers, where each number is the score to use with the value at the same place in the 'values:' list. You can remove by line value text, or by score number. The per_player argument is also available, and helps to reduce the number of loops required for updating multiple players' sidebars. When it is specified, all tags in the command will fill based on each individual player in the players list. So, for example, you could have <player.name> on a line and it will show each player specified their name on that line. |
Related Tags | <PlayerTag.sidebar_lines> Returns the current lines set on the player's Sidebar via sidebar.
<PlayerTag.sidebar_title> Returns the current title set on the player's Sidebar via sidebar.
<PlayerTag.sidebar_scores> Returns the current scores set on the player's Sidebar via sidebar, (...)
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Usage Example |
|
Group | player |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/player/SidebarCommand.java#L37 |
Name | Particle Effects |
Description | All the effects listed here can be used by PlayEffect to display visual effects or play sounds
Effects: - Everything on https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Particle.html - Everything on https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Effect.html - RANDOM (chooses a random visual effect from the Particle list) |
Group | Useful Lists |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/PlayEffectCommand.java#L43 |
Name | Raid Event Data |
Description | Every event related to village raids has a <context.raid> property, a MapTag wrapper around raid data (see https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Raid.html).
These events are player triggers raid, raid finishes, raid spawns wave, and raid stops. The data format is as follows: location: a LocationTag of the raid's center heroes: a list of PlayerTags that have participated in the raid raiders: a list of raider EntityTags that remain in the current wave status: the current status of the raid. See https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Raid.RaidStatus.html age: the raid's age (active time) as a DurationTag level: the Bad Omen level that the raid was started with spawned_groups: the number of raider groups spawned total_groups: the number of groups planned to spawn or already spawned health: the combined health of all current raiders waves: the number of waves in the raid |
Group | Useful Lists |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/events/world/RaidScriptEvent.java#L20 |
Name | we_selection |
Object | PlayerTag |
Input | ObjectTag |
Related Tags | <PlayerTag.we_selection> Returns the player's current block area selection, as a CuboidTag, EllipsoidTag, or PolygonTag.
|
Description | Sets the player's current block area selection, as a CuboidTag, EllipsoidTag, or PolygonTag. |
Requires | Depenizen, WorldEdit |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldedit/WorldEditPlayerProperties.java#L166 |
Name | <CuboidTag.has_region> |
Returns | ElementTag(Boolean) |
Description | Returns whether the cuboid contains any region. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardCuboidExtensions.java#L28 |
Name | <CuboidTag.regions> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Returns a list of regions that are in this cuboid. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardCuboidExtensions.java#L39 |
Name | <LocationTag.in_region[(<name>|...)]> |
Returns | ElementTag(Boolean) |
Description | If a region name or list of names is specified, returns whether the
location is in one of the listed regions, otherwise returns whether the location is in any region. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardLocationExtensions.java#L21 |
Name | <LocationTag.regions> |
Returns | ListTag(WorldGuardRegionTag) |
Description | Returns a list of regions that the location is in. |
Generated Example |
|
Requires | Depenizen, WorldGuard |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldguard/WorldGuardLocationExtensions.java#L46 |
Name | <PlayerTag.we_selection> |
Returns | ObjectTag |
Mechanism | PlayerTag.we_selection |
Description | Returns the player's current block area selection, as a CuboidTag, EllipsoidTag, or PolygonTag. |
Generated Example |
|
Requires | Depenizen, WorldEdit |
Source | https://github.com/DenizenScript/Depenizen/blob/master/src/main/java/com/denizenscript/depenizen/bukkit/properties/worldedit/WorldEditPlayerProperties.java#L124 |
Name | <schematic.list> |
Returns | ListTag |
Description | Returns a list of all loaded schematics. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L609 |
Name | <schematic[<name>].block[<location>]> |
Returns | MaterialTag |
Description | Returns the material for the block at the location in the schematic.
An input location of 0,0,0 corresponds to the minimum corner of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L681 |
Name | <schematic[<name>].blocks> |
Returns | ElementTag(Number) |
Description | Returns the number of blocks in the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L710 |
Name | <schematic[<name>].cuboid[<origin_location>]> |
Returns | CuboidTag |
Description | Returns a cuboid of where the schematic would be if it was pasted at an origin. |
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L722 |
Name | <schematic[<name>].exists> |
Returns | ElementTag(Boolean) |
Description | Returns whether the schematic exists. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L633 |
Name | <schematic[<name>].height> |
Returns | ElementTag(Number) |
Description | Returns the height (Y) of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L645 |
Name | <schematic[<name>].length> |
Returns | ElementTag(Number) |
Description | Returns the length (Z) of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L657 |
Name | <schematic[<name>].origin> |
Returns | LocationTag |
Description | Returns the origin location of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L698 |
Name | <schematic[<name>].width> |
Returns | ElementTag(Number) |
Description | Returns the width (X) of the schematic. |
Generated Example |
|
Source | https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/SchematicCommand.java#L669 |