Class JsonRpc

Namespace

Godot

Assembly

GodotSharp.dll

JSON-RPC is a standard which wraps a method call in a 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 Dictionary; you will have to convert between a Dictionary and Json with other functions.

[GodotClassName("JSONRPC")]
public class JsonRpc : GodotObject, IDisposable

Inheritance

object

GodotObject

JsonRpc

Implements

IDisposable

Inherited Members

GodotObject.NotificationPostinitialize

GodotObject.NotificationPredelete

GodotObject.NotificationExtensionReloaded

GodotObject.InstanceFromId(ulong)

GodotObject.IsInstanceIdValid(ulong)

GodotObject.IsInstanceValid(GodotObject)

GodotObject.WeakRef(GodotObject)

GodotObject.Dispose()

GodotObject.Dispose(bool)

GodotObject.ToString()

GodotObject.ToSignal(GodotObject, StringName)

GodotObject._Get(StringName)

GodotObject._GetPropertyList()

GodotObject._Notification(int)

GodotObject._PropertyCanRevert(StringName)

GodotObject._PropertyGetRevert(StringName)

GodotObject._Set(StringName, Variant)

GodotObject._ValidateProperty(Dictionary)

GodotObject.Free()

GodotObject.GetClass()

GodotObject.IsClass(string)

GodotObject.Set(StringName, Variant)

GodotObject.Get(StringName)

GodotObject.SetIndexed(NodePath, Variant)

GodotObject.GetIndexed(NodePath)

GodotObject.GetPropertyList()

GodotObject.GetMethodList()

GodotObject.PropertyCanRevert(StringName)

GodotObject.PropertyGetRevert(StringName)

GodotObject.Notification(int, bool)

GodotObject.GetInstanceId()

GodotObject.SetScript(Variant)

GodotObject.GetScript()

GodotObject.SetMeta(StringName, Variant)

GodotObject.RemoveMeta(StringName)

GodotObject.GetMeta(StringName, Variant)

GodotObject.HasMeta(StringName)

GodotObject.GetMetaList()

GodotObject.AddUserSignal(string, Array)

GodotObject.HasUserSignal(StringName)

GodotObject.EmitSignal(StringName, params Variant[])

GodotObject.Call(StringName, params Variant[])

GodotObject.CallDeferred(StringName, params Variant[])

GodotObject.SetDeferred(StringName, Variant)

GodotObject.Callv(StringName, Array)

GodotObject.HasMethod(StringName)

GodotObject.HasSignal(StringName)

GodotObject.GetSignalList()

GodotObject.GetSignalConnectionList(StringName)

GodotObject.GetIncomingConnections()

GodotObject.Connect(StringName, Callable, uint)

GodotObject.Disconnect(StringName, Callable)

GodotObject.IsConnected(StringName, Callable)

GodotObject.SetBlockSignals(bool)

GodotObject.IsBlockingSignals()

GodotObject.NotifyPropertyListChanged()

GodotObject.SetMessageTranslation(bool)

GodotObject.CanTranslateMessages()

GodotObject.Tr(StringName, StringName)

GodotObject.TrN(StringName, StringName, int, StringName)

GodotObject.IsQueuedForDeletion()

GodotObject.CancelFree()

GodotObject.NativeInstance

GodotObject.ScriptChanged

GodotObject.PropertyListChanged

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

JsonRpc()

public JsonRpc()

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

MakeNotification(string, Variant)

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.

public Dictionary MakeNotification(string method, Variant @params)

Parameters

method string

params Variant

Returns

Dictionary

MakeRequest(string, Variant, Variant)

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.

public Dictionary MakeRequest(string method, Variant @params, Variant id)

Parameters

method string

params Variant

id Variant

Returns

Dictionary

MakeResponse(Variant, Variant)

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.

public Dictionary MakeResponse(Variant result, Variant id)

Parameters

result Variant

id Variant

Returns

Dictionary

MakeResponseError(int, string, Variant)

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 the JsonRpc.ErrorCode constants.

- message: A custom message about this error.

- id: The request this error is a response to.

public Dictionary MakeResponseError(int code, string message, Variant id = default)

Parameters

code int

message string

id Variant

Returns

Dictionary

ProcessAction(Variant, bool)

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 ProcessAction(Variant, bool) on your subclass.

action: The action to be run, as a Dictionary in the form of a JSON-RPC request or notification.

public Variant ProcessAction(Variant action, bool recurse = false)

Parameters

action Variant

recurse bool

Returns

Variant

ProcessString(string)

public string ProcessString(string action)

Parameters

action string

Returns

string

SetScope(string, GodotObject)

public void SetScope(string scope, GodotObject target)

Parameters

scope string

target GodotObject