PluginConnection¶
Encapsulates a connection between the current data model and another for plugin communication.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
Description¶
Studio plugins run in each Studio data model that the user opens, including
both edit and playtest data models. PluginConnection objects allow these
instances of the same plugin to communicate across data model boundaries.
Messages sent by PluginConnection.SendMessage() will be received in
the remote data model via the callback the same plugin registers with
PluginConnection.BindToMessage(). Each PluginConnection object can
both send and receive messages while connected, and messages will be received
reliably and in order unless the connection drops (e.g. due to the remote data
model shutting down) before their receipt.
Note that although multiple plugins may share the same PluginConnection
object, they each have their own internal connection; each plugin will receive
only its own messages in its callback to BindToMessage(), even if other
plugins call SendMessage().
Inheritance¶
Object → PluginConnection
Properties¶
| Member | Signature | Summary |
|---|---|---|
Connected |
Connected: bool |
Whether this PluginConnection object is still connected. |
GroupId |
GroupId: string |
— |
TargetId |
TargetId: string |
A unique ID for the target data model. |
Type |
Type: PluginConnectionTargetType |
This PluginConnectionTargetType describes the relationship of the target data model to the current one. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
BindToMessage |
PluginConnection:BindToMessage(callbackFunction: Function): RBXScriptConnection |
Binds a callback to this PluginConnection to receive messages from SendMessage(). |
SendMessage |
PluginConnection:SendMessage(message: Variant): null |
Sends a payload to the remote data model. |
Roblox reference: PluginConnection
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.