Remote
A simple remote wrapper
Summary
Constructors
| new (name: string, isUnreliable: boolean?) : Remote |
Methods
| FireServer (arguments: Tuple) |
| FireClient (player: Player, arguments: Tuple) |
| FireClients (players: Players, arguments: Tuple) |
| FireAllClients (arguments: Tuple) |
| GetOnServerEventForPlayer (player: Player) : Signal |
| IsHandlerConnected () : boolean |
Events
| OnClientEvent (arguments: Tuple) : Signal |
| OnServerEvent (player: Player, arguments: Tuple) : Signal |
Constructors
new
Can Yield
Remote.new ( name: string, isUnreliable: boolean? ) : Remote
Parameters
| name : string The name of the Remote. Duplicate names will not error, but instead of creating a new Remote, it will return the existing Remote with that name. |
| isUnreliable : boolean? Whether the Remote should be created as an UnreliableRemoteEvent or not. |
Returns
| Remote |
Methods
FireServer
Client Only
Remote:FireServer ( arguments: Tuple ) : ()
Parameters
| arguments : Tuple |
FireClient
Server Only
Remote:FireClient ( player: Player, arguments: Tuple ) : ()
Parameters
| player : Player |
| arguments : Tuple |
FireClients
Server Only
Remote:FireClients ( players: Players, arguments: Tuple ) : ()
Parameters
| players : Players |
| arguments : Tuple |
FireAllClients
Server Only
Remote:FireAllClients ( arguments: Tuple ) : ()
Parameters
| arguments : Tuple |
GetOnServerEventForPlayer
Server Only
Remote:GetOnServerEventForPlayer ( player: Player ) : Signal
Parameters
| player : Player |
Returns
| Signal |
IsHandlerConnected
Server Only
Remote:IsHandlerConnected ( ) : boolean
Returns
| boolean |
Events
OnClientEvent
Client Only
Remote.OnClientEvent ( arguments: Tuple ) : Signal
Parameters
| arguments : Tuple The parameters sent through FireClient, FireClients, or FireAllClients. |
Returns
| Signal |
OnServerEvent
Server Only
Remote.OnServerEvent ( player: Player, arguments: Tuple ) : Signal
Parameters
| player : Player The player who triggered the event. |
| arguments : Tuple The parameters sent through FireServer. |
Returns
| Signal |