Update dev/feature branch nightly docs to SkriptLang/Skript@6ba6706

SkriptLang · Nov 23, 2024 · 0bf1f48 · 0bf1f48
1 parent ad36b7b
commit 0bf1f48
Show file tree

Hide file tree

Showing 13 changed files with 135 additions and 73 deletions.
diff --git a/docs/nightly/dev/feature/classes.html b/docs/nightly/dev/feature/classes.html
diff --git a/docs/nightly/dev/feature/conditions.html b/docs/nightly/dev/feature/conditions.html
diff --git a/docs/nightly/dev/feature/docs.html b/docs/nightly/dev/feature/docs.html
diff --git a/docs/nightly/dev/feature/docs.json b/docs/nightly/dev/feature/docs.json
@@ -1,5 +1,5 @@
 {
-  "skriptVersion": "2.9.4-nightly-1238f62",
+  "skriptVersion": "2.9.4-nightly-6ba6706",
   "conditions": [
     {
       "id": "CondAlphanumeric",
@@ -773,6 +773,25 @@
         "%displays%'[s] text (doesn't|does not|do not|don't) have [a] (drop|text) shadow"
       ]
     },
+    {
+      "id": "CondIsPressingKey",
+      "name": "Is Pressing Key",
+      "since": "INSERT VERSION",
+      "description": [
+        "Checks if a player is pressing a certain input key."
+      ],
+      "examples": [
+        "on player input:",
+        "\tif player is pressing forward movement key:",
+        "\t\tsend \"You are moving forward!\""
+      ],
+      "patterns": [
+        "%players% (is|are) pressing %inputkeys%",
+        "%players% (isn't|is not|aren't|are not) pressing %inputkeys%",
+        "%players% (was|were) pressing %inputkeys%",
+        "%players% (wasn't|was not|weren't|were not) pressing %inputkeys%"
+      ]
+    },
     {
       "id": "CondCanBuild",
       "name": "Can Build",
@@ -1932,22 +1951,6 @@
         "%locations% (isn't|is not|aren't|are not) within %number% (block|metre|meter)[s] (around|of) %locations%"
       ]
     },
-    {
-      "id": "CondTextDisplaySeeThroughBlocks",
-      "name": "Text Display Visible Through Blocks",
-      "since": "INSERT VERSION",
-      "description": [
-        "Returns whether text displays can be seen through blocks or not."
-      ],
-      "examples": [
-        "if last spawned text display is visible through walls:",
-        "\tprevent last spawned text display from being visible through walls"
-      ],
-      "patterns": [
-        "%displays% (is|are) visible through (blocks|walls)",
-        "%displays% (isn't|is not|aren't|are not) visible through (blocks|walls)"
-      ]
-    },
     {
       "id": "CondCanAge",
       "name": "Can Age",
@@ -2033,6 +2036,22 @@
         "%livingentities% (isn't|is not|aren't|are not) in lov(e|ing) [state|mode]"
       ]
     },
+    {
+      "id": "CondTextDisplaySeeThroughBlocks",
+      "name": "Text Display Visible Through Blocks",
+      "since": "INSERT VERSION",
+      "description": [
+        "Returns whether text displays can be seen through blocks or not."
+      ],
+      "examples": [
+        "if last spawned text display is visible through walls:",
+        "\tprevent last spawned text display from being visible through walls"
+      ],
+      "patterns": [
+        "%displays% (is|are) visible through (blocks|walls)",
+        "%displays% (isn't|is not|aren't|are not) visible through (blocks|walls)"
+      ]
+    },
     {
       "id": "CondCompare",
       "name": "Comparison",
@@ -3783,42 +3802,6 @@
         "rotate %quaternions/displays% by x %number%, y %number%(, [and]| and) z %number%"
       ]
     },
