Skript Documentation Pages 9 - Complete Sitemap

Vectors - Random Vector

ExpressionSkript

Creates a random unit vector./docs?id=Skript-ExprVectorRandom Vectors - Spherical Shape

ExpressionSkript

Forms a 'spherical shaped' vector using yaw and pitch to manipulate the current point./docs?id=Skript-ExprVectorSpherical Vectors - Squared Length

ExpressionSkript

Gets the squared length of a vector./docs?id=Skript-ExprVectorSquaredLength Vectors - Vector Between Locations

ExpressionSkript

Creates a vector between two locations./docs?id=Skript-ExprVectorBetweenLocations Vectors - Vector from Location

ExpressionSkript

Creates a vector from a location./docs?id=Skript-ExprVectorOfLocation Vectors - Vector from Yaw and Pitch

ExpressionSkript

Creates a vector from a yaw and pitch value./docs?id=Skript-ExprVectorFromYawAndPitch Vectors - Vector Projection

ExpressionSkript

An expression to get the vector projection of two vectors./docs?id=Skript-ExprVectorProjection Vehicle

Makes an entity ride another entity, e.g. a minecart, a saddled pig, an arrow, etc./docs?id=Skript-EffVehicle Vehicle

ExpressionSkript

The vehicle an entity is in, if any. This can actually be any entity, e.g. spider jockeys are skeletons that ride on a spider, so the spider is the 'vehicle' of the skeleton. See also: <a href='#ExprPassenger'>passenger</a>/docs?id=Skript-ExprVehicle Vehicle

Represents a vehicle./docs?id=Skript-vehicle Velocity

ExpressionSkript

Gets or changes velocity of an entity or particle. Setting the velocity of a particle will remove its random dispersion and force it to be a single particle./docs?id=Skript-ExprVelocity Version

A Minecraft Version./docs?id=Lusk-8851 Version

ExpressionSkript

The version of Bukkit, Minecraft or Skript respectively./docs?id=Skript-ExprVersion Version - from String

Gets a version from a string./docs?id=Lusk-ExprVersion Version - is Valid

Checks if the string is a valid version/docs?id=Lusk-CondVersionValid Version String

ExpressionSkript

The text to show if the protocol version of the server doesn't match with protocol version of the client. You can check the <a href='#ExprProtocolVersion'>protocol version</a> expression for more information about this. This can only be set in a <a href='#server_list_ping'>server list ping</a> event./docs?id=Skript-ExprVersionString Vibration

Creates a new vibration to be used with 'vibration' particle. `to` = The destination location the particle will travel to. `arrivalTime` = The time it will take to arrive at the destination location./docs?id=SkBee-vibration View Distance

ExpressionSkript

The view distance of a world or a player. The view distance of a player is the distance in chunks sent by the server to the player. This has nothing to do with client side view distance settings. View distance is capped between 2 to 32 chunks./docs?id=Skript-ExprViewDistance View Distance of Client

ExpressionSkript

The view distance of the client. Can not be changed. This differs from the server side view distance of player as this will retrieve the view distance the player has set on their client./docs?id=Skript-ExprClientViewDistance View Range

ExpressionDisplayEntityUtils

Get/Set the view range of an active group/part/filter/docs?id=DisplayEntityUtils-ExprActiveViewRange Viewers

ExpressionSkript

Represents something that is viewing something./docs?id=Skript-PropExprViewers Villager - Effects

A few effects to make villagers do things./docs?id=SkBee-EffVillagerEffects Villager Acquire Trade

Called whenever a villager acquires a new trade./docs?id=SkBee-villager_acquire_trade Villager Career Change Reason

Represents a reason why a villager changed its career./docs?id=Skript-villagercareerchangereason Villager Level/Experience

ExpressionSkript

Represents the level/experience of a villager. The level will determine which trades are available to players (value between 1 and 5, defaults to 1). When a villager's level is 1, they may lose their profession if they don't have a workstation. Experience works along with the leveling system, determining which level the villager will move to. Experience must be greater than or equal to 0. Learn more about villager levels on <a href='https://minecraft.wiki/w/Trading#Level'>Minecraft Wiki</a>/docs?id=Skript-ExprVillagerLevel Villager Profession

