[https://www.jsonrpc.org/](JSON-RPC) is a standard which wraps a method call in a godot.JSON
object. The object has a particular structure and identifies which method is called, the parameters to that function, and carries an ID to keep track of responses. This class implements that standard on top of godot.Collections_Dictionary
; you will have to convert between a godot.Collections_Dictionary
and godot.JSON
with other functions.
Constructor
Methods
makeNotification(method:String, params:Dynamic):Dictionary
Returns a dictionary in the form of a JSON-RPC notification. Notifications are one-shot messages which do not expect a response.
-
method
: Name of the method being called. -
params
: An array or dictionary of parameters being passed to the method.
makeRequest(method:String, params:Dynamic, id:Dynamic):Dictionary
Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a server with the expectation of a response. The ID field is used for the server to specify which exact request it is responding to.
-
method
: Name of the method being called. -
params
: An array or dictionary of parameters being passed to the method. -
id
: Uniquely identifies this request. The server is expected to send a response with the same ID.
makeResponse(result:Dynamic, id:Dynamic):Dictionary
When a server has received and processed a request, it is expected to send a response. If you did not want a response then you need to have sent a Notification instead.
-
result
: The return value of the function which was called. -
id
: The ID of the request this response is targeted to.
makeResponseError(code:Int, message:String, ?id:Dynamic):Dictionary
Creates a response which indicates a previous reply has failed in some way.
-
code
: The error code corresponding to what kind of error this is. See thegodot.JSONRPC_ErrorCode
constants. -
message
: A custom message about this error. -
id
: The request this error is a response to.
processAction(action:Dynamic, ?recurse:Bool):Dynamic
Given a Dictionary which takes the form of a JSON-RPC request: unpack the request and run it. Methods are resolved by looking at the field called "method" and looking for an equivalently named function in the JSONRPC object. If one is found that method is called.
To add new supported methods extend the JSONRPC class and call godot.JSONRPC.processAction
on your subclass.
action
: The action to be run, as a Dictionary in the form of a JSON-RPC request or notification.