AddRemoteEvent: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Info|Function|Server & Client|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|The remote event to call from either server to client or vice versa.}}


{{FuncSyntax|AddRemoteEvent(RemoteEventName, LuaFunction)}}
{{FuncSyntax|AddRemoteEvent(player, RemoteEventName, LuaFunction)}}
{{FuncSyntaxClient|AddRemoteEvent(RemoteEventName, LuaFunction)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|RemoteEventName|__EDIT_ME__}}
{{FuncParam|player|The player identifier.}}
{{FuncParam|LuaFunction|__EDIT_ME__}}
{{FuncParam|RemoteEventName|The remote event name.}}
{{FuncParam|LuaFunction|The lua function.}}


{{FuncReturnValue|This function has no specific return value.}}
{{FuncReturnValue|This function has no specific return value.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
-- Client side
AddRemoteEvent("SetWeather", function(weatherid)
    SetWeather(weatherid)
end)
 
-- Server side
AddCommand("we", function(playerid, weatherid)
    CallRemoteEvent(playerid, "SetWeather", weatherid)
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[CallEvent]]
* [[CallRemoteEvent]]
* [[AddRemoteEvent]]

Revision as of 15:16, 17 November 2019

AddRemoteEvent

Type: Function
Context: Server & Client
Introduced: v1.0

Description

The remote event to call from either server to client or vice versa.

Syntax

AddRemoteEvent(player, RemoteEventName, LuaFunction)
Client Syntax
AddRemoteEvent(RemoteEventName, LuaFunction)

Parameters

  • player
    The player identifier.
  • RemoteEventName
    The remote event name.
  • LuaFunction
    The lua function.

Return Value

  • This function has no specific return value.

Example

-- Client side
AddRemoteEvent("SetWeather", function(weatherid)
    SetWeather(weatherid)
end)

-- Server side
AddCommand("we", function(playerid, weatherid)
    CallRemoteEvent(playerid, "SetWeather", weatherid)
end)

See also