This package has been deprecated

Author message:

Please use '@rbxts/remoteevent' instead

rbx-remoteevent
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

Definations TO Implements!

Definations TO Implements!

Reference

createServerRemoteEvents Function

Parameter - args:{client:FunctionObjects, server:FunctionObjects}
Remote Event Definations

Convert remote event Definations to functions.
Definations are needed to define with empty functions.
It will creates RemoteEvent to ReplicatedStorage/rbx-remoteevent/*.
client functions will be ServerRemoteSender class objects.
server functions will be OnClientEvent:Connection functions.

createClientRemoteEvents Function

This is a yielding function.
It will WAITS RemoteEvent creating of createServerRemoteEvents.

Parameter - args: {client:FunctionObjects, server:FunctionObjects}
Remote events Definations

Simmilar with createServerRemoteEvents but for client.
client functions will be FireServer functions. server functions will be OnServerEvent:Connection functions.

Methods of ServerRemoteSender Class

  • fire(client, ...) - send to one client
  • fireAll(...) - send to all clients
  • fireWithout(client, ...) - send to all without specific client
  • fires(clientArray, ...) - send to partial clients

Example

common.ts

 
// Define Remote Event Reference
export const remoteEventsReference = {
    client:{ // Server to Client
        youAre(a:number, b:string, c:boolean, name:string){},
        someoneJoined(a: number, b:string, c:boolean, name:string){},
    },
    server:{ // Client to Server
        whoAmI(a:number, b:string, c:boolean){}
    }
};
 

client.ts

import { createClientRemoteEvents } from "rbx-remoteevent";
import { remoteEventsReference } from "./common";
 
const remoteEvent = createClientRemoteEvents(remoteEventsReference);
 
 
// Receive from Server
remoteEvent.client.youAre((a, b, c, name)=>{
    print(`I'm ${name} (${a}${b}${tostring(c)})`);
});
 
// Send to Server
remoteEvent.server.whoAmI(math.random(), 'string', true);
 

server.ts

import { createServerRemoteEvents } from "rbx-remoteevent";
import { remoteEventsReference } from "./common";
 
const remoteEvent = createServerRemoteEvents(remoteEventsReference);
 
 
// Receive from Client
remoteEvent.server.whoAmI((player, a, b, c)=>{
 
    // Send to 'player'
    remoteEvent.client.youAre.fire(player, a, b, c, player.Name);
 
    // Send to All
    remoteEvent.client.someoneJoined.fireAll(a, b, c, player.Name);
 
    // Send to partial players
    const [p1, p2, p3] = game.GetService('Players').GetChildren();
    remoteEvent.client.someoneJoined.fires([p1, p2, p3], a, b, c, player.Name);
 
    // Send to All without 'player'
    remoteEvent.client.someoneJoined.fireWithout(player, a, b, c, player.Name);
});

Package Sidebar

Install

npm i rbx-remoteevent

Weekly Downloads

1

Version

1.0.1

License

ISC

Unpacked Size

53.4 kB

Total Files

9

Last publish

Collaborators

  • karikera