Skript

https://docs.skriptlang.org
Admin
Skript is a scripting plugin for the Bukkit platform that allows Minecraft server administrators and...
Tokens:537,585
Snippets:8,528
Trust Score:6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Set Equip Sound Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/expressions/ExprEquipCompEquipSound.html

Examples demonstrating how to set the equip sound for an item or its equippable component.

```skript
set the equip sound of {_item} to "entity.experience_orb.pickup"
```

```skript
set {_component} to the equippable component of {_item}
set the equip sound of {_component} to "block.note_block.pling"
```

--------------------------------

### Script Reference Examples

Source: https://docs.skriptlang.org/expressions

Examples demonstrating how to reference the current script or specific scripts by name and directory.

```Skript
on script load:
  broadcast "Loaded %the current script%"
```

```Skript
on script load:
  set {running::%script%} to true

on script unload:
  set {running::%script%} to false
```

```Skript
set {script} to the script named "weather.sk"
```

```Skript
loop the scripts in directory "quests/":
  enable loop-value
```

--------------------------------

### start()

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/log/BlockingLogHandler.html

Starts the log handler, registering it with the SkriptLogger.

```APIDOC
### Method
`BlockingLogHandler start()`

### Description
A convenience method that calls SkriptLogger.startLogHandler(this) to begin handling logs.
```

--------------------------------

### Set Loot Table Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/loottables/elements/expressions/ExprLootTable.html

Examples demonstrating how to set the loot table for entities and blocks.

```skript
set loot table of event-entity to "minecraft:entities/ghast"
# this will set the loot table of the entity to a ghast's loot table, thus dropping ghast tears and gunpowder
```

```skript
set loot table of event-block to "minecraft:chests/simple_dungeon"
```

--------------------------------

### Set Join Message Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/entity/player/elements/expressions/ExprJoinMessage.html

Examples showing how to set the join message for first-time players and returning players.

```skript
on first join:
	set the join message to "Welcome %player% to our awesome server!"
```

```skript
on join:
	player has played before
	set the join message to "Welcome back, %player%!"
```

--------------------------------

### Set Shear Sound Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/expressions/ExprEquipCompShearSound.html

Examples demonstrating how to set the shear sound for an item or its equippable component.

```skript
set the shear sound of {_item} to "entity.experience_orb.pickup"
```

```skript
set {_component} to the equippable component of {_item}
set the shear sound of {_component} to "block.note_block.pling"
```

--------------------------------

### Set Text Display Opacity Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/entity/displays/text/elements/expressions/ExprTextDisplayOpacity.html

Examples demonstrating how to set the opacity of text displays to achieve different transparency levels.

```skript
set the text opacity of the last spawned text display to 0 # fully opaque
```

```skript
set text opacity of all text displays to 255 # fully opaque
```

```skript
set text opacity of all text displays to 128 # semi-transparent
```

```skript
set text opacity of all text displays to 4 # fully transparent
```

--------------------------------

### Set Equipment Slot Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/expressions/ExprEquipCompSlot.html

Examples demonstrating how to set the equipment slot for an item or an equippable component.

```skript
set the equipment slot of {_item} to chest slot
```

```skript
set {_component} to the equippable component of {_item}
set the equipment slot of {_component} to boots slot
```

--------------------------------

### Equippable Component Durability Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/effects/EffEquipCompDamageable.html

Examples demonstrating how to configure durability loss for equippable items.

```skript
make {_item} lose durability when hurt
```

```skript
set {_component} to the equippable component of {_item}
if {_component} will lose durability when injured:
	make {_component} lose durability on injury
```

--------------------------------

### Usage Examples for Title Property

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/common/properties/elements/expressions/PropExprTitle.html

Examples demonstrating how to set the title of a bossbar and an inventory item.

```skript
set title of event-bossbar to "<red>hello!"
```

```skript
on inventory click:
	if type of event-item is written book:
		set title of event-item to formatted "<obf>%random uuid%"
		send "Your book's title is now forever forgotten.." to player
```

--------------------------------

### Access queue start and end

Source: https://docs.skriptlang.org/expressions

Shows how to add elements to the start of a queue without removing them during access.

```skript
set {queue} to a new queue
add "hello" to {queue}
add "foo" to the start of {queue}
broadcast the first element of {queue} # foo
broadcast the first element of {queue} # hello
```

--------------------------------

### Shoot Effect Examples

Source: https://docs.skriptlang.org/sections.html

Examples demonstrating how to launch projectiles from entities or locations at specific speeds.

```skript
shoot arrow from all players at speed 2
```

```skript
shoot a pig from all players:
add event-entity to {_projectiles::*}
```

--------------------------------

### Spawn Effect Examples

Source: https://docs.skriptlang.org/sections.html

Examples demonstrating how to spawn entities, including using sections to modify entity properties upon creation.

```skript
spawn 3 creepers at the targeted block
```

```skript
spawn a ghast 5 meters above the player
```

```skript
spawn a zombie at the player:
set name of the zombie to ""
```

```skript
spawn a block display of a ladder[waterlogged=true] at location above player:
set billboard of event-display to center # allows the display to rotate around the center axis
```

--------------------------------

### Applying @Example Annotations to a Class

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/doc/Example.html

Demonstrates how to stack single-line and multi-line @Example annotations on a class definition.

