AddRemoteEvent: Difference between revisions

From Onset Developer Wiki
28days (talk | contribs)
No edit summary
28days (talk | contribs)
No edit summary
Line 3: Line 3:
{{FuncDescription|The remote event to call from either server to client or vice versa.}}
{{FuncDescription|The remote event to call from either server to client or vice versa.}}


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


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|playerid|The player identifier.}}
{{FuncParam|RemoteEventName|The remote event name.}}
{{FuncParam|RemoteEventName|The remote event name.}}
{{FuncParam|LuaFunction|The lua function you want to call.}}
{{FuncParam|LuaFunction|The lua function you want to call.}}

Revision as of 12:57, 19 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(RemoteEventName, LuaFunction)
Client Syntax
AddRemoteEvent(RemoteEventName, LuaFunction)

Parameters

  • RemoteEventName
    The remote event name.
  • LuaFunction
    The lua function you want to call.

Return Value

  • This function has no specific return value.

Example

-- This example calls the remote event from the server side to the client side
-- Client side
AddRemoteEvent("SetWeather", function(weatherid)
    SetWeather(weatherid)
end)

-- Server side
AddCommand("we", function(playerid, weatherid)
    CallRemoteEvent(playerid, "SetWeather", weatherid)
end)
-- This example calls the remote event from the client side to the server side
-- Client side
AddEvent("OnKeyPress", function(key)
    if key == 'R' then
        CallRemoteEvent("OnClientRadio")
    end
end)

-- Server side
AddRemoteEvent(playerid, "OnClientRadio", function()
    AddPlayerChat(playerid, "Client activated radio")
end)

See also