ExpressionSkript

Represents the profession of a villager/zombie villager./docs?id=Skript-ExprVillagerProfession Villager Profession

Represents the different professions of villagers./docs?id=Skript-villagerprofession Villager Type

ExpressionSkript

Represents the type of a villager/zombie villager. This usually represents the biome the villager is from./docs?id=Skript-ExprVillagerType Villager Type

Represents the different types of villagers. These are usually the biomes a villager can be from./docs?id=Skript-villagertype Vindicator - is Johnny

Checks if a vindicator is Johnny./docs?id=Lusk-CondVindicatorJohnny Vindicator - Johnny State

Get and Set whether 1 or more vindicators are Johnny. Changing this does not modify the vindicator's name./docs?id=Lusk-ExprVindicatorJohnny Virtual Inventory

Expressionskript-gui

Obtains a new inventory that can be used for creating a GUI./docs?id=skript-gui-ExprVirtualInventory Voice Channel Status

ExpressionDiSky

The custom voice status text currently set on this voice channel./docs?id=DiSky-PropVoiceChannelVoiceStatus Voice Channel With Id

ExpressionDiSky

The voice channel with the given id, from cache./docs?id=DiSky-GetterExpr_VoiceChannel Voicechannel

/docs?id=DiSky-voicechannel Voxel Shape

A Voxel Shape, usually used for blocks such as Stairs. You can store those but it's not persistent across restarts./docs?id=Lusk-voxelshape Voxel Shape - of Block

Returns the detailed collision shape of a block./docs?id=Lusk-ExprVoxelShapeOf Wake And Sleep

Make bats and foxes sleep or wake up. Make villagers sleep by providing a location of a bed. Make players sleep by providing a location of a bed. Using 'with force' will bypass "nearby monsters" ,the max distance, allowing players to sleep even if the bed is far away, and lets players sleep in the nether and end. Does not work if the location of the bed is not in the world the player is currently in. Using 'without spawn location update' will make players wake up without setting their spawn location to the bed./docs?id=Skript-EffWakeupSleep Warden - Anger

Returns the anger of a warden. Angry = 80 or above Agitated = 40-79 Calm = 0-39 Use the respective conditions to check for those 3 states./docs?id=Lusk-ExprWardenAnger Warden - Disturb

Makes a warden sense a disturbance at the provided location./docs?id=Lusk-EffWardenDisturbance Warden - is Agitated

Checks if a Warden is agitated./docs?id=Lusk-CondWardenAgitated Warden - is Calm

Checks if a Warden is calm./docs?id=Lusk-CondWardenCalm Warden - Prey

Returns the entity at which this warden is most angry./docs?id=Lusk-ExprWardenPrey Warden Anger (Event)

Returns the past/future anger of the warden in the Warden Anger Change event. The future anger level can be set./docs?id=Lusk-ExprWardenEventAnger Warden Anger Level

ExpressionSkript

The anger level a warden feels towards an entity. A warden can be angry towards multiple entities with different anger levels. If an entity reaches an anger level of 80+, the warden will pursue it. Anger level maxes out at 150./docs?id=Skript-ExprWardenEntityAnger Warden Most Angered At

ExpressionSkript

The entity a warden is most angry at. A warden can be angry towards multiple entities with different anger levels./docs?id=Skript-ExprWardenAngryAt Warning Distance of World Border

ExpressionSkript

The warning distance of a world border. The player's screen will be tinted red when they are within this distance of the border. Players only see a red tint when approaching a world's worldborder and the warning distance has to be an integer greater than or equal to 0./docs?id=Skript-ExprWorldBorderWarningDistance Warning Time of World Border

ExpressionSkript

The warning time of a world border. If the border is shrinking, the player's screen will be tinted red once the border will catch the player within this time period./docs?id=Skript-ExprWorldBorderWarningTime Watch Condition (Listener)

SectionskLambda

