Skip to content

Commit 1e6b1da

Browse files
committed
Skript - update docs
1 parent b1e9dec commit 1e6b1da

File tree

513 files changed

+3521
-1526
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

513 files changed

+3521
-1526
lines changed

docs/Skript/latest/classes.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/Skript/latest/conditions.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/Skript/latest/docs.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/Skript/latest/docs.json

Lines changed: 72 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{
2-
"skriptVersion" : "3.0.0-Beta1",
2+
"skriptVersion" : "3.0.0-Beta2",
33

44
"classes" : [
55
{
6-
"id" : "attributetype",
7-
"name" : "Attribute Type",
6+
"id" : "attribute",
7+
"name" : "Attribute",
88
"patterns" : [
99
"armor, armor toughness, attack damage, attack knockback, attack speed, block break speed, block interaction range, burning time, entity interaction range, explosion knockback resistance, fall damage multiplier, flying speed, follow range, gravity, jump strength, knockback resistance, luck, max absorption, max health, mining efficiency, movement efficiency, movement speed, oxygen bonus, safe fall distance, scale, sneaking speed, spawn reinforcements, step height, submerged mining speed, sweeping damage ratio, tempt range, water movement efficiency",
1010

1111
"pattern_end"
1212
],
1313
"since" : "2.5",
14-
"description" : "Represents the type of an attribute. Note that this type does not contain any numerical values.See <a href='https://minecraft.wiki/w/Attribute#Attributes'>attribute types</a> for more info.\\nNOTE: Minecraft namespaces are supported, ex: 'minecraft:generic.attack_damage'.",
14+
"description" : "Represents an attribute.\\nNote that this type does not contain any numerical values.\\nSee <a href='https://minecraft.wiki/w/Attribute#Attributes'>attributes</a> for more info.\\nThese are auto-generated and may differ between MC versions.\\nNOTE: Minecraft namespaces and underscores are supported, ex: 'minecraft:attack_damage'.",
1515
"examples" : "Missing examples."
1616
},
1717
{
@@ -211,7 +211,7 @@
211211
"id" : "entitycategory",
212212
"name" : "Entity Category",
213213
"patterns" : [
214-
"abstract arrow, ageable, ambient, animal, boat, boss, breedable, bucketable, chest boat, creature, damageable, display, enemy, entity, explosive, fish, flying, golem, hanging, illager, minecart, mob, monster, projectile, raider, schoolable fish, shearable, spellcaster, tameable, throwable projectile, vehicle, water mob",
214+
"abstract arrow, ageable, ambient, animal, boat, boss, bucketable, breedable, chest boat, creature, damageable, display, enemy, entity, explosive, fish, flying, golem, hanging, illager, minecart, mob, monster, projectile, raider, schoolable fish, shearable, spellcaster, tameable, throwable projectile, vehicle, water mob",
215215

216216
"pattern_end"
217217
],
@@ -1491,6 +1491,26 @@ The 'additional tooltip' hides certain information from certain items (potions,
14911491
Hands are raised when an entity is using an item (eg: blocking, drawing a bow, eating).",
14921492
"examples" : "on damage of player:\\n if victim's main hand is raised:\\n drop player's tool at player\\n set player's tool to air"
14931493
},
1494+
{
1495+
"id" : "CondItemInHand",
1496+
"name" : "Is Holding",
1497+
"patterns" : [
1498+
"[%<a href='./classes.html#livingentity'>living entities</a>%] ha(s|ve) %<a href='./classes.html#material'>materials</a>/<a href='./classes.html#itemstack'>item stacks</a>% in [main] hand",
1499+
"[%<a href='./classes.html#livingentity'>living entities</a>%] (is|are) holding %<a href='./classes.html#material'>materials</a>/<a href='./classes.html#itemstack'>item stacks</a>% [in main hand]",
1500+
"[%<a href='./classes.html#livingentity'>living entities</a>%] ha(s|ve) %<a href='./classes.html#material'>materials</a>/<a href='./classes.html#itemstack'>item stacks</a>% in off[(-| )]hand",
1501+
"[%<a href='./classes.html#livingentity'>living entities</a>%] (is|are) holding %<a href='./classes.html#material'>materials</a>/<a href='./classes.html#itemstack'>item stacks</a>% in off[(-| )]hand",
1502+
"[%<a href='./classes.html#livingentity'>living entities</a>%] (ha(s|ve) not|do[es]n't have) %<a href='./classes.html#material'>materials</a>/<a href='./classes.html#itemstack'>item stacks</a>% in [main] hand",
1503+
"[%<a href='./classes.html#livingentity'>living entities</a>%] (is not|isn't) holding %<a href='./classes.html#material'>materials</a>/<a href='./classes.html#itemstack'>item stacks</a>% [in main hand]",
1504+
"[%<a href='./classes.html#livingentity'>living entities</a>%] (ha(s|ve) not|do[es]n't have) %<a href='./classes.html#material'>materials</a>/<a href='./classes.html#itemstack'>item stacks</a>% in off[(-| )]hand",
1505+
"[%<a href='./classes.html#livingentity'>living entities</a>%] (is not|isn't) holding %<a href='./classes.html#material'>materials</a>/<a href='./classes.html#itemstack'>item stacks</a>% in off[(-| )]hand",
1506+
1507+
"pattern_end"
1508+
],
1509+
"since" : "1.0",
1510+
"description" : "Checks whether a player is holding a specific Material/ItemStack.
1511+
Cannot be used with endermen, use 'entity is [not] an enderman holding &lt;item type&gt;' instead.",
1512+
"examples" : "player is holding a stick\\nvictim isn't holding a sword of sharpness"
1513+
},
14941514
{
14951515
"id" : "CondIncendiary",
14961516
"name" : "Is Incendiary",
@@ -2440,7 +2460,7 @@ If the command is a bungeecord side command, you can use the [bungeecord] option
24402460
"id" : "EffEnchant",
24412461
"name" : "Enchant/Disenchant",
24422462
"patterns" : [
2443-
"enchant %~<a href='./classes.html#itemstack'>item stacks</a>% with %<a href='./classes.html#enchantment'>enchantment</a>% %<a href='./classes.html#number'>number</a>%",
2463+
"enchant %~<a href='./classes.html#itemstack'>item stacks</a>% with %<a href='./classes.html#enchantment'>enchantment</a>% [%<a href='./classes.html#number'>number</a>%]",
24442464
"disenchant %~<a href='./classes.html#itemstack'>item stacks</a>%",
24452465

24462466
"pattern_end"
@@ -6213,6 +6233,19 @@ Supported types include <a href='./classes.html#number'>numbers</a>, <a href='./
62136233
"description" : "The distance between two points.",
62146234
"examples" : "if the distance between the player and {home::%uuid of player%} is smaller than 20:\\n message \"You're very close to your home!\""
62156235
},
6236+
{
6237+
"id" : "ExprDrops",
6238+
"name" : "Drops",
6239+
"patterns" : [
6240+
"[the] drops",
6241+
6242+
"pattern_end"
6243+
],
6244+
"since" : "1.0",
6245+
"description" : "Only works in death events.
6246+
Holds the drops of the dying creature. Drops can be prevented by removing them with \"remove ... from drops\" or \"clear drops\" if you don't want any drops at all.",
6247+
"examples" : "clear drops\\nremove itemstack of 4 of oak planks from the drops"
6248+
},
62166249
{
62176250
"id" : "ExprDropsOfBlock",
62186251
"name" : "Drops Of Block",
@@ -6344,10 +6377,8 @@ To change the number of levels removed, use the enchant event.",
63446377
"id" : "ExprEntities",
63456378
"name" : "Entities",
63466379
"patterns" : [
6347-
"[(all [[of] the]|the)] entities [(in|of) ([world[s]] %<a href='./classes.html#world'>worlds</a>%|%<a href='./classes.html#chunk'>chunks</a>%)]",
6348-
"[(all [[of] the]|the)] entities of type[s] %*-entitytypes/<a href='./classes.html#entitycategory'>entity categories</a>% [(in|of) ([world[s]] %<a href='./classes.html#world'>worlds</a>%|%<a href='./classes.html#chunk'>chunks</a>%)]",
6349-
"[(all [[of] the]|the)] entities (within|[with]in radius) %<a href='./classes.html#number'>number</a>% [(block[s]|met(er|re)[s])] (of|around) %<a href='./classes.html#location'>location</a>%",
6350-
"[(all [[of] the]|the)] entities of type[s] %<a href='./classes.html#entitytype'>entity types</a>/<a href='./classes.html#entitycategory'>entity categories</a>% in radius %<a href='./classes.html#number'>number</a>% (of|around) %<a href='./classes.html#location'>location</a>%",
6380+
"all [[of] the] [entities of type[s]] %*-entitytypes/<a href='./classes.html#entitycategory'>entity categories</a>% [(in|of) ([world[s]] %<a href='./classes.html#world'>worlds</a>%|%<a href='./classes.html#chunk'>chunks</a>%)]",
6381+
"all [[of] the] [entities of type[s]] %<a href='./classes.html#entitytype'>entity types</a>/<a href='./classes.html#entitycategory'>entity categories</a>% in radius %<a href='./classes.html#number'>number</a>% (of|around) %<a href='./classes.html#location'>location</a>%",
63516382

63526383
"pattern_end"
63536384
],
@@ -6372,8 +6403,8 @@ To change the number of levels removed, use the enchant event.",
63726403
"id" : "ExprEntityAttribute",
63736404
"name" : "Entity Attribute",
63746405
"patterns" : [
6375-
"[the] %<a href='./classes.html#attributetype'>attribute type</a>% [((total|final|modified))] attribute [value] of %<a href='./classes.html#entity'>entities</a>%",
6376-
"%<a href='./classes.html#entity'>entities</a>%'[s] %<a href='./classes.html#attributetype'>attribute type</a>% [((total|final|modified))] attribute [value]",
6406+
"[the] %<a href='./classes.html#attribute'>attribute</a>% [((total|final|modified))] attribute [value] of %<a href='./classes.html#entity'>entities</a>%",
6407+
"%<a href='./classes.html#entity'>entities</a>%'[s] %<a href='./classes.html#attribute'>attribute</a>% [((total|final|modified))] attribute [value]",
63776408

63786409
"pattern_end"
63796410
],
@@ -7092,6 +7123,18 @@ NOTE: 'Viewers' expression returns a list of players viewing the inventory. Note
70927123
"description" : "Represents a slot in an inventory. It can be used to change the item in an inventory too.",
70937124
"examples" : "if slot 1 of player is set:\\n set slot 0 of player to itemstack of 2 of stone\\n clear slot 1 of player"
70947125
},
7126+
{
7127+
"id" : "ExprItem",
7128+
"name" : "Item",
7129+
"patterns" : [
7130+
"[the] item[stack]",
7131+
7132+
"pattern_end"
7133+
],
7134+
"since" : "<i>unknown</i> (before 2.1)",
7135+
"description" : "The item involved in an event, e.g. in a drop, dispense, pickup or craft event.",
7136+
"examples" : "on dispense:\\n item is a clock\\n set the time to 6:00"
7137+
},
70957138
{
70967139
"id" : "ExprItemAmount",
70977140
"name" : "Item Amount",
@@ -7162,6 +7205,18 @@ Deleting the item of an ItemFrame will just remove the ItemStack from the frame
71627205
"description" : "Get an item with a CustomModelData tag. (Value is an integer between 0 and 99999999)",
71637206
"examples" : "give player a diamond sword with custom model data 2\\nset slot 1 of inventory of player to wooden hoe with custom model data 357"
71647207
},
7208+
{
7209+
"id" : "ExprItemStackWithEnchantment",
7210+
"name" : "Item with Enchantment",
7211+
"patterns" : [
7212+
"%<a href='./classes.html#itemstack'>item stack</a>% (enchanted with|with enchantment) %<a href='./classes.html#enchantment'>enchantment</a>%[ %<a href='./classes.html#number'>number</a>%]",
7213+
7214+
"pattern_end"
7215+
],
7216+
"since" : "3.0.0",
7217+
"description" : "Add an enchantment to an ItemStack.",
7218+
"examples" : "set {_i} to itemstack of diamond sword enchanted with unbreaking 3"
7219+
},
71657220
{
71667221
"id" : "ExprItemWithLore",
71677222
"name" : "Item with Lore",
@@ -7176,16 +7231,17 @@ If multiple strings are passed, each of them will be a separate line in the lore
71767231
"examples" : "set {_test} to stone with lore \"line 1\" and \"line 2\"\\ngive {_test} to player"
71777232
},
71787233
{
7179-
"id" : "ExprItemStackCreate",
7234+
"id" : "ExprSecItemStackCreate",
71807235
"name" : "ItemStack Create",
71817236
"patterns" : [
71827237
"[new] item[ ]stack[s] (of|from) [%<a href='./classes.html#number'>number</a>% [of]] %<a href='./classes.html#material'>materials</a>%",
71837238

71847239
"pattern_end"
71857240
],
71867241
"since" : "3.0.0",
7187-
"description" : "Create a new item stack.",
7188-
"examples" : "set {_i} to itemstack of 10 of diamond\\nset {_i} to itemstack of netherite shovel"
7242+
"description" : "Create a new item stack.
7243+
This can be used as an expression as well as a section.",
7244+
"examples" : "set {_i} to itemstack of 10 of diamond\\nset {_i} to itemstack of netherite shovel\\n\\n# Section\\nset {_i} to itemstack of diamond sword\\n set name of item to \"My Sword\"\\n set custom model data of item to 1010\\ngive {_i} to player"
71897245
},
71907246
{
71917247
"id" : "ExprItemsIn",
@@ -8623,7 +8679,7 @@ or can be reset to the default icon in a <a href='events.html#server_list_ping'>
86238679
],
86248680
"since" : "1.0 pre-5, 2.7 (classinfo)",
86258681
"description" : "Returns a list of all the values of a type. Useful for looping.",
8626-
"examples" : "loop all attribute types:\\n set loop-value attribute of player to 10\\n message \"Set attribute %loop-value% to 10!\""
8682+
"examples" : "loop all attributes:\\n set loop-value attribute of player to 10\\n message \"Set attribute %loop-value% to 10!\""
86278683
},
86288684
{
86298685
"id" : "ExprShooter",

docs/Skript/latest/effects.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/Skript/latest/events.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/Skript/latest/expressions.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/Skript/latest/functions.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)