rc-2 commit

lumin-org · Oct 7, 2023 · 85930e9 · 85930e9
1 parent eb7e86f
commit 85930e9
Show file tree

Hide file tree

Showing 14 changed files with 151 additions and 328 deletions.
diff --git a/docs/api/controllers/network/client.md b/docs/api/controllers/network/client.md
@@ -4,14 +4,6 @@ A client-sided network controller, based on [this](/api/engine/types#networkcont
 
 ## Properties
 
-### Name <Badge type="tip" text="read only" />
-
-The name of the the network controller.
-
-* **string**
-
----
-
 ### IsListening <Badge type="tip" text="read only" />
 
 Whether or not the network controller is subscribed to an event.
@@ -34,7 +26,7 @@ NetworkController:Fire("Hello, world!")
 
 **Parameters**
 
-* **data:** `Array<any> | any`\
+* **data:** `...any`\
 The data that should be sent to the server
 
 **Returns**
@@ -49,7 +41,7 @@ Invokes the server, equivalent to [RemoteFunction:InvokeServer](https://create.r
 
 **Parameters**
 
-* **data:** `Array<any> | any`\
+* **data:** `...any`\
 The data to invoke the server with
 
 **Returns**
@@ -64,7 +56,7 @@ Listens for the network controller to be fired by the server, then runs the prov
 
 **Parameters**
 
-* **func:** `(data: Array<any>) -> ()`\
+* **func:** `(...: any) -> ()`\
 The function to call when data is recieved
 
 **Returns**

diff --git a/docs/api/controllers/network/server.md b/docs/api/controllers/network/server.md
@@ -4,14 +4,6 @@ A server-sided network controller, based on [this](/api/engine/types#networkcont
 
 ## Properties
 
-### Name <Badge type="tip" text="read only" />
-
-The name of the the network controller.
-
-* **string**
-
----
-
 ### IsListening <Badge type="tip" text="read only" />
 
 Whether or not the network controller is subscribed to an event.
@@ -36,16 +28,16 @@ Fires an event which sends data to the client, equivalent to [RemoteEvent:FireCl
 If you need to fire the event to multiple players instead of one, you can use a table of players.
 
 ```lua
-NetworkController:Fire({Player1, Player2, Player3}, {1, 2, 3})
+NetworkController:Fire({Player1, Player2, Player3}, 1, 2, 3)
 ```
 :::
 
 **Parameters**
 
-* **recipients:** `{ Player } | Player`\
+* **recipients:** `Array<Player> | Player`\
 The players who should recieve the data and/or call
 
-* **data:** `(Array<any> | any)?`\
+* **data:** `...any`\
 The data that should be sent to the client
 
 **Returns**
@@ -60,7 +52,7 @@ Fires an event which sends data to every client connected to the server, equival
 
 **Parameters**
 
-* **data:** `(Array<any> | any)?`\
+* **data:** `...any`\
 The data that should be sent to each player
 
 **Returns**
@@ -78,7 +70,7 @@ Fires an event which sends data to every client connected to the server, except
 * **except:** `Array<Player> | Player`\
 The players which the call should not be sent to
 
-* **data:** `(Array<any> | any)?`\
+* **data:** `...any`\
 The data that should be sent to each player except `except`
 
 **Returns**
@@ -99,7 +91,7 @@ The point to compare from, can be a standalone `Vector3`
 * **maximumRange:** `number`\
 The maximum range of which the player's characters have to be within to recieve the event
 
-* **data:** `(Array<any> | any)?`\
+* **data:** `...any`\
 The data that should be sent to each player within `maximumRange`
 
 **Returns**
@@ -117,7 +109,7 @@ Fires an event with a filter function, and runs the provided filter on every pla
 * **filter:** `(Player) -> (boolean)`\
 The filter to run on each player, return a boolean to indicate that the player meets the threshold
 
-* **data:** `(Array<any> | any)?`\
+* **data:** `...any`\
 The data that should be sent to each player that meets the threshold for `filter`
 
 **Returns**
@@ -132,7 +124,7 @@ Listens for the network controller to be fired by the client, then runs the prov
 
 **Parameters**
 
-* **func:** `(sender: Player, data: Array<any>?) -> ()`\
+* **func:** `(sender: Player, data: ...: unknown) -> ()`\
 The function to call when data is recieved
 
 **Returns**
@@ -147,7 +139,7 @@ Recieves an invoke from the client, and runs the callback function which returns
 
 **Parameters**
 
-* **callback:** `(sender: Player, data: Array<any>?) -> (Array<any> | any)`\
+* **callback:** `(sender: Player, ...: unknown) -> (...any)`\
 The callback function to run on invoke, must return at least 1 value.
 
 **Returns**

diff --git a/docs/api/controllers/signal/signalcontroller.md b/docs/api/controllers/signal/signalcontroller.md
@@ -2,14 +2,6 @@
 
 A lua-based signal implementation, based on [this](/api/engine/types#signalcontroller) type.
 
-## Properties
-
-### Name <Badge type="tip" text="read only" />
-
-The name of the the signal controller.
-
-* **string**
-
 ## Methods
 
 ### Fire
@@ -26,7 +18,7 @@ SignalController:Fire("Hello, world!")
 
 **Parameters**
 
-* **data:** `(Array<any> | any)?`\
+* **data:** `...any`\
 The data that should be sent the other script
 
 **Returns**
@@ -41,7 +33,7 @@ Connects a function to the event that is fired when another script fires the con
 
 **Parameters**
 
-* **func:** `(data: Array<any>?) -> ()`\
+* **func:** `(...: any) -> ()`\
 The function to call when data is recieved
 
 **Returns**
@@ -56,7 +48,7 @@ Connects a function to the event that is fired when another script fires the con
 
 **Parameters**
 
-* **func:** `(data: Array<any>?) -> ()`\
+* **func:** `(...: any) -> ()`\
 The function to call when data is recieved
 
 **Returns**

diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ hero:
   actions:
     - theme: brand
       text: Documentation
-      link: /tutorial/update
+      link: /tutorial/packages
     - theme: alt
       text: API Reference
       link: /api/engine/framework/canaryengine

diff --git a/plugin/settings/settings.json b/plugin/settings/settings.json
@@ -1,5 +1,5 @@
 {
-    "Files": 21,
+    "Files": 18,
     "FrameworkName": ["Framework", "CanaryEngineFramework"],
     "CanaryStudioChangelog": "Need help? You can refer to our help articles at https://canary-development.github.io/CanaryEngine.\nFrom there, you can view our documentation on libraries the plugin itself."
 }
diff --git a/plugin/src/json/structure.json b/plugin/src/json/structure.json
@@ -1,22 +1,22 @@
 {
     "EngineClient": {
-        "Packages": { },
+        "Packages": {},
         "Media": {
-            "Models": { },
-            "Effects": { },
-            "Animations": { },
-            "Sounds": { },
-            "Interfaces": { }
+            "Models": {},
+            "Effects": {},
+            "Animations": {},
+            "Sounds": {},
+            "Interfaces": {}
         },
-        "Scripts": { }
+        "Scripts": {}
     },
     "EngineReplicated": {
-        "Packages": { },
+        "Packages": {},
         "Media": {
-            "Sounds": { },
-            "Models": { },
-            "Animations": { },
-            "Effects": { }
+            "Sounds": {},
+            "Models": {},
+            "Animations": {},
+            "Effects": {}
         }
     },
     "EngineReplicatedFirst": {
@@ -31,96 +31,65 @@
                 "Vendor": "EngineLoaderAssets"
             }
         },
-        "Scripts": { }
+        "Scripts": {}
     },
     "EngineServer": {
-        "Packages": { },
+        "Packages": {},
         "Media": {
-            "Models": { },
-            "Tools": { },
-            "Effects": { },
-            "Animations": { }
+            "Models": {},
+            "Tools": {},
+            "Effects": {},
+            "Animations": {}
         },
-        "Scripts": { }
+        "Scripts": {}
     },
     "Framework": {
         "Vendor": {
-            "Controllers": {
+            "Network": {
                 "Vendor": {
-                    "Sanitize": {
+                    "Guard": {
                         "$className": "ModuleScript",
                         "$properties": {
-                            "Source": "https://raw.githubusercontent.com/canary-development/CanaryEngine/main/src/lua/framework/Vendor/Controllers/Vendor/Sanitize.luau"
+                            "Source": "https://raw.githubusercontent.com/red-blox/Util/1f9216713d15579bdf1744235448fbac702aa54c/libs/Guard/Guard.luau"
                         }
                     },
-                    "NetworkController": {
-                        "Events": { },
-                        "Vendor": {
-                            "Ratelimit": {
-                                "$className": "ModuleScript",
-                                "$properties": {
-                                    "Source": "https://raw.githubusercontent.com/red-blox/Util/62037a647038af2b92129435957bace986452ff1/libs/Ratelimit/Ratelimit.luau"
-                                }
-                            },
-                            "Guard": {
-                                "$className": "ModuleScript",
-                                "$properties": {
-                                    "Source": "https://raw.githubusercontent.com/red-blox/Util/1f9216713d15579bdf1744235448fbac702aa54c/libs/Guard/Guard.luau"
-                                }
-                            },
-                            "Future": {
-                                "$className": "ModuleScript",
-                                "$properties": {
-                                    "Source": "https://raw.githubusercontent.com/red-blox/Util/76281011d28f083d2d659ef4c1b567270192aeb3/libs/Future/Future.luau"
-                                }
-                            },
-                            "Spawn": {
-                                "$className": "ModuleScript",
-                                "$properties": {
-                                    "Source": "https://raw.githubusercontent.com/red-blox/Util/fd238ef1d4771a7aaa83b2f0650527f01337ce24/libs/Spawn/Spawn.luau"
-                                }
-                            },
-                            "Red": {
-                                "ClientEvent": {
-                                    "$className": "ModuleScript",
-                                    "$properties": {
-                                        "Source": "https://raw.githubusercontent.com/red-blox/Red/ffd21a7a776873751c24e7e1ed4cf517564cd5f7/lib/ClientEvent.luau"
-                                    }
-                                },
-                                "ServerEvent": {
-                                    "$className": "ModuleScript",
-                                    "$properties": {
-                                        "Source": "https://raw.githubusercontent.com/red-blox/Red/ffd21a7a776873751c24e7e1ed4cf517564cd5f7/lib/ServerEvent.luau"
-                                    }
-                                },
-                                "Identifier": {
-                                    "$className": "ModuleScript",
-                                    "$properties": {
-                                        "Source": "https://raw.githubusercontent.com/red-blox/Red/ffd21a7a776873751c24e7e1ed4cf517564cd5f7/lib/Identifier.luau"
-                                    }
-                                }
+                    "Future": {
+                        "$className": "ModuleScript",
+                        "$properties": {
+                            "Source": "https://raw.githubusercontent.com/red-blox/Util/76281011d28f083d2d659ef4c1b567270192aeb3/libs/Future/Future.luau"
+                        }
+                    },
+                    "Spawn": {
+                        "$className": "ModuleScript",
+                        "$properties": {
+                            "Source": "https://raw.githubusercontent.com/red-blox/Util/fd238ef1d4771a7aaa83b2f0650527f01337ce24/libs/Spawn/Spawn.luau"
+                        }
+                    },
+                    "Red": {
+                        "ClientEvent": {
+                            "$className": "ModuleScript",
+                            "$properties": {
+                                "Source": "https://raw.githubusercontent.com/red-blox/Red/ffd21a7a776873751c24e7e1ed4cf517564cd5f7/lib/ClientEvent.luau"
                             }
                         },
-                        "Init": {
+                        "ServerEvent": {
                             "$className": "ModuleScript",
                             "$properties": {
-                                "Source": "https://raw.githubusercontent.com/canary-development/CanaryEngine/main/src/lua/framework/Vendor/Controllers/Vendor/NetworkController/init.luau"
+                                "Source": "https://raw.githubusercontent.com/red-blox/Red/ffd21a7a776873751c24e7e1ed4cf517564cd5f7/lib/ServerEvent.luau"
                             }
-                        }
-                    },
-                    "SignalController": {
-                        "Init": {
+                        },
+                        "Identifier": {
                             "$className": "ModuleScript",
                             "$properties": {
-                                "Source": "https://raw.githubusercontent.com/canary-development/CanaryEngine/main/src/lua/framework/Vendor/Controllers/Vendor/SignalController/init.luau"
+                                "Source": "https://raw.githubusercontent.com/red-blox/Red/ffd21a7a776873751c24e7e1ed4cf517564cd5f7/lib/Identifier.luau"
                             }
                         }
                     }
                 },
                 "Init": {
                     "$className": "ModuleScript",
                     "$properties": {
-                        "Source": "https://raw.githubusercontent.com/canary-development/CanaryEngine/main/src/lua/framework/Vendor/Controllers/init.luau"
+                        "Source": "https://raw.githubusercontent.com/canary-development/CanaryEngine/main/src/lua/framework/Vendor/Network/init.luau"
                     }
                 }
             },
@@ -140,7 +109,7 @@
                             }
                         }
                     }
-                }, 
+                },
                 "RedbloxUtils": {
                     "Future": {
                         "$className": "ModuleScript",
@@ -159,6 +128,12 @@
                         "$properties": {
                             "Source": "https://raw.githubusercontent.com/red-blox/Util/fd238ef1d4771a7aaa83b2f0650527f01337ce24/libs/Spawn/Spawn.luau"
                         }
+                    },
+                    "Ratelimit": {
+                        "$className": "ModuleScript",
+                        "$properties": {
+                            "Source": "https://raw.githubusercontent.com/red-blox/Util/62037a647038af2b92129435957bace986452ff1/libs/Ratelimit/Ratelimit.luau"
+                        }
                     }
                 }
             },

diff --git a/src/lua/framework/Vendor/Controllers/Vendor/Sanitize.luau b/src/lua/framework/Vendor/Controllers/Vendor/Sanitize.luau