Changed project name to skript-reflect

Added sections
Added `usable in` section for custom syntax (closes #27)

Author: TPGamesNL

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -17,11 +17,11 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Server information**
-- skript-mirror: 
-- Skript: 
-- Bukkit: 
-- Minecraft: 
-- Java: 
+- skript-reflect:
+- Skript:
+- Bukkit:
+- Minecraft:
+- Java:
 - OS:
 
 **Additional context**

.github/workflows/gradle.yml

@@ -22,4 +22,4 @@ jobs:
         run: ./gradlew build
       - uses: actions/upload-artifact@master
         with:
-          path: build/libs/skript-mirror-2.0.0-SNAPSHOT.jar
+          path: build/libs/skript-reflect-2.0.0-SNAPSHOT.jar

README.md

@@ -1,12 +1,12 @@
-# skript-mirror-tp
+# skript-reflect
 
 This fork of [skript-mirror](https://github.com/btk5h/skript-mirror) aims to fix multiple issues that I believe have been present for too long, and implement some long-wanted features.
 
-Documentation: https://skript-mirror-tp.gitbook.io/
+Documentation: https://tpgamesnl.gitbook.io/skript-reflect
 
-Source code: https://github.com/TPGamesNL/skript-mirror
+Source code: https://github.com/TPGamesNL/skript-reflect
 
-Downloads: [actions](https://github.com/TPGamesNL/skript-mirror/actions?query=event%3Apush+is%3Asuccess+actor%3ATPGamesNL) (I'll probably release an actual version soon).
+Downloads: [actions](https://github.com/TPGamesNL/skript-reflect/actions?query=event%3Apush+is%3Asuccess+actor%3ATPGamesNL) (I'll probably release an actual version soon).
 
 If you want to talk about this project or something else, contact me on Discord: TPGamesNL#0880
 

docs/SUMMARY.md

@@ -1,6 +1,6 @@
 # Table of contents
 
-* [skript-mirror](../README.md)
+* [skript-reflect](../README.md)
 * [Getting Started](getting-started.md)
 * [Basics](basics/README.md)
   * [Reading Javadocs](basics/reading-javadocs.md)
@@ -17,6 +17,9 @@
     * [Expressions](advanced/custom-syntax/expressions.md)
     * [Events](advanced/custom-syntax/events.md)
   * [Computed Options](advanced/computed-options.md)
+  * [Reflection](advanced/reflection/README.md)
+    * [Proxies](advanced/reflection/proxies.md)
+    * [Sections](advanced/reflection/sections.md)
   * [Experiments](advanced/experiments.md)
 * [Code Conventions](code-conventions.md)
 * [Frequently Asked Questions](frequently-asked-questions.md)

docs/advanced/custom-syntax/README.md

@@ -1,6 +1,6 @@
 # Custom syntax
 
-Due to Skript and skript-mirror limitations, it is not easy to create custom syntax through Java calls alone. To help with this, skript-mirror offers utilities that simplify the creation of custom syntax.
+Due to Skript and skript-reflect limitations, it is not easy to create custom syntax through Java calls alone. To help with this, skript-reflect offers utilities that simplify the creation of custom syntax.
 
 ## Shared Syntax
 

docs/advanced/custom-syntax/events.md

@@ -5,8 +5,8 @@
 {% code-tabs %}
 {% code-tabs-item title="Syntax" %}
 ```text
-[local] [custom] event <pattern>:
-  name: # unique name, required
+[local] [custom] event %string%:
+  pattern: # pattern, required
   event-values: # list of types, optional
   parse:
     # code, optional
@@ -21,10 +21,9 @@
 {% code-tabs %}
 {% code-tabs-item title="Syntax" %}
 ```text
-[local] [custom] event:
+[local] [custom] event %string%:
   patterns:
     # patterns, one per line
-  name: # unique name, required
   event-values: # list of types, optional
   parse:
     # code, optional
@@ -44,9 +43,10 @@ Specifying that an event is `local` makes the event only usable from within the
 Local events are guaranteed to be parsed before other custom events, but not necessarily before events from other addons.
 {% endhint %}
 
-### Option `name`
+### Event identifier
 
-The name you specify here should be used for [`calling the event`](#calling-the-event).
+The string used in the trigger line represents the identifier of this custom event.
+This identifier should be used for [`calling the event`](#calling-the-event).
 
 ### Option `event-values`
 
@@ -56,23 +56,23 @@ The event-values specified here will be available in the event, either as a defa
 
 Code in this section is executed whenever the event is parsed. This section may be used to emit errors if the effect is used in an improper context.
 
-If this section is included, you must also [`continue`](./#continue) if the event was parsed successfully.
+If this section is included, you must also [`continue`](README.md#continue) if the event was parsed successfully.
 
 {% hint style="info" %}
 Local variables created in this section are copied by-value to other sections.
 
 {% code-tabs %}
 {% code-tabs-item title="example.sk" %}
 ```text
-event example:
-  name: example
+event "example":
+  pattern: example
   parse:
     set {_test} to 1
     continue
   check:
     # {_test} always starts at 1 here
     add 1 to {_test}
-    # 2 is always broadcast
+    # broadcasts 2
     broadcast "%{_test}%"
 ```
 {% endcode-tabs-item %}
@@ -83,7 +83,7 @@ event example:
 
 Code in this section is executed just before the event is called. This section may be used to stop the event from being called if certain conditions are met.
 
-If this section is included, you must also [`continue`](./#continue) if you want to event to be called.
+If this section is included, you must also [`continue`](README.md#continue) if you want to event to be called.
 
 ### Calling the event
 

docs/advanced/error-handling.md

@@ -1,6 +1,6 @@
 # Error handling
 
-By default, warnings and errors related to your code are logged to the console. Skript-mirror also offers additional tools that give you more control over how errors are handled.
+By default, warnings and errors related to your code are logged to the console. Skript-reflect also offers additional tools that give you more control over how errors are handled.
 
 ## Suppressing errors
 
@@ -31,5 +31,5 @@ In some cases, you may want to handle errors yourself, either to do your own err
 {% endcode-tabs-item %}
 {% endcode-tabs %}
 
-Returns the last error object thrown by a java call. If there was an issue resolving the method or converting its output, it may be a `com.btk5h.skriptmirror.JavaCallException`. 
+Returns the last error object thrown by a java call. If there was an issue resolving the method or converting its output, it may be a `com.btk5h.skriptmirror.JavaCallException`.
 

docs/advanced/experiments.md

@@ -9,78 +9,15 @@ In order to enable experimental features, add the following section to your scri
 {% code-tabs %}
 {% code-tabs-item title="Consent section" %}
 ```text
-skript-mirror, I know what I'm doing:
+skript-reflect, I know what I'm doing:
   I understand that the following features are experimental and may change in the future.
-  I have read about this at https://skript-mirror.gitbook.io/docs/advanced/experiments
+  I have read about this at https://tpgamesnl.gitbook.io/skript-reflect/advanced/experiments
 ```
 {% endcode-tabs-item %}
 {% endcode-tabs %}
 
 Individual features may be enabled by adding the codename of the feature on new lines following the consent section.
 
-## `proxies`
-
-{% code-tabs %}
-{% code-tabs-item title="Syntax" %}
-```text
-[a] [new] proxy [instance] of %javatypes% (using|from) %objects%
-```
-{% endcode-tabs-item %}
-{% endcode-tabs %}
-
-The first argument \(`%javatypes%`\) is a list of imported interfaces (whether a class is an interface can be found on the javadoc).
-
-The second argument is an indexed list variable, with each element in the form `{list::%method name%} = %function%`.
-`%method name%` is the name of one of the methods from one of the interfaces.
-`%function%` is a function reference, which can be created with the following syntax:
-{% code-tabs %}
-{% code-tabs-item title="Function reference syntax" %}
-```text
-[the] function(s| [reference[s]]) %strings% [called with [[the] [arg[ument][s]]] %-objects%]
-```
-{% endcode-tabs-item %}
-{% endcode-tabs %}
-
-The first argument \(`%strings%`\) is the name of the function you want to reference. This is enough for the function reference to be completed,
-but you can also add some argument values.
-
-When a method from the proxy is ran, it is passed on to the function corresponding to the method name.
-The arguments of this function are defined in the following way:
-1. The argument values specified in the function reference \(if there are any\)
-2. The proxy instance object itself.
-3. The argument values from the method call.
-
-Here's an example to help you understand it:
-{% code-tabs %}
-{% code-tabs-item title="Function reference syntax" %}
-```text
-import:
-	java.lang.Runnable
-
-skript-mirror, I know what I'm doing:
-	I understand that the following features are experimental and may change in the future.
-	I have read about this at https://skript-mirror.gitbook.io/docs/advanced/experiments
-	proxies
-
-function do_something():
-	broadcast "It does something!"
-
-command /proxy:
-	trigger:
-		# As you can see on https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html
-		# the Runnable interface has one method: run
-		set {_functions::run} to function reference "do_something"
-		set {_proxy} to new proxy instance of Runnable using {_functions::*}
-		{_proxy}.run() # will broadcast 'It does something!'
-        Bukkit.getScheduler().runTask(Skript.getInstance(), {_proxy}) # also broadcasts 'It does something!'
-```
-{% endcode-tabs-item %}
-{% endcode-tabs %}
-
-{% hint style="info" %}
-Class proxies are most useful for more interaction with Java code, for example when methods require some implementation of an interface.
-{% endhint %}
-
 ## `deferred-parsing`
 
 Deferred parsing allows you to prefix any line with `(parse[d] later)` to defer parsing until the first execution of the line. This allows you to circumvent issues where custom syntaxes are used before they are defined.

docs/advanced/loading-external-libraries.md

@@ -1,8 +1,8 @@
 # Loading external libraries
 
-Normally, you may only access classes loaded in the server's classpath, such as Java standard library classes, Bukkit classes, and plugin classes. If you want to use third-party libraries that are not included on the server classpath, you must load them through skript-mirror first.
+Normally, you may only access classes loaded in the server's classpath, such as Java standard library classes, Bukkit classes, and plugin classes. If you want to use third-party libraries that are not included on the server classpath, you must load them through skript-reflect first.
 
-To load a jar file, place it in `plugins/skript-mirror/` \(create the folder if it doesn't exist\).
+To load a jar file, place it in `plugins/skript-reflect/` \(create the folder if it doesn't exist\).
 
 Once an external library is loaded, its classes may be imported just like any other class.
 

docs/advanced/reflection/README.md

@@ -0,0 +1 @@
+# Reflection