Edge-triggered condition watcher: polls a condition on a timer and fires on the transition, not on every poll. `watch when <condition> every %timespan%:` with `on rising:` (the moment it goes false -> true) and/or `on falling:` (true -> false). This is "do X the moment Y first becomes true" without writing a poll loop. The condition's state at the first poll is the baseline, so a transition is needed to fire (a condition already true at the start won't fire `on rising` until it goes false then true again). Optional entry: `owner: %offlineplayer/entity/chunk/world%` auto-stops the watcher when the owner goes away. Optional blocks: `on timeout:` (needs `within %timespan%`) and `on end:`. The result is a normal listener handle: `pause`, `resume`, `unregister`, `is registered`, and `/sklambda listeners` all work. The condition is checked on the main thread./docs?id=skLambda-SecWatchCondition Watch Section (Listener)

SectionskLambda

Polls a value on a timer and runs `on change:` whenever it differs from the last poll (change detection built in). `watch %value% every %timespan%:` re-evaluates the expression each interval. `watch %lambda% for %arguments% every %timespan%:` calls the lambda with those arguments each interval. Inside `on change:`, `old value` and `new value` hold the previous and current values. Optional entry: `owner: %offlineplayer/entity/chunk/world%` auto-stops the watcher when the owner goes away. Optional blocks: `on timeout:` (needs `within %timespan%`) and `on end:` (runs whenever the watcher stops, for teardown). The result is a normal listener handle: `pause`, `resume`, `unregister`, `is registered`, and `/sklambda listeners` all work. Declare one with `set %~object% to a watcher on ...` then `register` it, or use the bare `watch ...` form to start immediately. The value is read on the main thread, so the watched expression/lambda must be safe there (the usual Skript rule)./docs?id=skLambda-SecWatch Watched Value

ExpressionskLambda

Inside a watcher's `on change` block, the value before the change (`old value`) and after it (`new value`)./docs?id=skLambda-ExprWatchValue Weather

ExpressionSkript

The weather of a world or player. Clearing or resetting the weather of a player will make the player's weather match the weather of the world. Clearing or resetting the weather of a world will make the weather clear./docs?id=Skript-ExprWeather Weather Type

The weather types sunny, rainy, and thundering./docs?id=Skript-weathertype Webhook

/docs?id=DiSky-webhook Webhook Channel

ExpressionDiSky

The channel the webhook posts to. Set it to a text channel to move the webhook./docs?id=DiSky-PropWebhookWebhookChannel Webhook Message Avatar URL

ExpressionDiSky

The image URL the webhook displays as its avatar for this message only./docs?id=DiSky-PropWebhookMessageActionWebhookAvatarUrl Webhook Message Thread

ExpressionDiSky

The thread the message is posted in. The webhook must belong to the thread's parent channel./docs?id=DiSky-PropWebhookMessageActionWebhookThread Webhook Message Thread ID

ExpressionDiSky

The id of the thread the message is posted in, for when only the id is known./docs?id=DiSky-PropWebhookMessageActionWebhookThreadId Webhook Message Username

ExpressionDiSky

The name the webhook displays for this message only, instead of its own./docs?id=DiSky-PropWebhookMessageActionWebhookUsername Webhook Owner

ExpressionDiSky

The member who owns/created the webhook, or null if it is unknown./docs?id=DiSky-PropWebhookWebhookOwner Webhook Source Channel ID

ExpressionDiSky

For a channel follower webhook, the id of the announcement channel it relays; nothing otherwise./docs?id=DiSky-PropWebhookWebhookSourceChannelId Webhook Source Guild ID

ExpressionDiSky

For a channel follower webhook, the id of the guild whose announcements it relays; nothing otherwise./docs?id=DiSky-PropWebhookWebhookSourceGuildId Webhook Token

ExpressionDiSky

The secret token of the webhook, or nothing when Discord did not expose it (for example a channel follower webhook). Anyone holding it can post through the webhook./docs?id=DiSky-PropWebhookClientWebhookToken Webhook Type

ExpressionDiSky

The kind of the webhook: INCOMING (posts through its URL) or CHANNEL_FOLLOWER (created by following an announcement channel)./docs?id=DiSky-PropWebhookWebhookType Webhook URL

ExpressionDiSky

The URL of the webhook (including its token)./docs?id=DiSky-PropWebhookWebhookUrl Webhookaction

/docs?id=DiSky-webhookaction Webhookclient

/docs?id=DiSky-webhookclient Webhookmessageaction

