yetanotherclown / yetanothernet Goto Github PK

In the typescript documentation for Matter setup the following routes.ts is recommended:

import { Route } from "@rbxts/yetanothernet";

const defaultConfiguration = {
  Channel: "Reliable",
  Event: "default",
}

// Replicate Matter Components
const MatterReplication = new Route(defaultConfiguration);

// Signal that the Player has loaded
const PlayerLoaded: Route<[boolean]> = new Route(defaultConfiguration);

export = {
  MatterReplication: MatterReplication,
  PlayerLoaded: PlayerLoaded,
}

This results in the following error by default: Argument of type '{ Channel: string; Event: string; }' is not assignable to parameter of type 'Configuration'. Types of property 'Channel' are incompatible. Type 'string' is not assignable to type '"Reliable" | "Unreliable" | undefined'.

I fixed this by moving the Configuration type to the Net namespace

declare namespace Net {
    const server: "NET_SERVER";
    
    type Configuration = {
        Channel: "Reliable" | "Unreliable" | undefined,
        Event: string | undefined,
    }
...

and make the defaultConfiguration use this type

import { Route, Configuration } from "@rbxts/yetanothernet";

const defaultConfiguration: Configuration = {
	Channel: "Reliable",
	Event: "default",
};

// Replicate Matter Components
const MatterReplication = new Route(defaultConfiguration);

// Signal that the Player has loaded
const PlayerLoaded: Route<[boolean]> = new Route(defaultConfiguration);

export = {
	MatterReplication: MatterReplication,
	PlayerLoaded: PlayerLoaded,
};

The Matter ECS has a large user base of Typescript users, we should provide them an opportunity to use Net as well.

Personally, I have not ever used Typescript and currently do not have time to learn it and work on Roblox-TS Types for Net, this issue exists in case anyone would like to help out with Roblox-TS Types. Resources on the process would be appreciated, I'd be interested in supporting Roblox-TS myself in the future.

As of now the definition for Net.start is the following:

    function start<T extends Array<any>>(loop: any, routes: Array<Route<T>>): void

This expects an Array, which only allows numeric indexes unlike Luau's tables, it also forces all routes to be the same type T and because of this the recommended matter setup route definition cannot be used:

import { Route } from "@rbxts/yetanothernet";

const defaultConfiguration = {
  Channel: "Reliable",
  Event: "default",
}

// Replicate Matter Components
const MatterReplication = new Route(defaultConfiguration);

// Signal that the Player has loaded
const PlayerLoaded: Route<[boolean]> = new Route(defaultConfiguration);

export = {
  MatterReplication: MatterReplication,
  PlayerLoaded: PlayerLoaded,
}

I fixed this by turning the routes Array in the type into an object and removing the type parameter and for this to work we also have to give the Route a default value:

    // on index.d.ts Route definition
    class Route<T extends Array<any> = Array<any>> {
        public constructor(configuration: Configuration | null);

    // on index.d.ts start definition
    function start(loop: any, routes: {[index: string]: Route}): void

This is a Luau bug, but since this affects Net this issue will serve as a guide for how to workaround this and provide information on it.
If you would like to track the Luau Issue, it is here luau-lang/luau#819.

In order to workaround this bug, you can do this when querying:

for pos, sender, str, num in route:query():__iter() do
     -- Do something
end

In the meantime, there is nothing we can do to fix this for Net, you will either have to use the workaround or wait until the new Luau Type Solver comes out.

The issue is that the parent of the remote event is under the script, which Rojo overwrites.
To fix this simply move the replicated event outside of the script and somewhere where Rojo can't touch it.
I'll draft a PR tomorrow unless someone else wants to do this.