-    {
-      "id": "EffTextDisplayDropShadow",
-      "name": "Text Display Drop Shadow",
-      "since": "INSERT VERSION",
-      "description": [
-        "Applies or removes drop shadow from the displayed text on a text display."
-      ],
-      "examples": [
-        "apply drop shadow to last spawned text display",
-        "if {_display} has drop shadow:",
-        "\tremove drop shadow from the text of {_display}"
-      ],
-      "patterns": [
-        "(apply|add) (drop|text) shadow to [[the] text of] %displays%",
-        "(apply|add) (drop|text) shadow to %displays%'[s] text",
-        "(remove|clear) (drop|text) shadow from [[the] text of] %displays%",
-        "(remove|clear) (drop|text) shadow from %displays%'[s] text"
-      ]
-    },
-    {
-      "id": "EffTextDisplaySeeThroughBlocks",
-      "name": "Text Display See Through Blocks",
-      "since": "INSERT VERSION",
-      "description": [
-        "Forces a text display to either be or not be visible through blocks."
-      ],
-      "examples": [
-        "force last spawned text display to be visible through walls",
-        "prevent all text displays from being visible through walls"
-      ],
-      "patterns": [
-        "make %displays% visible through (blocks|walls)",
-        "force %displays% to be visible through (blocks|walls)",
-        "(prevent|block) %displays% from being (visible|seen) through (blocks|walls)"
-      ]
-    },
     {
       "id": "EffAllowAging",
       "name": "Allow Aging",
@@ -3873,6 +3856,42 @@
         "make %livingentities% [a[n]] (adult|:baby)",
         "force %livingentities% to be[come] a[n] (adult|:baby)"
       ]
+    },
+    {
+      "id": "EffTextDisplayDropShadow",
+      "name": "Text Display Drop Shadow",
+      "since": "INSERT VERSION",
+      "description": [
+        "Applies or removes drop shadow from the displayed text on a text display."
+      ],
+      "examples": [
+        "apply drop shadow to last spawned text display",
+        "if {_display} has drop shadow:",
+        "\tremove drop shadow from the text of {_display}"
+      ],
+      "patterns": [
+        "(apply|add) (drop|text) shadow to [[the] text of] %displays%",
+        "(apply|add) (drop|text) shadow to %displays%'[s] text",
+        "(remove|clear) (drop|text) shadow from [[the] text of] %displays%",
+        "(remove|clear) (drop|text) shadow from %displays%'[s] text"
+      ]
+    },
+    {
+      "id": "EffTextDisplaySeeThroughBlocks",
+      "name": "Text Display See Through Blocks",
+      "since": "INSERT VERSION",
+      "description": [
+        "Forces a text display to either be or not be visible through blocks."
+      ],
+      "examples": [
+        "force last spawned text display to be visible through walls",
+        "prevent all text displays from being visible through walls"
+      ],
+      "patterns": [
+        "make %displays% visible through (blocks|walls)",
+        "force %displays% to be visible through (blocks|walls)",
+        "(prevent|block) %displays% from being (visible|seen) through (blocks|walls)"
+      ]
     }
   ],
   "expressions": [
@@ -9702,6 +9721,23 @@
         "%displays%'[s] text[s]"
       ]
     },
+    {
+      "id": "ExprLoveTime",
+      "name": "Love Time",
+      "since": "INSERT VERSION",
+      "description": [
+        "The amount of time the animals have been in love for. Using a value of 30 seconds is equivalent to using an item to breed them.",
+        "Only works on animals that can be bred and returns '0 seconds' for animals that can't be bred."
+      ],
+      "examples": [
+        "on right click:",
+        "\tsend \"%event-entity% has been in love for %love time of event-entity% more than you!\" to player"
+      ],
+      "patterns": [
+        "[the] love[d] time of %livingentities%",
+        "%livingentities%'[s] love[d] time"
+      ]
+    },
     {
       "id": "ExprDisplayBillboard",
       "name": "Display Billboard",
@@ -9938,20 +9974,18 @@
       ]
     },
     {
-      "id": "ExprLoveTime",
-      "name": "Love Time",
+      "id": "ExprCurrentInputKeys",
+      "name": "Player Input Keys",
       "since": "INSERT VERSION",
       "description": [
-        "The amount of time the animals have been in love for. Using a value of 30 seconds is equivalent to using an item to breed them.",
-        "Only works on animals that can be bred and returns '0 seconds' for animals that can't be bred."
+        "Get the current input keys of a player."
       ],
       "examples": [
-        "on right click:",
-        "\tsend \"%event-entity% has been in love for %love time of event-entity% more than you!\" to player"
+        "broadcast \"%player% is pressing %current input keys of player%\""
       ],
       "patterns": [
-        "[the] love[d] time of %livingentities%",
-        "%livingentities%'[s] love[d] time"
+        "[the] [current] (inputs|input keys) of %players%",
+        "%players%'[s] [current] (inputs|input keys)"
       ]
     },
     {
@@ -12713,6 +12747,23 @@
         "[entity] love mode [enter]"
       ]
     },
