murmanox / ts-remote

ts-remote

Babby's first package.

A very simple TS wrapper for Remote Events and Remote Functions. Basically a 1 to 1 port from lua to Typescript. Hopefully type safe events between client and server.

Example usage:

In some type folder:

interface ShootRemote {
    onClientEvent: (shoot_origin: CFrame, weapon: Gun, shooter: Player) => void;
    onServerEvent: (shoot_origin: CFrame) => void;
}

interface GetLevel {
    onServerInvoke: (skill: string) => number
}

Client:

// remote event wrapper
const ShootRemote = new NetworkEvent<ShootRemote>("ShootRemote");
ShootRemote.onClientEvent.Connect((shoot_origin, weapon, shooter) => {
    // do client stuff
});

ShootRemote.fireServer(new CFrame());

// remote function wrapper
const GetLevel = new NetworkEvent<GetLevel>("GetLevel");
const level = GetLevel.invokeServer("woodcutting")

Server:

// remote event wrapper
const ShootRemote = new NetworkEvent<ShootRemote>("ShootRemote");
ShootRemote.onServerEvent.Connect((player, shoot_origin) => {
    // do server stuff
});

//remote function wrapper
const GetLevel = new NetworkEvent<GetLevel>("GetLevel");
GetLevel.onServerInvoke = (player, skill) => {
    // return player's skill level
}