/docs?id=DiSky-webhookmessageaction Weight

Expressionskript-luckperms

Represents the weight of something./docs?id=skript-luckperms-PropExprWeight WeightedList

A weighted list that allows for random selection based on entry weights./docs?id=SkBee-weightedlist WeightedList - Add Entry

Adds an entry to a weighted list with a specified weight. Weight must be greater than 0./docs?id=SkBee-EffWeightedListAddEntry WeightedList - Create

ExpressionSkBee

Creates a new weighted list for use with other WeightedList expressions./docs?id=SkBee-ExprWeightedListCreate WeightedList - Random Element

ExpressionSkBee

Returns a random element from the provided weighted list. Optionally you can include an amount of multiple random weighted elements from the list./docs?id=SkBee-ExprWeightedListRandomElement Welcome Channel Target

ExpressionDiSky

The channel a welcome screen entry points to. Empty when the bot cannot see it./docs?id=DiSky-PropWelcomeChannelWelcomeChannel Welcome Screen Enabled

ExpressionDiSky

Whether the welcome screen is shown to new members of the guild./docs?id=DiSky-PropWelcomeScreenBuilderWelcomeScreenEnabled Welcomechannel

/docs?id=DiSky-welcomechannel Welcomescreen

/docs?id=DiSky-welcomescreen Welcomescreenbuilder

/docs?id=DiSky-welcomescreenbuilder Whether

ExpressionSkript

A shorthand for returning the result of a condition (true or false). This is functionally identical to using 'true if <condition> else false'. Many conditions also support being changed through this expression, typically using 'set'./docs?id=Skript-ExprWhether While Loop

While Loop sections are loops that will just keep repeating as long as a condition is met./docs?id=Skript-SecWhile Whitelist

ExpressionSkript

An expression for obtaining and modifying the server's whitelist. Players may be added and removed from the whitelist. The whitelist can be enabled or disabled by setting the whitelist to true or false respectively./docs?id=Skript-ExprWhitelist Will Be Damaged

This Condition requires Paper. Checks whether or not the entity in the Pre Damage Event will be damaged./docs?id=Lusk-CondWillBeDamaged Will Consume Boosting Firework

ConditionSkript

Checks to see if the firework used in an 'elytra boost' event will be consumed./docs?id=Skript-CondElytraBoostConsume Will Despawn

ConditionSkript

Checks if the dropped item will be despawned naturally through Minecraft's timer./docs?id=Skript-CondItemDespawn Will Despawn

ConditionSkript

Checks if the dropped item will be despawned naturally through Minecraft's timer./docs?id=Skript-CondItemDespawn-2 Will Raise Composter Level

This Condition requires Paper. Checks whether or not the composter's level will rise in a Compost Item Event/docs?id=Lusk-CondRiseComposterLevel With Fire Resistance

ExpressionSkript

Creates a copy of an item with (or without) fire resistance./docs?id=Skript-ExprWithFireResistance Wolf Variant

Represents the variant of a wolf entity. NOTE: Minecraft namespaces are supported, ex: 'minecraft:ashen'./docs?id=Skript-WolfVariant world

Gets a world from its name./docs?id=Skript-world-2 World

ExpressionSkript

The world the event occurred in./docs?id=Skript-ExprWorld World

One of the server's worlds. Worlds can be put into scripts by surrounding their name with double quotes, e.g. "world_nether", but this might not work reliably as text uses the same syntax./docs?id=Skript-world World AutoSave

ExpressionSkBee

Turn on/off world auto saving. This will prevent changes in the world to be saved to file. This doesn't appear to work when the server stops, so you may need to manually unload your world./docs?id=SkBee-ExprWorldAutoSave World Border

ExpressionSkript

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./docs?id=Skript-ExprWorldBorder World Border

Represents the border of a world or player./docs?id=Skript-worldborder World Creator

ExpressionSkBee