```java
@Example("set player's health to 1")
@Example("""
		if player's health is greater than 10:
			send "Wow you're really healthy!"
		""")
@Example("""
		# sets the player's health to 1
		set player's health to 1""")
public class MyExpression extends ... {
}
```

--------------------------------

### Initialize AxolotlData Example

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/entity/AxolotlData.html

Example usage of spawning entities and setting them to variables, illustrating the context in which entity data initialization occurs.

```skript
spawn a pig at location(0, 0, 0):
						set {_entity} to event-entity
				spawn {_entity} at location(0, 0, 0)
```

--------------------------------

### Usage Examples for Viewers Property

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/common/properties/elements/expressions/PropExprViewers.html

Examples demonstrating how to add players to a bossbar's viewers and how to retrieve and count viewers of an inventory.

```skript
add {_player} to viewers of event-bossbar
```

```skript
on inventory open:
	set {_mylist::*} to viewers of event-inventory
	send "%size of {_list::*}% other players are viewing this inventory!"
```

--------------------------------

### Furnace Slot Usage Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/block/furnace/elements/expressions/ExprFurnaceSlot.html

Examples demonstrating how to manipulate and check furnace slots using Skript syntax.

```skript
set the fuel slot of the clicked block to a lava bucket
```

```skript
set the block's ore slot to 64 iron ore
```

```skript
clear the result slot of the block
```

```skript
on smelt:
	if the fuel slot is charcoal:
		add 5 seconds to the burn time
```

--------------------------------

### System Time Event Examples

Source: https://docs.skriptlang.org/events.html

Examples of triggering events based on the system's local real-life time.

```skript
at 14:20 in real time:
```

```skript
at 2:30am real time:
```

```skript
at 6:10 pm in real time:
```

```skript
at 5:00 am and 5:00 pm in real time:
```

```skript
at 5:00 and 17:00 in real time:
```

--------------------------------

### Shearable Component Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/effects/EffEquipCompShearable.html

Examples demonstrating how to allow or prevent an item from being sheared off of entities.

```skript
allow {_item} to be sheared off
```

```skript
set {_component} to the equippable component of {_item}
if {_component} can be sheared off of entities:
	prevent {_component} from being sheared off of entities
```

--------------------------------

### Teleport Event Examples

Source: https://docs.skriptlang.org/events.html

Examples for listening to teleportation events for players or specific entities.

```skript
on teleport:
```

```skript
on player teleport:
```

```skript
on creeper teleport:
```

--------------------------------

### Damage Location Usage Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/damagesource/elements/expressions/ExprDamageLocation.html

Examples demonstrating how to set a damage location within a custom damage source and how to retrieve it from an event.

```skript
damage all players by 5 using a custom damage source:
	set the damage type to magic
	set the causing entity to {_player}
	set the direct entity to {_arrow}
	set the damage location to location(0, 0, 10)
```

```skript
on death:
	set {_location} to the damage location of event-damage source
```

--------------------------------

### Usage Examples for PropExprName

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/common/properties/elements/expressions/PropExprName.html

Examples demonstrating how to use the name expression in Skript scripts to check permissions and modify names.

```skript
on join:
	player has permission "name.red"
	set the player's display name to "<red>[admin] <gold>%name of player%"
set the name of the player's tool to "Legendary Sword of Awesomeness"
```

--------------------------------

### Minecart Derailed / Flying Velocity

Source: https://docs.skriptlang.org/expressions

Gets or sets the velocity of a minecart as soon as it has been derailed or starts flying.

```APIDOC
## Minecart Derailed / Flying Velocity

### Description
Retrieves or modifies the velocity of a minecart as soon as it has been derailed or as soon as it starts flying.

### Syntax
`[the] [minecart] (derailed|flying) velocity of %entities%`
`%entities%'[s] [minecart] (derailed|flying) velocity`

### Return Type
Vector

### Since
2.5.1
```

--------------------------------

### on server start/stop

Source: https://docs.skriptlang.org/events.html

Triggered when the Skript plugin starts or stops.

```APIDOC
## Event: on server start/stop

### Description
Called when Skript starts, loads, enables, stops, unloads, or disables. Note that a /reload command will trigger these events.

### Patterns
- on server start
- on skript start
- on server stop
- on skript stop
```

--------------------------------

### Get Potion Effect Type Category

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/potion/elements/expressions/ExprPotionEffectTypeCategory.html

Example usage of the expression within an entity potion effect modification event.

```skript
on entity potion effect modification:
	if the potion effect type category is harmful:
		 message "You have been afflicted with %potion effect type%"
```

--------------------------------

### Initialize and use a Queue

Source: https://docs.skriptlang.org/classes

Demonstrates creating a new queue, adding an element, and broadcasting the first element.

```skript
set {queue} to a new queue   
add "hello" to {queue}   
broadcast the 1st element of {queue}
```

--------------------------------

### Retrieve and Modify Loot Luck

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/loottables/elements/expressions/ExprLootContextLuck.html

Examples demonstrating how to get the luck value from a loot context and how to set it during context creation.

```skript
set {_luck} to loot luck value of {_context}
```

```skript
set {_context} to a loot context at player:
	set loot luck value to 10
	set looter to player
	set looted entity to last spawned pig
```

--------------------------------

### @Examples Annotation

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/doc/Examples.html

The @Examples annotation is used to define a list of examples for a specific element. It requires a value element which is an array of strings.

```APIDOC
## @Examples Annotation

### Description
Provides a list of examples to be used in documentation for the annotated element.

