AddRemoteEvent: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
Line 10: | Line 10: | ||
{{FuncParam|LuaFunction|The lua function you want to call. Values you return from this function won't be transmitted to the originating CallRemoteEvent.}} | {{FuncParam|LuaFunction|The lua function you want to call. Values you return from this function won't be transmitted to the originating CallRemoteEvent.}} | ||
{{FuncReturnValue|This function | {{FuncReturnValue|This function returns '''true''' on success.}} | ||
== Example == | == Example == |
Revision as of 21:28, 6 October 2020
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. Values you return from this function won't be transmitted to the originating CallRemoteEvent.
Return Value
- This function returns true on success.
Example
-- This example calls the remote event from the server side to the client side
-- Client side
function ClientSetTime(time)
SetTime(time)
end
AddRemoteEvent("ClientSetTime", ClientSetTime)
-- Server side
function cmd_time(player, player_time)
if (player_time == nil) then
return AddPlayerChat(player, "Usage: /time <time 0.0-24.0>")
end
player_time = tonumber(player_time)
if (player_time == nil or player_time < 0 or player_time > 24) then
return AddPlayerChat(player, "Parameter \"time\" 0.0-24.0")
end
CallRemoteEvent(player, "ClientSetTime", player_time)
end
AddCommand("time", cmd_time)
-- 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("OnClientRadio", function(playerid)
AddPlayerChat(playerid, "Client activated radio")
end)