Create a new world creator. This will be used to create a new world. After creating a world creator you will need to load the world. **Name/Key**: - Name: This is the name of your new world (As of Minecraft 26.1, names are discouraged and keys are suggested. - Key: This is the key of your new world, and is used to identify it. - As of Minecraft 26.1, the key will determine where your world folder is saved within the `world/dimensions` folder. **Other**: - Copy will create a fresh new world with the same seed and settings. - Clone will create a carbon copy of your world, if the world is large, this process may take a while. The file copying process will happen on another thread, so this won't freeze your server. - `without saving` = Optionally prevent saving of the world that will be cloned. Saving freezes the server for a bit so this can help speed up the process... if you don't need that world saved at this moment in time./docs?id=SkBee-ExprWorldCreator World Creator

Used to create new worlds./docs?id=SkBee-worldcreator World Creator - Create Section

ExpressionSkBee

Create a new world creator with several options to customize. **Entires**: - `key` = Represents the NamespacedKey of your world (required, accepts NamespacedKey/String). - `seed` = Represents the seed if your world [optional, defaults to random]. - `world_type` = The WorldType of your world [optional, defaults to normal]. - `environment` = The Environment of your world [optional, defaults to normal]. - `generator_settings` = The generator settings of your world used for flat worlds [optional String]. - `structures` = Whether to generate vanilla structures in the world [optional Boolean, defaults to true]. - `hardcore` = Whether to enable hardcore mode in the world [optional Boolean, defaults to false]. - `load_on_start` = Whether to load the world automatically on server start [optional Boolean, defaults to false]. - `spawn_location` = The spawn location of the world [optional Location, Minecraft will try to find one for you]. - `chunk_generator` = A custom chunk generator [optional String, ID of a custom chunk generator]. - `copy_world` = A World to copy settings from [optional World]. - `clone_world` = A World to fully clone [optional World]./docs?id=SkBee-ExprWorldCreatorSection World Creator Options

ExpressionSkBee

Set different options for world creators. See SkBee wiki for more details. NOTE: 'load on start' will bypass 'auto-load-custom-worlds' in SkBee config. `fixed spawn location` = This is used to override Minecraft attempting to find a spawn location (Which takes a LONG time), this option can greatly speed up world creation./docs?id=SkBee-ExprWorldCreatorOption World Edit Mask

Typeskript-worldedit

Represents a mask that can be used for WorldEdit operations./docs?id=skript-worldedit-worldeditmask World Edit Pattern

Typeskript-worldedit

Represents a pattern that can be used for WorldEdit operations./docs?id=skript-worldedit-worldeditpattern World Edit Region

Typeskript-worldedit

Represents a region that can be used for WorldEdit operations./docs?id=skript-worldedit-worldeditregion World Environment

ExpressionSkript

The environment of a world/docs?id=Skript-ExprWorldEnvironment World Environment

Represents the environment of a world./docs?id=Skript-environment World Exists

Check if a world exists in your world directory./docs?id=SkBee-CondWorldExists World from Name

ExpressionSkript

Returns the world from a string./docs?id=Skript-ExprWorldFromName World GameRule Change

Called when a gamerule is changed in a world./docs?id=SkBee-world_gamerule_change World Seed

ExpressionSkript

The seed of given world. Note that it will be returned as Minecraft internally treats seeds, not as you specified it in world configuration./docs?id=Skript-ExprSeed World Spawn Limit

ExpressionSkBee

Get/set the spawn limit of a world. If the world is ommited, the server spawn limit will be returned. World spawn limits can be changed, server spawn limits cannot. If set to a negative number the world will use the server-wide spawn limit instead, reset will do the same. You can read more about [**Mob Caps**](https://minecraft.wiki/w/Mob_spawning#Java_Edition_mob_cap) on McWiki Note: The `misc` category is not supported by this expression. Note: Changes are not persistent thru server restarts./docs?id=SkBee-ExprWorldSpawnLimit World Time

ExpressionSkBee

Get/set the time of world, represented as an integer. `world time` = The 24000 tick day cycle of a world. `full world time` = The time of a world over all days./docs?id=SkBee-ExprWorldTime WorldBorder - Change Duration

Returns the duration of the change in the World Border Start Change event. Can be set. Requires Paper./docs?id=Lusk-ExprWorldBorderChangeDuration WorldBorder - Change is Instant

This Condition requires Paper. Checks whether or not the worldborder change is instant in the worldborder change event/docs?id=Lusk-CondIsInstantWorldBorderChange WorldBorder - New/Old Size

Returns the new/old anger of the warden in the World Border Change events. Can be set only within the Start variant of the event./docs?id=Lusk-ExprWorldBorderChangeSize WorldGuard Move Type

Expressionskript-worldguard

The movement type in a 'region enter/leave' event. This represents how the player ended up in/out of a region./docs?id=skript-worldguard-ExprMoveType Worlds

ExpressionSkript

All worlds of the server, useful for looping./docs?id=Skript-ExprWorlds Wrapped List

Represents a wrapped list./docs?id=SkCheese-wrappedlist WrappedList - New Wrapped List

ExpressionSkCheese

Converts a list variable to a wrapped list./docs?id=SkCheese-ExprWrappedList WrappedList - Unwrap List

Unwraps a wrapped list inside a list variable./docs?id=SkCheese-EffUnwrapWrappedList Wrapper Class

ExpressionTesttySK

Gets the wrapper class for a given name, useful for comparisons/docs?id=ClassySK-ExprClass WXYZ Component/Coordinate

ExpressionSkript

Gets or changes the W, X, Y or Z component of anything with these components/coordinates, like locations, vectors, or quaternions. The W axis is only used for quaternions, currently./docs?id=Skript-PropExprWXYZ X of Item/Entity Type

ExpressionSkript

An expression for using an item or entity type with a different amount./docs?id=Skript-ExprXOf X Times

ExpressionSkript

Integers between 1 and X, used in loops to loop X times./docs?id=Skript-ExprTimes YAML

Expressionskript-yaml

Gets, sets, removes values/nodes etc.. of a cached yaml file - Requires the id used/created from the load effect - This expression does not save to file - Lists accept list variables for input - Using 'without string checks' optional is a tiny bit faster but doesn't check/convert strings for numbers or booleans/docs?id=skript-yaml-ExprYaml YAML Comments/header

Expressionskript-yaml

Gets, sets, deletes comments or the header of a cached yaml file - Headers don't contain '#' so add it yourself if you want it - Comments can only be at root level ie. 'root' not 'root.something' - Both comment and header expressions can be set to multiple elements - This expression does not save to file - Option to have an extra line or not depending if you use comment or header - Any 'extra lines' are removed when deleting comments/headers/docs?id=skript-yaml-ExprYamlComments YAML list value

Expressionskript-yaml

Gets, sets, removes values from a list from a cached yaml file using an index - Requires index between 1 and the size of the list - Requires the id used/created from the load effect - This expression does not save to file - Using 'without string checks' optional is a tiny bit faster but doesn't check/convert strings for numbers or booleans/docs?id=skript-yaml-ExprListValue Yaml Loop

Expressionskript-yaml

The currently looped value of a yaml expression./docs?id=skript-yaml-ExprLoopYaml YAML Node Is Type

Conditionskript-yaml

Checks if a YAML node is a specific type (list, value, or node)./docs?id=skript-yaml-CondYamlNodeIsType Yaw / Pitch

ExpressionSkript

The yaw or pitch of a location or vector. A yaw of 0 or 360 represents the positive z direction. Adding a positive number to the yaw of a player will rotate it clockwise. A pitch of 90 represents the negative y direction, or downward facing. A pitch of -90 represents upward facing. Adding a positive number to the pitch will rotate the direction downwards. Only Paper 1.19+ users may directly change the yaw/pitch of players./docs?id=Skript-ExprYawPitch Zipped Lists

ExpressionskLambda

Walks two lists in lockstep, combining each pair of elements with a two-argument value lambda and returning a new list of the results. The lambda is invoked once per index with the matching elements as its two arguments. Iteration stops at the shorter list, and results whose lambda returns nothing are dropped./docs?id=skLambda-ExprZipped Zombie Nautilus Variant

Represents the variant of a zombie nautilus./docs?id=Skript-ZombieNautilusVariant Zombify Villager

Turn a villager into a zombie villager. Cure a zombie villager immediately or after specified amount of time. This effect removes the old entity and creates a new entity. Zombifying a villager stored in a variable will update the variable to the new zombie villager. Curing a zombie villager does not update the variable./docs?id=Skript-EffZombify