### Required Elements
- **value** (String[]) - Required - An array of strings representing the examples to be displayed in the documentation.
```

--------------------------------

### Creating and Configuring a Blank Equippable Component

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/itemcomponents/equippable/elements/expressions/ExprSecBlankEquipComp.html

Demonstrates how to initialize a blank equippable component section and set its various properties, such as camera overlays, sounds, and equipment slots.

```skript
set {_component} to a blank equippable component:
	set the camera overlay to "custom_overlay"
	set the allowed entities to a zombie and a skeleton
	set the equip sound to "block.note_block.pling"
	set the equipped model id to "custom_model"
	set the shear sound to "ui.toast.in"
	set the equipment slot to chest slot
	allow event-equippable component to be damage when hurt
	allow event-equippable component to be dispensed
	allow event-equippable component to be equipped onto entities
	allow event-equippable component to be sheared off
	allow event-equippable component swap equipment
set the equippable component of {_item} to {_component}
```

--------------------------------

### Initialize EntityData Example

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/entity/BeeData.html

Demonstrates initializing entity data by spawning a pig and capturing it as an event-entity.

```skript
            
                spawn a pig at location(0, 0, 0):
                        set {_entity} to event-entity
                spawn {_entity} at location(0, 0, 0)
            
```

--------------------------------

### Looping Examples

Source: https://docs.skriptlang.org/expressions

Demonstrates various loop structures including countdowns, block iteration, list iteration, and conditional logic within loops.

```skript
loop 10 times:  
message "%11 - loop-number%"  
wait a second
```

```skript
loop blocks from the block below the player to the block 10 east of the block below the player:  
loop blocks from the loop-block to the block 10 north of the loop-block:  
set loop-block-2 to any wool
```

```skript
loop {top-balances::*}:  
loop-iteration <= 10  
send "#%loop-iteration% %loop-index% has $%loop-value%"
```

```skript
loop shuffled (integers between 0 and 8):  
if all:  
previous loop-value = 1  
loop-value = 4  
next loop-value = 8  
then:  
kill all players
```

--------------------------------

### Retrieve Node Path Steps

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/config/Node.html

Example demonstrating the structure of a config file and the resulting path array returned by getPathSteps.

```text
    w.x:
     y:
      z: true # this node
```

--------------------------------

### Manage Display Brightness Overrides

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/entity/displays/elements/expressions/ExprDisplayBrightness.html

Examples demonstrating how to set, modify, and clear brightness overrides for display entities.

```skript
set sky light override of the last spawned text display to 7
```

```skript
subtract 3 from the block light level override of the last spawned text display
```

```skript
if sky light level override of {_display} is 5:
	clear brightness override of {_display}
```

--------------------------------

### Accessing World Properties

Source: https://docs.skriptlang.org/expressions

Examples demonstrating how to reference worlds, teleport to spawns, and modify weather based on world context.

```skript
world is "world_nether"
```

```skript
teleport the player to the world's spawn
```

```skript
set the weather in the player's world to rain
```

```skript
set {_world} to world of event-chunk
```

--------------------------------

### Create and manipulate a queue

Source: https://docs.skriptlang.org/expressions

Demonstrates initializing a queue, adding elements, and retrieving elements which removes them from the queue.

```skript
set {queue} to a new queue
add "hello" and "there" to {queue}
broadcast the first element of {queue} # hello
broadcast the first element of {queue} # there
# queue is now empty

set {queue} to a new queue of "hello" and "there"
broadcast the last element of {queue} # removes 'there'
add "world" to {queue}
broadcast the first 2 elements of {queue} # removes 'hello', 'world'
```

--------------------------------

### on brewing start

Source: https://docs.skriptlang.org/events.html

Triggered when a brewing stand begins the brewing process.

```APIDOC
## on brewing start

### Description
Called when a brewing stand starts brewing.

### Patterns
- on brewing started
- on brewing starting

### Since
2.13

### Example
```
on brewing start: set the brewing time to 1 second
```
```

--------------------------------

### ArrayIterator(T[] array, int start)

Source: https://docs.skriptlang.org/javadocs/ch/njol/util/coll/iterator/ArrayIterator.html

Constructs a new ArrayIterator for the specified array starting at a given index.

```APIDOC
## Constructor: ArrayIterator(T[] array, int start)

### Description
Creates an iterator to traverse the provided array starting from the specified index.

### Parameters
- **array** (T[]) - Required - The array to iterate over.
- **start** (int) - Required - The starting index for the iteration.
```

--------------------------------

### Initialize CatData with Entity Context

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/entity/CatData.html

Demonstrates how to spawn entities and handle them within the Skript environment.

```skript
spawn a pig at location(0, 0, 0):
                        set {_entity} to event-entity
                spawn {_entity} at location(0, 0, 0)
```

--------------------------------

### Retrieve arguments with get

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/common/function/FunctionArguments.html

Use get to retrieve an argument by name, automatically casting it to the expected type.

```java
Number value = args.get("n");
Boolean value = args.get("b");
Number[] value = args.get("ns");
args.get("b"); // inline
```

--------------------------------

### Skript Potion Effect Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/potion/elements/effects/EffApplyPotionEffect.html

Examples of how to use the apply potion effect syntax within Skript scripts.

```skript
apply swiftness 2 to the player
```

```skript
command /strengthboost:
	trigger:
		apply strength 10 to the player for 5 minutes