+    {
+      "id": "player_input",
+      "name": "On Player Input",
+      "since": "INSERT VERSION",
+      "description": [
+        "Called when a player sends an updated input to the server.",
+        "Note: The input keys event value is the set of keys the player is currently pressing, not the keys that were pressed or released."
+      ],
+      "examples": [
+        "on any input key press:",
+        "\tsend \"You are pressing: %event-inputkeys%\" to player"
+      ],
+      "patterns": [
+        "[player] (toggle|toggling|1:press[ing]|2:release|2:releasing) of (%-inputkeys%|(an|any) input key)",
+        "([player] %-inputkeys%|[an|any [player]] input key) (toggle|toggling|1:press[ing]|2:release|2:releasing)"
+      ]
+    },
     {
       "id": "region_enterleave",
       "name": "On Region Enter/Leave",
@@ -13478,6 +13529,17 @@
         "first person left handed, left handed in first person, right handed in third person, first person left hand, no transform, the ground, third person right hand, third person right handed, right handed in first person, menu, head, third person left hand, first person right handed, first person right hand, fixed position, left handed in third person, gui, ground, fixed, third person left handed"
       ]
     },
+    {
+      "id": "inputkey",
+      "name": "Input Key",
+      "since": "INSERT VERSION",
+      "description": [
+        "Represents a movement input key that is pressed by a player."
+      ],
+      "patterns": [
+        "left movement key, forward movement key, right movement key, backward key, left key, sprint key, forward key, right key, jumping key, sneaking key, jump key, sneak key, sprinting key, backward movement key"
+      ]
+    },
     {
       "id": "money",
       "name": "Money",

diff --git a/docs/nightly/dev/feature/effects.html b/docs/nightly/dev/feature/effects.html
diff --git a/docs/nightly/dev/feature/events.html b/docs/nightly/dev/feature/events.html
diff --git a/docs/nightly/dev/feature/expressions.html b/docs/nightly/dev/feature/expressions.html
diff --git a/docs/nightly/dev/feature/functions.html b/docs/nightly/dev/feature/functions.html
diff --git a/docs/nightly/dev/feature/index.html b/docs/nightly/dev/feature/index.html
@@ -1,4 +1,4 @@
-<!doctype html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=0.8, maximum-scale=1.0"> <meta name="description" content="Skript is a Bukkit plugin which allows server admins to customize their server easily, but without the hassle of programming a plugin or asking/paying someone to program a plugin for them. - SkriptLang/Skript"> <link rel="icon" type="image/png" href="./assets/icon.png"> <meta property="og:type" content="website"> <meta property="og:title" content="Skript Documentation"> <meta property="og:site_name" content="Skript Documentation"> <meta property="og:description" content="Skript is a Bukkit plugin which allows server admins to customize their server easily, but without the hassle of programming a plugin or asking/paying someone to program a plugin for them."> <meta property="og:image" content="https://docs.skriptlang.org/assets/icon.png"> <meta property="og:url" content="https://docs.skriptlang.org/"> <meta name="theme-color" content="#ff9800"> <title>Skript Documentation - 2.9.4-nightly-1238f62</title> <link href="css/styles.css" rel="stylesheet"> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js" defer></script> <script src="./js/functions.js"></script> <script src="./js/main.js" defer></script> <link rel="preconnect" href="https://fonts.gstatic.com"> <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:ital,wght@0,200;0,300;0,400;0,500;0,600;0,700;0,900;1,200;1,300;1,400;1,500;1,600;1,700;1,900&display=swap" rel="stylesheet"> <link rel="preconnect" href="https://fonts.gstatic.com"> <link href="https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap" rel="stylesheet"> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.4/css/all.css" integrity="sha384-DyZ88mC6Up2uqS4h/KRgHuoeGwBcD4Ng9SiP4dIRy0EXTlnuz47vAwmeGwVChigm" crossorigin="anonymous"> </head> <body> <div id="docs-body"> <!-- loaded inside body without defer to fix theme flicker --> <script src="./js/theme-switcher.js"></script> <ul id="global-navigation"> <li><a href="index.html">Home</a></li> <div class="menu-tab"> <li><a class="menu-tab-item" href="docs.html">Docs <i class="fas fa-caret-down"></i></a></li> <div class="menu-subtabs"> <a href="events.html">Events</a> <a href="conditions.html">Conditions</a> <a href="sections.html">Sections</a> <a href="effects.html">Effects</a> <a href="expressions.html">Expressions</a> <a href="classes.html">Types</a> <a href="structures.html">Structures</a> <a href="functions.html">Functions</a> </div> </div> <li><a href="docs.html?isNew" class="new-tab">New</a></li> <div class="menu-tab"> <li><a class="menu-tab-item" href="tutorials.html">Tutorials <i class="fas fa-caret-down"></i></a></li> <div class="menu-subtabs"> <a href="text.html">Text</a> </div> </div> <div class="menu-tab"> <li><a class="menu-tab-item" href="#">Dev Tools <i class="fas fa-caret-down"></i></a></li> <div class="menu-subtabs"> <a href="javadocs/" target="_blank">Javadocs</a> </div> </div> <li><a href="https://github.com/SkriptLang/Skript/" target="_blank" style="font-weight: bold;">GitHub</a></li> <li style="margin-left: auto;"><a style="font-weight: bold; color: #ff9800" href="https://github.com/SkriptLang/Skript/releases/tag/2.9.4-nightly-1238f62" target="_blank">v2.9.4-nightly-1238f62</a></li> </ul> <nav id="side-nav"> <div id="nav-contents"> </div> </nav> <h1 id="nav-title">Documentation</h1> <div id="content-no-docs" class="no-left-panel" style="display: inline-block;"> <div style="height: 32px;"></div> <!-- Space --> <p> <span style="font-size: 60px; font-weight: bold;">Skript</span> is (surprise, surprise) a scripting plugin for the Bukkit platform. It is easy to use for simple tasks, but you can also create really complex things with it. The syntax of Skript is close to English, but it is still not magic. While you might succeed with experimentation for simple tasks, for anything more complex you will need some guidance. </p> <p> This is Skript's documentation. You will find all supported features of the plugin here, along with some useful examples. We don't have tutorials yet, but you can find good ones using whatever search engine you prefer. </p> <p class="box-title">Quick Look</p> <pre class="box code" style="height: 460px; overflow: auto;"><code class="bash"> command /sethome:
+<!doctype html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=0.8, maximum-scale=1.0"> <meta name="description" content="Skript is a Bukkit plugin which allows server admins to customize their server easily, but without the hassle of programming a plugin or asking/paying someone to program a plugin for them. - SkriptLang/Skript"> <link rel="icon" type="image/png" href="./assets/icon.png"> <meta property="og:type" content="website"> <meta property="og:title" content="Skript Documentation"> <meta property="og:site_name" content="Skript Documentation"> <meta property="og:description" content="Skript is a Bukkit plugin which allows server admins to customize their server easily, but without the hassle of programming a plugin or asking/paying someone to program a plugin for them."> <meta property="og:image" content="https://docs.skriptlang.org/assets/icon.png"> <meta property="og:url" content="https://docs.skriptlang.org/"> <meta name="theme-color" content="#ff9800"> <title>Skript Documentation - 2.9.4-nightly-6ba6706</title> <link href="css/styles.css" rel="stylesheet"> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js" defer></script> <script src="./js/functions.js"></script> <script src="./js/main.js" defer></script> <link rel="preconnect" href="https://fonts.gstatic.com"> <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:ital,wght@0,200;0,300;0,400;0,500;0,600;0,700;0,900;1,200;1,300;1,400;1,500;1,600;1,700;1,900&display=swap" rel="stylesheet"> <link rel="preconnect" href="https://fonts.gstatic.com"> <link href="https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap" rel="stylesheet"> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.4/css/all.css" integrity="sha384-DyZ88mC6Up2uqS4h/KRgHuoeGwBcD4Ng9SiP4dIRy0EXTlnuz47vAwmeGwVChigm" crossorigin="anonymous"> </head> <body> <div id="docs-body"> <!-- loaded inside body without defer to fix theme flicker --> <script src="./js/theme-switcher.js"></script> <ul id="global-navigation"> <li><a href="index.html">Home</a></li> <div class="menu-tab"> <li><a class="menu-tab-item" href="docs.html">Docs <i class="fas fa-caret-down"></i></a></li> <div class="menu-subtabs"> <a href="events.html">Events</a> <a href="conditions.html">Conditions</a> <a href="sections.html">Sections</a> <a href="effects.html">Effects</a> <a href="expressions.html">Expressions</a> <a href="classes.html">Types</a> <a href="structures.html">Structures</a> <a href="functions.html">Functions</a> </div> </div> <li><a href="docs.html?isNew" class="new-tab">New</a></li> <div class="menu-tab"> <li><a class="menu-tab-item" href="tutorials.html">Tutorials <i class="fas fa-caret-down"></i></a></li> <div class="menu-subtabs"> <a href="text.html">Text</a> </div> </div> <div class="menu-tab"> <li><a class="menu-tab-item" href="#">Dev Tools <i class="fas fa-caret-down"></i></a></li> <div class="menu-subtabs"> <a href="javadocs/" target="_blank">Javadocs</a> </div> </div> <li><a href="https://github.com/SkriptLang/Skript/" target="_blank" style="font-weight: bold;">GitHub</a></li> <li style="margin-left: auto;"><a style="font-weight: bold; color: #ff9800" href="https://github.com/SkriptLang/Skript/releases/tag/2.9.4-nightly-6ba6706" target="_blank">v2.9.4-nightly-6ba6706</a></li> </ul> <nav id="side-nav"> <div id="nav-contents"> </div> </nav> <h1 id="nav-title">Documentation</h1> <div id="content-no-docs" class="no-left-panel" style="display: inline-block;"> <div style="height: 32px;"></div> <!-- Space --> <p> <span style="font-size: 60px; font-weight: bold;">Skript</span> is (surprise, surprise) a scripting plugin for the Bukkit platform. It is easy to use for simple tasks, but you can also create really complex things with it. The syntax of Skript is close to English, but it is still not magic. While you might succeed with experimentation for simple tasks, for anything more complex you will need some guidance. </p> <p> This is Skript's documentation. You will find all supported features of the plugin here, along with some useful examples. We don't have tutorials yet, but you can find good ones using whatever search engine you prefer. </p> <p class="box-title">Quick Look</p> <pre class="box code" style="height: 460px; overflow: auto;"><code class="bash"> command /sethome:
  &nbsp;&nbsp;&nbsp;&nbsp;permission: skript.home # Permission required for this command
  &nbsp;&nbsp;&nbsp;&nbsp;description: Set your home # Description of this command
  &nbsp;&nbsp;&nbsp;&nbsp;executable by: players # Console won't be able to run this command