AddRemoteEvent

From Onset Developer Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
AddRemoteEvent

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

Description

Register a remote event that can then be called from server to client or vice versa using CallRemoteEvent

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)

See also