```

```skript
apply the potion effects of the player's tool to the player
```

--------------------------------

### Initialize BoatData with Skript syntax

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/entity/BoatData.html

Example usage of spawning entities within Skript scripts.

```skript
            
                spawn a pig at location(0, 0, 0):
                        set {_entity} to event-entity
                spawn {_entity} at location(0, 0, 0)
            
        
```

--------------------------------

### Teleportation Examples

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/entity/elements/effects/EffTeleport.html

Basic usage examples for the teleport effect, including standard teleportation and advanced usage with flags.

```skript
teleport the player to {home::%uuid of player%}
```

```skript
teleport the attacker to the victim
```

```skript
on dismount:
	cancel event
	teleport the player to {server::spawn} retaining vehicle and passengers
```

--------------------------------

### build()

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/registration/SyntaxInfo.Builder.html

Finalizes the configuration and constructs a new SyntaxInfo instance.

```APIDOC
## Method: build()

### Description
Builds a new syntax info from the set details.

### Returns
- **SyntaxInfo<E>** - A syntax info representing the class providing the syntax's implementation.
```

--------------------------------

### Define Minecraft Tags

Source: https://docs.skriptlang.org/expressions?search=

Examples of defining various Minecraft, Paper, and custom tags for items, blocks, or entities.

```skript
minecraft tag "dirt" # minecraft:dirt  
  
paper tag "doors" # paper:doors  
  
tag "skript:custom_dirt" # skript:custom_dirt  
  
custom tag "dirt" # skript:dirt  
  
datapack block tag "dirt" # minecraft:dirt  
  
datapack tag "my_pack:custom_dirt" # my_pack:custom_dirt  
  
tag "minecraft:mineable/pickaxe" # minecraft:mineable/pickaxe  
  
custom item tag "blood_magic_sk/can_sacrifice_with" # skript:blood_magic_sk/can_sacrifice_with
```

--------------------------------

### Create and Configure World Borders

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/worldborder/elements/expressions/ExprSecCreateWorldBorder.html

Examples demonstrating how to create virtual world borders for players and worlds, including setting properties like radius, center, and warning distance.

```skript
on join:
	set {_location} to location of player
	set worldborder of player to a virtual worldborder:
		set worldborder radius to 25
		set world border center of event-worldborder to {_location}
```

```skript
on load:
	set worldborder of world "world" to a worldborder:
		set worldborder radius of event-worldborder to 200
		set worldborder center of event-worldborder to location(0, 64, 0)
		set worldborder warning distance of event-worldborder to 5
```

--------------------------------

### Pathfinding Target Usage Example

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/entity/elements/expressions/ExprPathfindingTarget.html

Demonstrates how to check the target entity during a pathfind event.

```skript
on pathfind:
	if the pathfinding target entity is a villager:
	 broadcast "I suspect a zombie is going towards a villager right now.."
```

--------------------------------

### Spawner Type Expression

Source: https://docs.skriptlang.org/expressions?search=

Gets, sets, resets, or clears the entity type of a mob spawner block.

```APIDOC
## Expression: [the] (spawner|entity|creature) type[s] of %blocks%

### Description
Gets or modifies the entity type of a mob spawner. Supports resetting to pig or clearing the type (Minecraft 1.20.0+).

### Return Type
Entity Type

### Requirements
Minecraft 1.20.0+ (for clear functionality)

### Examples
- set the creature type of {_spawner} to a trader llama
- reset {_spawner}'s entity type
- clear the spawner type of {_spawner}
```

--------------------------------

### Basic SET operation hint example

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/variables/HintManager.html

Demonstrates how a basic SET operation establishes a type hint for a variable.

```Skript
set {_x} to 5
# hint for {_x} is Integer.class
```

--------------------------------

### Set Camera Overlay

Source: https://docs.skriptlang.org/expressions?search=

Demonstrates how to set a camera overlay on an item or an equippable component using a namespaced key.

```skript
set the camera overlay of {_item} to "custom_overlay"

set {_component} to the equippable component of {_item}
set the camera overlay of {_component} to "custom_overlay"
```

--------------------------------

### getIndex()

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/util/slot/EquipmentSlot.html

Gets the index of the slot.

```APIDOC
## getIndex()

### Description
Retrieves the index of this slot.

### Returns
- **int** - The slot index.
```

--------------------------------

### Create Loot Context Example

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/loottables/elements/expressions/ExprSecCreateLootContext.html

Demonstrates how to define a loot context using the section expression and apply it to a loot table.

```skript
set {_player} to player
set {_context} to a loot context at player:
 set loot luck value to 10
 set looter to {_player}
 set looted entity to last spawned pig
give player loot items of loot table "minecraft:entities/iron_golem" with loot context {_context}
```

--------------------------------

### Difficulty

Source: https://docs.skriptlang.org/docs.html

Gets or sets the difficulty of a world.

```APIDOC
## Expression: Difficulty

### Description
The difficulty of a world.

### Patterns
- [the] difficult(y|ies) of %worlds%
- %worlds%'[s] difficult(y|ies)

### Return Type
Difficulty

### Examples
set the difficulty of "world" to hard
```

--------------------------------

### scale()

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/particles/particleeffects/ScalableEffect.html

Gets the current scale of the particles.

```APIDOC
### double scale()

Gets the current scale of the particles.

