Skip to content

Commit

Permalink
Update feature/eff-copy branch nightly docs to SkriptLang/Skript@8eeaa14
Browse files Browse the repository at this point in the history
  • Loading branch information
Nightly Docs Bot committed Nov 17, 2023
1 parent 03de049 commit 442977a
Show file tree
Hide file tree
Showing 13 changed files with 51 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/nightly/feature/eff-copy/classes.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/feature/eff-copy/conditions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/feature/eff-copy/docs.html

Large diffs are not rendered by default.

71 changes: 38 additions & 33 deletions docs/nightly/feature/eff-copy/docs.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"skriptVersion" : "2.8.0-dev-nightly-ff6c7ad",
"skriptVersion" : "2.8.0-dev-nightly-8eeaa14",

"classes" : [
{
Expand Down Expand Up @@ -3276,7 +3276,7 @@ Do note that other event values, such as 'player', won't work in this section.",
"pattern_end"
],
"since" : "2.5.1",
"description" : "Called when a player swings his arm.",
"description" : "Called when a player swings their arm.",
"examples" : "on arm swing:\\n send \"You swung your arm!\""
},
{
Expand Down Expand Up @@ -3449,7 +3449,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;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]\""
"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]\""
},
{
"id" : "chunk_generate",
Expand Down Expand Up @@ -3899,13 +3899,16 @@ Do note that other event values, such as 'player', won't work in this section.",
"id" : "grow",
"name" : "On Grow",
"patterns" : [
"[on] grow [of (%<a href='./classes.html#structuretype'>tree type</a>%|%<a href='./classes.html#itemtype'>item type</a>%)]",
"[on] grow[th] [of (%<a href='./classes.html#structuretype'>tree types</a>%|%<a href='./classes.html#itemtype'>item types</a>/<a href='./classes.html#blockdata'>block datas</a>%)]",
"[on] grow[th] from %<a href='./classes.html#itemtype'>item types</a>/<a href='./classes.html#blockdata'>block datas</a>%",
"[on] grow[th] [in]to (%<a href='./classes.html#structuretype'>tree types</a>%|%<a href='./classes.html#itemtype'>item types</a>/<a href='./classes.html#blockdata'>block datas</a>%)",
"[on] grow[th] from %<a href='./classes.html#itemtype'>item types</a>/<a href='./classes.html#blockdata'>block datas</a>% [in]to (%<a href='./classes.html#structuretype'>tree types</a>%|%<a href='./classes.html#itemtype'>item types</a>/<a href='./classes.html#blockdata'>block datas</a>%)",

"pattern_end"
],
"since" : "1.0 (2.2-dev20 for plants)",
"description" : "Called when a tree, giant mushroom or plant grows to next stage.",
"examples" : "on grow:\\non grow of a tree:\\non grow of a huge jungle tree:"
"since" : "1.0, 2.2-dev20 (plants), INSERT VERSION (from, into, blockdata)",
"description" : "Called when a tree, giant mushroom or plant grows to next stage.\\n\"of\" matches any grow event, \"from\" matches only the old state, \"into\" matches only the new state,and \"from into\" requires matching both the old and new states.\\nUsing \"and\" lists in this event is equivalent to using \"or\" lists. The event will trigger if any one of the elements is what grew.",
"examples" : "on grow:\\non grow of tree:\\non grow of wheat[age=7]:\\non grow from a sapling:\\non grow into tree:\\non grow from a sapling into tree:\\non grow of wheat, carrots, or potatoes:\\non grow into tree, giant mushroom, cactus:\\non grow from wheat[age=0] to wheat[age=1] or wheat[age=2]:"
},
{
"id" : "hand_item_swap",
Expand Down Expand Up @@ -4224,16 +4227,18 @@ Do note that other event values, such as 'player', won't work in this section.",
"examples" : "on loot generate:\\n chance of 10%\\n add 64 diamonds to the loot\\n send \"You hit the jackpot at %event-location%!\""
},
{
"id" : "move",
"name" : "On Move",
"id" : "move_rotate",
"name" : "On Move / Rotate",
"patterns" : [
"[on] %<a href='./classes.html#entitydata'>entity type</a>% (move|walk|step)",
"[on] %<a href='./classes.html#entitydata'>entity type</a>% (move|walk|step|(turn[ing] around|rotate))",
"[on] %<a href='./classes.html#entitydata'>entity type</a>% (move|walk|step) or (turn[ing] around|rotate)",
"[on] %<a href='./classes.html#entitydata'>entity type</a>% (turn[ing] around|rotate) or (move|walk|step)",

"pattern_end"
],
"since" : "2.6",
"description" : "Called when a player or entity moves.\\nNOTE: Move event will only be called when the entity/player moves position, not orientation (ie: looking around).\\nNOTE: These events can be performance heavy as they are called quite often.\\nIf you use these events, and later remove them, a server restart is recommended to clear registered events from Skript.",
"examples" : "on player move:\\n if player does not have permission \"player.can.move\":\\n cancel event\\non skeleton move:\\n if event-entity is not in world \"world\":\\n kill event-entity"
"since" : "2.6, INSERT VERSION (turn around)",
"description" : "Called when a player or entity moves or rotates their head.\\nNOTE: Move event will only be called when the entity/player moves position, keyword 'turn around' is for orientation (ie: looking around), and the combined syntax listens for both.\\nNOTE: These events can be performance heavy as they are called quite often.",
"examples" : "on player move:\\n if player does not have permission \"player.can.move\":\\n cancel event\\non skeleton move:\\n if event-entity is not in world \"world\":\\n kill event-entity\\non player turning around:\\nsend action bar \"You are currently turning your head around!\" to player"
},
{
"id" : "move_on",
Expand Down Expand Up @@ -4329,7 +4334,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% -&gt; %event-chunk%!\" to player"
"examples" : "on player enters a chunk:\\n send \"You entered a chunk: %past event-chunk% -&amp;amp;amp;amp;gt; %event-chunk%!\" to player"
},
{
"id" : "player_deep_sleep",
Expand Down Expand Up @@ -4624,7 +4629,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;lt;red&amp;gt;%line 1%\""
"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%\""
},
{
"id" : "slime_split",
Expand Down Expand Up @@ -5657,28 +5662,28 @@ the <a href=effects.html#EffSend>send effect</a>.",
"id" : "ExprCommandInfo",
"name" : "Command Info",
"patterns" : [
"[the] main command [label] of command %<a href='./classes.html#string'>texts</a>%",
"command %<a href='./classes.html#string'>texts</a>%'[s] main command [name]",
"[the] description of command %<a href='./classes.html#string'>texts</a>%",
"command %<a href='./classes.html#string'>texts</a>%'[s] description",
"[the] label of command %<a href='./classes.html#string'>texts</a>%",
"command %<a href='./classes.html#string'>texts</a>%'[s] label",
"[the] usage of command %<a href='./classes.html#string'>texts</a>%",
"command %<a href='./classes.html#string'>texts</a>%'[s] usage",
"[(all|the|all [of] the)] aliases of command %<a href='./classes.html#string'>texts</a>%",
"command %<a href='./classes.html#string'>texts</a>%'[s] aliases",
"[the] permission of command %<a href='./classes.html#string'>texts</a>%",
"command %<a href='./classes.html#string'>texts</a>%'[s] permission",
"[the] permission message of command %<a href='./classes.html#string'>texts</a>%",
"command %<a href='./classes.html#string'>texts</a>%'[s] permission message",
"[the] plugin [owner] of command %<a href='./classes.html#string'>texts</a>%",
"command %<a href='./classes.html#string'>texts</a>%'[s] plugin [owner]",
"[the] main command [label|name] [of [[the] command[s] %<a href='./classes.html#string'>texts</a>%]]",
"command[s] %<a href='./classes.html#string'>texts</a>%'[s] main command [label|name]",
"[the] description [of [[the] command[s] %<a href='./classes.html#string'>texts</a>%]]",
"command[s] %<a href='./classes.html#string'>texts</a>%'[s] description",
"[the] label [of [[the] command[s] %<a href='./classes.html#string'>texts</a>%]]",
"command[s] %<a href='./classes.html#string'>texts</a>%'[s] label",
"[the] usage [of [[the] command[s] %<a href='./classes.html#string'>texts</a>%]]",
"command[s] %<a href='./classes.html#string'>texts</a>%'[s] usage",
"[(all|the|all [of] the)] aliases [of [[the] command[s] %<a href='./classes.html#string'>texts</a>%]]",
"command[s] %<a href='./classes.html#string'>texts</a>%'[s] aliases",
"[the] permission [of [[the] command[s] %<a href='./classes.html#string'>texts</a>%]]",
"command[s] %<a href='./classes.html#string'>texts</a>%'[s] permission",
"[the] permission message [of [[the] command[s] %<a href='./classes.html#string'>texts</a>%]]",
"command[s] %<a href='./classes.html#string'>texts</a>%'[s] permission message",
"[the] plugin [owner] [of [[the] command[s] %<a href='./classes.html#string'>texts</a>%]]",
"command[s] %<a href='./classes.html#string'>texts</a>%'[s] plugin [owner]",

"pattern_end"
],
"since" : "2.6",
"description" : "Get information about a command.",
"examples" : "main name of command \"skript\"\\ndescription of command \"help\"\\nlabel of command \"pl\"\\nusage of command \"help\"\\naliases of command \"bukkit:help\"\\npermission of command \"/op\"\\ncommand \"op\"'s permission message\\ncommand \"sk\"'s plugin owner"
"examples" : "main command label of command \"skript\"\\ndescription of command \"help\"\\nlabel of command \"pl\"\\nusage of command \"help\"\\naliases of command \"bukkit:help\"\\npermission of command \"/op\"\\ncommand \"op\"'s permission message\\ncommand \"sk\"'s plugin owner\\n\\ncommand /greet &lt;player&gt;:\\n usage: /greet &lt;target&gt;\\n trigger:\\n if arg-1 is sender:\\n send \"&amp;cYou can't greet yourself! Usage: %the usage%\"\\n stop\\n send \"%sender% greets you!\" to arg-1\\n send \"You greeted %arg-1%!\""
},
{
"id" : "ExprCommandSender",
Expand Down Expand Up @@ -9368,7 +9373,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;lt;none&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\") # &amp;amp;amp;amp;lt;none&amp;amp;amp;amp;gt; if player is offline"
},
{
"id" : "product",
Expand Down
2 changes: 1 addition & 1 deletion docs/nightly/feature/eff-copy/effects.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/feature/eff-copy/events.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/feature/eff-copy/expressions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/nightly/feature/eff-copy/functions.html

Large diffs are not rendered by default.

Loading

0 comments on commit 442977a

Please sign in to comment.