Skip to content

Commit

Permalink
Update dev/feature branch nightly docs to SkriptLang/Skript@90d211a
Browse files Browse the repository at this point in the history
  • Loading branch information
Nightly Docs Bot committed Nov 17, 2023
1 parent 442977a commit 2f3e236
Show file tree
Hide file tree
Showing 13 changed files with 33 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/nightly/dev/feature/classes.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/dev/feature/conditions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/dev/feature/docs.html

Large diffs are not rendered by default.

28 changes: 20 additions & 8 deletions docs/nightly/dev/feature/docs.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"skriptVersion" : "2.8.0-dev-nightly-5189e34",
"skriptVersion" : "2.8.0-dev-nightly-90d211a",

"classes" : [
{
Expand Down Expand Up @@ -108,7 +108,7 @@
],
"since" : "Unknown",
"description" : "Wool, dye and chat colors.",
"examples" : "color of the sheep is red or black\\nset the color of the block to green\\nmessage \"You're holding a <%color of tool%>%color of tool%<reset> wool block\""
"examples" : "color of the sheep is red or black\\nset the color of the block to green\\nmessage \"You're holding a <%color of tool%>%color of tool%<reset> wool block\""
},
{
"id" : "commandsender",
Expand All @@ -121,7 +121,7 @@
],
"since" : "1.0",
"description" : "A player or the console.",
"examples" : "command /push [<player>]:\\n trigger:\\n if arg-1 is not set:\\n if command sender is console:\\n send \"You can't push yourself as a console :\\\" to sender\\n stop\\n push sender upwards with force 2\\n send \"Yay!\"\\n else:\\n push arg-1 upwards with force 2\\n send \"Yay!\" to sender and arg-1"
"examples" : "command /push [<player>]:\\n trigger:\\n if arg-1 is not set:\\n if command sender is console:\\n send \"You can't push yourself as a console :\\\" to sender\\n stop\\n push sender upwards with force 2\\n send \"Yay!\"\\n else:\\n push arg-1 upwards with force 2\\n send \"Yay!\" to sender and arg-1"
},
{
"id" : "damagecause",
Expand Down Expand Up @@ -3436,7 +3436,7 @@ Do note that other event values, such as 'player', won't work in this section.",
],
"since" : "1.4.1",
"description" : "Called whenever a player chats.\\nUse <a href='./expressions.html#ExprChatFormat'>chat format</a> to change message format.\\nUse <a href='./expressions.html#ExprChatRecipients'>chat recipients</a> to edit chat recipients.",
"examples" : "on chat:\\n if player has permission \"owner\":\\n set chat format to \"&amp;amp;amp;amp;amp;lt;red&amp;amp;amp;amp;amp;gt;[player]&amp;amp;amp;amp;amp;lt;light gray&amp;amp;amp;amp;amp;gt;: &amp;amp;amp;amp;amp;lt;light red&amp;amp;amp;amp;amp;gt;[message]\"\\n else if player has permission \"admin\":\\n set chat format to \"&amp;amp;amp;amp;amp;lt;light red&amp;amp;amp;amp;amp;gt;[player]&amp;amp;amp;amp;amp;lt;light gray&amp;amp;amp;amp;amp;gt;: &amp;amp;amp;amp;amp;lt;orange&amp;amp;amp;amp;amp;gt;[message]\"\\n else: #default message format\\n set chat format to \"&amp;amp;amp;amp;amp;lt;orange&amp;amp;amp;amp;amp;gt;[player]&amp;amp;amp;amp;amp;lt;light gray&amp;amp;amp;amp;amp;gt;: &amp;amp;amp;amp;amp;lt;white&amp;amp;amp;amp;amp;gt;[message]\""
"examples" : "on chat:\\n if player has permission \"owner\":\\n set chat format to \"&amp;lt;red&amp;gt;[player]&amp;lt;light gray&amp;gt;: &amp;lt;light red&amp;gt;[message]\"\\n else if player has permission \"admin\":\\n set chat format to \"&amp;lt;light red&amp;gt;[player]&amp;lt;light gray&amp;gt;: &amp;lt;orange&amp;gt;[message]\"\\n else: #default message format\\n set chat format to \"&amp;lt;orange&amp;gt;[player]&amp;lt;light gray&amp;gt;: &amp;lt;white&amp;gt;[message]\""
},
{
"id" : "chunk_generate",
Expand Down Expand Up @@ -4321,7 +4321,7 @@ Do note that other event values, such as 'player', won't work in this section.",
],
"since" : "2.7",
"description" : "Called when a player enters a chunk. Note that this event is based on 'player move' event, and may be called frequent internally.",
"examples" : "on player enters a chunk:\\n send \"You entered a chunk: %past event-chunk% -&amp;amp;amp;amp;gt; %event-chunk%!\" to player"
"examples" : "on player enters a chunk:\\n send \"You entered a chunk: %past event-chunk% -&gt; %event-chunk%!\" to player"
},
{
"id" : "player_deep_sleep",
Expand Down Expand Up @@ -4616,7 +4616,7 @@ Do note that other event values, such as 'player', won't work in this section.",
],
"since" : "1.0",
"description" : "As signs are placed empty, this event is called when a player is done editing a sign.",
"examples" : "on sign change:\\n line 2 is empty\\n set line 1 to \"&amp;amp;amp;amp;amp;lt;red&amp;amp;amp;amp;amp;gt;%line 1%\""
"examples" : "on sign change:\\n line 2 is empty\\n set line 1 to \"&amp;lt;red&amp;gt;%line 1%\""
},
{
"id" : "slime_split",
Expand Down Expand Up @@ -8360,7 +8360,7 @@ if they're not, this expression will return nothing.",
],
"since" : "2.2-dev32d",
"description" : "Special number values, namely NaN, Infinity and -Infinity",
"examples" : "if {_number} is NaN value:"
"examples" : "if {_number} is infinity value:"
},
{
"id" : "ExprSpectatorTarget",
Expand Down Expand Up @@ -9266,6 +9266,18 @@ The return value in this case will be the view distance set in system.properties
"description" : "Rounds a number down, i.e. returns the closest integer smaller than or equal to the argument.",
"examples" : "floor(2.34) = 2\\nfloor(2) = 2\\nfloor(2.99) = 2"
},
{
"id" : "isNaN",
"name" : "isNaN",
"patterns" : [
"isNaN(n: number)",

"pattern_end"
],
"since" : "INSERT VERSION",
"description" : "Returns true if the input is NaN (not a number).",
"examples" : "isNaN(0) # false\\nisNaN(0/0) # true\\nisNaN(sqrt(-1)) # true"
},
{
"id" : "ln",
"name" : "ln",
Expand Down Expand Up @@ -9360,7 +9372,7 @@ The return value in this case will be the view distance set in system.properties
],
"since" : "INSERT VERSION",
"description" : "Returns an online player from their name or UUID, if player is offline function will return nothing.\\nSetting 'getExactPlayer' parameter to true will return the player whose name is exactly equal to the provided name instead of returning a player that their name starts with the provided name.",
"examples" : "set {_p} to player(\"Notch\") # will return an online player whose name is or starts with 'Notch'\\nset {_p} to player(\"Notch\", true) # will return the only online player whose name is 'Notch'\\nset {_p} to player(\"069a79f4-44e9-4726-a5be-fca90e38aaf5\") # &amp;amp;amp;amp;lt;none&amp;amp;amp;amp;gt; if player is offline"
"examples" : "set {_p} to player(\"Notch\") # will return an online player whose name is or starts with 'Notch'\\nset {_p} to player(\"Notch\", true) # will return the only online player whose name is 'Notch'\\nset {_p} to player(\"069a79f4-44e9-4726-a5be-fca90e38aaf5\") # &lt;none&gt; if player is offline"
},
{
"id" : "product",
Expand Down
2 changes: 1 addition & 1 deletion docs/nightly/dev/feature/effects.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/dev/feature/events.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/dev/feature/expressions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/dev/feature/functions.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/nightly/dev/feature/index.html
Original file line number Diff line number Diff line change
@@ -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.8.0-dev-nightly-5189e34</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.8.0-dev-nightly-5189e34" target="_blank">v2.8.0-dev-nightly-5189e34</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.8.0-dev-nightly-90d211a</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.8.0-dev-nightly-90d211a" target="_blank">v2.8.0-dev-nightly-90d211a</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
Expand All @@ -19,4 +19,4 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;# Teleport the player to their home
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;teleport player to {home::%uuid of player%}
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;send &quot;&amp;aYou have been teleported.&quot;
</code></pre> <div id="info" class="grid-container padding"> <div class="grid-item"> <p class="box-title">Latest Stable Version</p> <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/releases/tag/${stable-version}" target="_blank">Skript ${stable-version}</a></p> </div> <div class="grid-item"> <p class="box-title">Latest Version</p> <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/releases/tag/${latest-version}" target="_blank">Skript ${latest-version}</a></p> </div> <div class="grid-item"> <p class="box-title">Contributors</p> <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/graphs/contributors" target="_blank">${contributors-size} Contributors</a></p> </div> </div> <p class="box"> Found something incorrect in this documentation? Please report it to the <a href="https://github.com/SkriptLang/skript-docs/issues/">issue tracker</a>. </p> <p class="box"> <strong>We are looking for docs authors!</strong> Currently, the only documentation is generated automatically. It would be nice to have some hand-written content such as tutorials on the docs as well. For example, currently we don't have a tutorial on how to use loops here; This makes it harder for newcomers to learn. Check <a href="https://github.com/SkriptLang/skript-docs/issues/12">this issue</a> for more details and if you're interested in helping out. </p> <div style="padding-top: 64px;"></div> <!-- Space --> <p style="font-size: 14px; text-align: center;" class="placeholder"><a href="https://github.com/SkriptLang/skript-docs">Documentation Repo</a> • Site developed by <a href="https://github.com/AyhamAl-Ali">Ayham Al-Ali</a> • Site Version <b>${site-version}</b> • Generated on <b>13/11/2023</b></p> <div style="padding-top: 16px;"></div> <!-- Space --> </div> </body> </html>
</code></pre> <div id="info" class="grid-container padding"> <div class="grid-item"> <p class="box-title">Latest Stable Version</p> <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/releases/tag/${stable-version}" target="_blank">Skript ${stable-version}</a></p> </div> <div class="grid-item"> <p class="box-title">Latest Version</p> <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/releases/tag/${latest-version}" target="_blank">Skript ${latest-version}</a></p> </div> <div class="grid-item"> <p class="box-title">Contributors</p> <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/graphs/contributors" target="_blank">${contributors-size} Contributors</a></p> </div> </div> <p class="box"> Found something incorrect in this documentation? Please report it to the <a href="https://github.com/SkriptLang/skript-docs/issues/">issue tracker</a>. </p> <p class="box"> <strong>We are looking for docs authors!</strong> Currently, the only documentation is generated automatically. It would be nice to have some hand-written content such as tutorials on the docs as well. For example, currently we don't have a tutorial on how to use loops here; This makes it harder for newcomers to learn. Check <a href="https://github.com/SkriptLang/skript-docs/issues/12">this issue</a> for more details and if you're interested in helping out. </p> <div style="padding-top: 64px;"></div> <!-- Space --> <p style="font-size: 14px; text-align: center;" class="placeholder"><a href="https://github.com/SkriptLang/skript-docs">Documentation Repo</a> • Site developed by <a href="https://github.com/AyhamAl-Ali">Ayham Al-Ali</a> • Site Version <b>${site-version}</b> • Generated on <b>17/11/2023</b></p> <div style="padding-top: 16px;"></div> <!-- Space --> </div> </body> </html>
Loading

0 comments on commit 2f3e236

Please sign in to comment.