**Returns:**
- the scale value
```

--------------------------------

### While Loop Examples

Source: https://docs.skriptlang.org/docs.html?isNew=

Loops that repeat based on a condition. Always include a delay to prevent server crashes.

```Skript
while size of all players < 5:  
send "More players are needed to begin the adventure" to all players  
wait 5 seconds
```

```Skript
set {_counter} to 1  
do while {_counter} > 1: # false but will increase {_counter} by 1 then get out  
add 1 to {_counter}
```

```Skript
while player is online:  
give player 1 dirt  
wait 1 second # without using a delay effect the server will crash
```

--------------------------------

### get

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/variables/HintManager.html

Obtains the type hints for a variable.

```APIDOC
## get(Variable<?> variable) / get(String variableName)

### Description
Obtains the type hints for the specified variable or variable name in the current scope.

### Returns
- **Set<Class<?>>** - An unmodifiable set of hints.
```

--------------------------------

### getAmount()

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/util/slot/EquipmentSlot.html

Gets the amount of items in the slot.

```APIDOC
## getAmount()

### Description
Returns the quantity of items currently in the slot.

### Returns
- **int** - The item count.
```

--------------------------------

### logEventStart(Event event)

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/SkriptEventHandler.html

Logs the start of a Bukkit event. Requires Skript.logVeryHigh() to be enabled.

```APIDOC
### Method
`public static void logEventStart(org.bukkit.event.Event event)`

### Description
Logs that the provided Event has started. Requires `Skript.logVeryHigh()` to be true to log anything.

### Parameters
- **event** (org.bukkit.event.Event) - The Event that started.
```

--------------------------------

### Entity Event Examples

Source: https://docs.skriptlang.org/docs.html?search=

Demonstrates basic entity manipulation within events.

```skript
give a diamond sword of sharpness 3 to the player

kill the creeper

kill all powered creepers in the wolf's world

projectile is an arrow
```

--------------------------------

### Pathfind Event

Source: https://docs.skriptlang.org/docs.html

Triggered when an entity starts pathfinding.

```APIDOC
## on [entity] [start[s]] pathfind[ing]

### Description
Called whenever an entity tries to pathfind to a location or another entity.
```

--------------------------------

### Player Speed Expression Examples

Source: https://docs.skriptlang.org/expressions

Shows how to set or increase walking and flying speeds for players.

```Skript
set the player's walk speed to 1  
  
increase the argument's fly speed by 0.1
```

--------------------------------

### Ignition Event

Source: https://docs.skriptlang.org/docs.html

Triggered when a block starts burning.

```APIDOC
## on block ignite

### Description
Called when a block starts burning.

### Example
on block ignite: if event-block is a ladder: cancel event
```

--------------------------------

### void onPreInit(Collection<Config> configs)

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/ScriptLoader.ScriptPreInitEvent.html

The primary method for the ScriptPreInitEvent, allowing modification of the configuration collection before loading.

```APIDOC
## void onPreInit(Collection<Config> configs)

### Description
This method is invoked when the ScriptPreInitEvent triggers. It allows developers to modify the provided collection of Config objects, directly affecting which configurations are loaded by the ScriptLoader.

### Parameters
- **configs** (Collection<Config>) - Required - The collection of Config objects to be loaded.
```

--------------------------------

### On Bed Enter

Source: https://docs.skriptlang.org/events.html

Triggered when a player starts sleeping.

```APIDOC
## Event: On Bed Enter

### Description
Called when a player starts sleeping.

### Patterns
- [on] bed enter[ing]
- [on] [player] enter[ing] [a] bed

### Since
1.0
```

--------------------------------

### Vector Length

Source: https://docs.skriptlang.org/expressions

Gets or sets the length of a vector.

```APIDOC
## standard length of %vector%

### Description
Gets or sets the length of a vector.

### Usage
`set standard length of {_v} to 2`
```

--------------------------------

### logEventStart(Event event, EventPriority priority)

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/SkriptEventHandler.html

Logs the start of a Bukkit event with a specific priority. Requires Skript.logVeryHigh() to be enabled.

```APIDOC
### Method
`public static void logEventStart(org.bukkit.event.Event event, @Nullable org.bukkit.event.EventPriority priority)`

### Description
Logs that the provided Event has started with a priority. Requires `Skript.logVeryHigh()` to be true to log anything.

### Parameters
- **event** (org.bukkit.event.Event) - The Event that started.
- **priority** (org.bukkit.event.EventPriority) - The priority of the Event.
```

--------------------------------

### World Border

Source: https://docs.skriptlang.org/docs.html

Get the border of a world or a player.

```APIDOC
## World Border

### Description
Get the border of a world or a player. A player's world border is not persistent. Restarts, quitting, death or changing worlds will reset the border.

### Usage Example
set {_border} to world border of player's world
```

--------------------------------

### Manage Brewing Stand Fuel Level

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/brewing/elements/expressions/ExprBrewingFuelLevel.html

Examples showing how to set the fuel level of a brewing stand and how to clear it.

```skript
set the brewing stand fuel level of {_block} to 10
clear the brewing stand fuel level of {_block}
```

--------------------------------

### Bed

Source: https://docs.skriptlang.org/docs.html

Gets the bed location of an offline player.

```APIDOC
## Bed

### Description
Retrieves the bed location for a given offline player, with options to filter for valid or safe locations.
```

--------------------------------

### Traversing Nodes via Steps

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/config/NodeNavigator.html

Example configuration structure used to demonstrate node traversal using variable-length steps.

```yaml
first:
	one: value
	two:
		three: value
