RFC: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:
<poem style="border: 2px solid #d6d2c5; background-color: #f9f3e6; padding: 1em;">
<poem style="border: 2px solid #d6d2c5; background-color: #f9f3e6; padding: 1em;">
The library [[LibRPC]] must be loaded with the npc for Remote Calls to work.
The library [[LibRPC]] must be loaded with the npc for Remote Calls to work.
</poem>
<poem style="border: 2px solid #d6d2c5; background-color: #ffff00; padding: 1em;">
The second parameter of the type userdata was added in v1.6 beta2 and will not work in v1.6 beta
</poem>
</poem>
{{Welcome|
{{Welcome|
desc='''This method is used to call client functions from server script using streams as medium.''' Calling RFC will returns function which can be used to call remote functions of npcscripts( i.e. functions in npcscripts: StartRecordingPlayback, SendDeathInfo, .. ) when called with their parameters. Note that a single call to RFC(..) will return function and a double call RFC(..)(param1, param2, .. ) where param1, param2 are parameters of remote function only will call the remote function.|
desc='''This method is used to call client functions from server script using streams as medium.''' Calling RFC will returns function which can be used to call remote functions of npcscripts( i.e. functions in npcscripts: StartRecordingPlayback, SendDeathInfo, .. ) when called with their parameters. Note that a single call to RFC(..) will return function and a double call RFC(..)(param1, param2, .. ) where param1, param2 are parameters of remote function only will call the remote function.|
params=<syntaxhighlight lang="lua">(npcid, [string]funcname)</syntaxhighlight>
params=<syntaxhighlight lang="lua">(npcid, [string]funcname or [userdata])</syntaxhighlight>
<poem>::npcid : The ID of the target npc on whose environment the function will be searched.
<poem>::npcid : The ID of the target npc on whose environment the function will be searched.
::funcname : The name of the remote function</poem>|
::funcname : The name of the remote function or userdata returned by [[F]]. (Assuming F is calling a function which will return a function which is our target function)</poem>|
example=
example=
<poem>Server Side</poem><source lang="lua">
<poem>Server Side</poem><source lang="lua">

Revision as of 18:11, 13 February 2023

This function was added in v1.6 beta and will not work on previous versions.

This function belongs to server scripts and not npcscripts.

The library LibRPC must be loaded with the npc for Remote Calls to work.

The second parameter of the type userdata was added in v1.6 beta2 and will not work in v1.6 beta


Description:
This method is used to call client functions from server script using streams as medium. Calling RFC will returns function which can be used to call remote functions of npcscripts( i.e. functions in npcscripts: StartRecordingPlayback, SendDeathInfo, .. ) when called with their parameters. Note that a single call to RFC(..) will return function and a double call RFC(..)(param1, param2, .. ) where param1, param2 are parameters of remote function only will call the remote function.


Parameters:

(npcid, [string]funcname or [userdata])

npcid : The ID of the target npc on whose environment the function will be searched.
funcname : The name of the remote function or userdata returned by F. (Assuming F is calling a function which will return a function which is our target function)


Return Values:
This will return a function object which can be used as if it is the remote function itself.(except of return values)


Example

Server Side

StartPlayback <- RFC(0, "StartRecordingPlayback"); //creates a function object locally. Not yet communicate with npc.
StartPlayback(1,"runtolake"); //will search and execute StartRecordingPlayback(1, "runtolake") on npcscript.(of NPC with ID 0 )

//You can also do this in one line
RFC(0,"print")("Hello how are you"); //will print the text: 'Hello how are you' on npc console(console can be shown by ShowNPCConsole() ) of npc with ID 0.


Supported parameter types of the closure(function) returned by RFC are:

Numbers/Integers
Float
String
bool true/false
Null null
Vector Vector(x,y,z)
Quaternion Quaternion(x,y,z,w)
Userdata returned by F (Function) F("print")(500)
See F
Array

The following parameter types are not supported:

Blob
Class Instances other than Vector or Quaternion