```

--------------------------------

### Beacon Tier

Source: https://docs.skriptlang.org/docs.html

Gets the tier level of a beacon.

```APIDOC
## Beacon Tier

### Description
Returns the current tier of a beacon, ranging from 0 to 4.

### Usage
`if the beacon tier of the clicked block is 4:
	send "This is a max tier beacon!"`
```

--------------------------------

### RegistryClassInfo(Class<R> registryClass, org.bukkit.Registry<R> registry, String codeName, String languageNode)

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/classes/registry/RegistryClassInfo.html

Initializes a new RegistryClassInfo instance with basic registry mapping.

```APIDOC
### Constructor
RegistryClassInfo(Class<R> registryClass, org.bukkit.Registry<R> registry, String codeName, String languageNode)

### Parameters
- **registryClass** (Class<R>) - The registry class
- **registry** (org.bukkit.Registry<R>) - The registry
- **codeName** (String) - The name used in patterns
- **languageNode** (String) - The language node of the type
```

--------------------------------

### Retrieve All Operators

Source: https://docs.skriptlang.org/docs.html?search=

Get a list of all server operators.

```Skript
set {_ops::*} to all operators
```

--------------------------------

### duration

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/potion/util/SkriptPotionEffect.html

Gets or sets the duration of the potion effect.

```APIDOC
## SkriptPotionEffect.duration()

### Description
Returns the duration of this potion effect. Will be PotionEffect.INFINITE_DURATION if this effect is infinite().

## SkriptPotionEffect.duration(int)

### Description
Updates the duration of this potion effect.

### Parameters
- **duration** (int) - Required - The new duration of this potion effect.

### Returns
- **SkriptPotionEffect** - This potion effect.
```

--------------------------------

### getID(Class<?> clazz)

Source: https://docs.skriptlang.org/javadocs/ch/njol/yggdrasil/ClassResolver.html

Gets an ID for a Class.

```APIDOC
## String getID(Class<?> clazz)

### Description
Gets an ID for a Class. The ID is used to identify the type of saved object. Returns the ID of the given class, or null if this is not a class of the implementor.

### Parameters
- **clazz** (Class<?>) - Required - The class to get the ID of

### Returns
- **String** - The ID of the given class or null
```

--------------------------------

### void open()

Source: https://docs.skriptlang.org/javadocs/ch/njol/util/OpenCloseable.html

Opens the object. This method should be called to initialize or start the resource.

```APIDOC
### void open()

Opens the object. This method is intended to be called to prepare the resource for use.
```

--------------------------------

### Create a standard boss bar

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/bossbar/elements/expressions/ExprSecCreateBossBar.html

Demonstrates creating a boss bar on player join, configuring its properties, and managing viewers.

```skript
on join:
	set {_bar} to a boss bar:
		set color of event-bossbar to white
		set title of event-bossbar to "<green>Welcome %player%!"
		set progress of event-bossbar to 50%
		set style of event-bossbar to 6 notches
		make event-bossbar darken the sky
	add player to viewers of {_bar}
	wait 5 seconds
	remove player from viewers of {_bar}
```

--------------------------------

### get()

Source: https://docs.skriptlang.org/javadocs/ch/njol/util/NotifyingReference.html

Retrieves the current value stored in the reference.

```APIDOC
## V get()

### Description
Returns the value currently held by this reference.

### Returns
- **V** - The stored value, or null if not set.
```

--------------------------------

### Looping and Storing Inventory Items

Source: https://docs.skriptlang.org/expressions

Demonstrates iterating through inventory items and storing them into a list variable.

```skript
loop all items in the player's inventory:  
loop-item is enchanted  
remove loop-item from the player
```

```skript
set {inventory::%uuid of player%::*} to items in the player's inventory
```

--------------------------------

### numVariables

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/variables/Variables.html

Gets the total count of variables on the server.

```APIDOC
## numVariables()

### Description
Gets the amount of variables currently on the server.

### Returns
- **int** - The total count of variables.
```

--------------------------------

### Accessing and Modifying Book Pages

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/item/book/elements/expressions/ExprBookPages.html

Examples showing how to check page counts and set specific page content in Skript.

```skript
on book sign:
	if the number of pages of event-item is greater than 1:
		message "The second page of the authored book is: %page 2 of event-item%"
```

```skript
set page 1 of the player's held item to "This page was written with Skript!"
```

--------------------------------

### getEquipmentSlot()

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/util/slot/EquipmentSlot.html

Gets the Bukkit EquipmentSlot associated with this object.

```APIDOC
## getEquipmentSlot()

### Description
Retrieves the corresponding Bukkit EquipmentSlot.

### Returns
- **org.bukkit.inventory.EquipmentSlot** - The equipment slot type.
```

--------------------------------

### setupMetrics(Metrics metrics)

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/SkriptMetrics.html

Configures bstats charts on the provided Metrics object.

```APIDOC
### setupMetrics

#### Description
Helper method to set up bstats charts on the supplied Metrics object.

#### Signature
`public static void setupMetrics(org.bstats.bukkit.Metrics metrics)`

#### Parameters
- **metrics** (org.bstats.bukkit.Metrics) - The Metrics object to which charts will be added.
```

--------------------------------

### Get Gender

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/aliases/Aliases.html

Retrieves the gender associated with an item.

```java
public static int getGender(ItemData item)
```

--------------------------------

### init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/lang/SyntaxElement.html

Initializes the syntax element after the constructor and preInit have been called.

```APIDOC
## init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)

### Description
Called just after the constructor and preInit().

### Parameters
- **expressions** (Expression<?>[]) - All expressions included in the matching pattern.
- **matchedPattern** (int) - The index of the pattern which matched.
- **isDelayed** (Kleenean) - Whether this expression is used after a delay.
- **parseResult** (SkriptParser.ParseResult) - Additional information about the match.

### Returns
- **boolean** - Whether this expression was initialised successfully.
```

--------------------------------

### On Sprint Toggle

Source: https://docs.skriptlang.org/events.html

Triggered when a player starts or stops sprinting.

```APIDOC
## Event: on sprint toggle

### Description
Called when a player starts or stops sprinting. Use 'is sprinting' to check the player's state.

### Patterns
- [on] [player] toggl(e|ing) sprint
- [on] [player] sprint toggl(e|ing)
```

--------------------------------

### on sneak toggle

Source: https://docs.skriptlang.org/events.html

Triggered when a player starts or stops sneaking.

```APIDOC
## on sneak toggle

### Description
Called when a player starts or stops sneaking. Use is sneaking to get whether the player was sneaking before the event was called.

### Patterns
* [on] [player] toggl(e|ing) sneak
* [on] [player] sneak toggl(e|ing)

### Example
```
# make players that stop sneaking jump
on sneak toggle:
	player is sneaking
	push the player upwards at speed 0.5
```
```

--------------------------------

### Block Manipulation and Interaction

Source: https://docs.skriptlang.org/expressions

Examples demonstrating how to check block types, modify blocks at relative positions, and perform actions on blocks within a radius.

```Skript
block is iron ore
```

```Skript
set block below to air
```

```Skript
spawn a creeper above the block
```

```Skript
loop blocks in radius 4:
loop-block is obsidian
set loop-block to water
```

```Skript
block is a chest:
clear the inventory of the block
```

--------------------------------

### makeDefaultSources()

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/tags/sources/SkriptTagSource.html

Initializes the default tag sources for the Skript environment.

```APIDOC
## public static void makeDefaultSources()

### Description
Initializes and registers the default tag sources used by Skript.
```

--------------------------------

### Example of SectionNode and EntryData usage

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/lang/entry/EntryData.html

Demonstrates how entries like 'description' and 'trigger' relate to a SectionNode in Skript syntax.

```skript
command /example: # this is the SectionNode
  description: this is an example of an entry
  trigger: # this is also an example of an entry
    # code goes here (not entry data!)
```

--------------------------------

### on block ignite

Source: https://docs.skriptlang.org/events.html

Triggered when a flammable block starts burning.

```APIDOC
## on block ignite

### Description
Called when a block starts burning, i.e. a fire block is placed next to it and this block is flammable. The burn event will be called when the block is about to be destroyed by the fire.

### Patterns
- on block ignite

### Example
```skript
on block ignite:
	if event-block is a ladder:
		cancel event
```
```

--------------------------------

### on block damaging

Source: https://docs.skriptlang.org/events.html

Triggered when a player starts to break a block.

```APIDOC
## on block damaging

### Description
Called when a player starts to break a block.

### Pattern
`on block damag(ing|e)`

### Since
1.0

### Example
```
on block damaging:   
	if block is tagged with minecraft tag "logs":   
		send "You can't break the holy log!"
```
```

--------------------------------

### Handle Experience Events

Source: https://docs.skriptlang.org/docs.html

Examples for managing experience points during spawn, block break, breeding, and fishing events.

```skript
on experience spawn:
add 5 to the spawned experience

on break of coal ore:
clear dropped experience

on break of diamond ore:
if tool of player = diamond pickaxe:
add 100 to dropped experience

on breed:
breeding father is a cow
set dropped experience to 10

on fish catch:
add 70 to dropped experience
```

--------------------------------

### Retrieve and Use Enchantment Level Bounds

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/enchantments/elements/expressions/ExprMinMaxEnchantmentLevel.html

Examples demonstrating how to fetch and apply minimum and maximum enchantment levels in Skript scripts.

```skript
set {_maximum} to the maximum enchantment level of sharpness
if the level of sharpness of the player's tool is greater than {_maximum}:
	send "<gold>Your tool's sharpness level was capped out at the maximum allowed level.</gold>"
	set the level of sharpness of the player's tool to {_maximum}
```

```skript
set {_min} to the minimum enchantment level of sharpness
set {_max} to the maximum enchantment level of sharpness
loop integers between {_min} and {_max}:
	set slot loop-counter of {_gui} to enchanted book named "Sharpness %loop-value%" with lore "<reset>Click to enchant!"
```

--------------------------------

### Handle Bed Entry

Source: https://docs.skriptlang.org/events.html

Triggered when a player starts sleeping.

```skript
on bed enter:
```

--------------------------------

### Squared Length of Vector

Source: https://docs.skriptlang.org/expressions

Gets the squared length of a vector.

```APIDOC
## Expression: squared length of %vectors%

### Description
Calculates the squared length of a given vector.

### Return Type
Number

### Usage
`send "%squared length of vector 1, 2, 3%"`
```

--------------------------------

### Accessing Event Arguments

Source: https://docs.skriptlang.org/docs.html?isNew=

Use these examples to retrieve or manipulate arguments passed to commands.

```Skript
give the item-argument to the player-argument
```

```Skript
damage the player-argument by the number-argument
```

```Skript
give a diamond pickaxe to the argument
```

```Skript
add argument 1 to argument 2
```

```Skript
heal the last argument
```

--------------------------------

### Advanced scope sharing example

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/variables/HintManager.html

Illustrates the beginning of a SET operation in a context where hints are shared between scopes.

```Skript
set {_x} to 5
```

--------------------------------

### Respawn Location

Source: https://docs.skriptlang.org/expressions

Gets or sets the location where a player will respawn.

```APIDOC
## Expression: respawn location

### Description
Gets or sets the location that a player should respawn at. Used within the `on respawn` event.

### Pattern
`[the] respawn location`

### Return Type
Location

### Example
```
on respawn:
	set respawn location to {example::spawn}
```
```

--------------------------------

### Max Durability

Source: https://docs.skriptlang.org/docs.html?isNew=

Gets or sets the maximum durability of items.

```APIDOC
## max durability

### Description
Gets or sets the maximum durability of an item. Changing this requires Minecraft 1.20.5+.

### Usage
`max durability of %item types/item stacks/slots%`
```

--------------------------------

### RegistryClassInfo(Class<R> registryClass, org.bukkit.Registry<R> registry, String codeName, String languageNode, DefaultExpression<R> defaultExpression, Consumer<R> parseCallback)

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/classes/registry/RegistryClassInfo.html

Initializes a new RegistryClassInfo instance with both a default expression and a parse callback.

```APIDOC
### Constructor
RegistryClassInfo(Class<R> registryClass, org.bukkit.Registry<R> registry, String codeName, String languageNode, DefaultExpression<R> defaultExpression, Consumer<R> parseCallback)

### Parameters
- **registryClass** (Class<R>) - The registry class
- **registry** (org.bukkit.Registry<R>) - The registry
- **codeName** (String) - The name used in patterns
- **languageNode** (String) - The language node of the type
- **defaultExpression** (DefaultExpression<R>) - The default expression of the type
- **parseCallback** (Consumer<R>) - A consumer to run on a successful parse.
```

--------------------------------

### Horse Domestication

Source: https://docs.skriptlang.org/docs.html?isNew=

Gets or sets the domestication level of a horse.

```APIDOC
## Expression: Horse Domestication

### Description
Gets and/or sets the (max) domestication of a horse. The domestication level determines how close a horse is to being tame.

### Patterns
- [the] [max[imum]] domestication level of %living entities%
- %living entities%'[s] [max[imum]] domestication level

### Return Type
integer
```

--------------------------------

### Retrieve and Display Persistent Data Keys

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/pdc/elements/expressions/ExprAllPersistentDataKeys.html

Examples demonstrating how to retrieve and iterate over persistent data keys from an object.

```skript
set {_keys::*} to persistent data keys of player's tool
if size of {_keys::*} > 0:
 broadcast "The tool has the following persistent data keys: %{_keys::*}%"
else:
 broadcast "The tool has no persistent data keys."
```

```skript
for each {_key} in persistent data keys of player's tool:
 broadcast "Persistent data tag %{_key}%: %data tag {_key} of player's tool%"
```

--------------------------------

### Accessing Furnace Event Items

Source: https://docs.skriptlang.org/javadocs/org/skriptlang/skript/bukkit/block/furnace/elements/expressions/ExprFurnaceEventItems.html

Examples demonstrating how to retrieve or modify items during various furnace events.

```skript
on furnace smelt:
	broadcast smelted item
	# Or 'result'
```

```skript
on furnace extract:
	broadcast extracted item
```

```skript
on fuel burn:
	broadcast burned fuel
```

```skript
on smelting start:
	broadcast smelting item
	clear smelting item
```

--------------------------------

### Spawn Point

Source: https://docs.skriptlang.org/docs.html

Gets or sets the spawn point of a world.

```APIDOC
## Spawn Point

### Description
Retrieves or modifies the spawn location of a specific world.

### Examples
- teleport all players to spawn
- set the spawn point of "world" to the player's location
```

--------------------------------

### Variable Hinting Logic

Source: https://docs.skriptlang.org/javadocs/ch/njol/skript/variables/HintManager.html

Examples of how variable hints are managed during conditional execution and variable operations.

```skript
# hint for {_x} is Integer.class
if <some condition>:
  set {_x} to true
  # hint for {_x} is Boolean.class
# here, it is not known if the section above would have executed
# we consider all possible values
# thus, hints for {_x} are Integer.class and Boolean.class
```

```skript
add 5 to {_x::*}
# hint for {_x::*} is Integer.class
```

```skript
set {_x} to 5
# hint for {_x} is Integer.class
delete {_x}
# now, there are no hints for {_x}
```

```skript
set {_x} to 5
# hint for {_x} is Integer.class
if <some condition>:
  delete {_x}
  # now, there are no hints for {_x}
# the previous section no longer had hints for {_x}, so there is nothing to copy over
# thus, hint for {_x} is Integer.class
```

--------------------------------

### Source Block

Source: https://docs.skriptlang.org/docs.html

Gets the source block during a spread event.

```APIDOC
## Source Block

### Description
Returns the source block in a spread event.

### Examples
- on spread:
- if the source block is a grass block:
```
Tokens:
Raw