Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PluginConnectionService

This service is used by plugins to communicate with other instances of themselves running in other data models.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 3

HistoryMember
715CanHaveConnectionType(type: PluginConnectionTargetType): bool
715GetPluginConnectionsOfType(type: PluginConnectionTargetType): Array
715Connected(conn: PluginConnection)
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

This service is used by plugins to communicate with other instances of themselves running in other data models (e.g. a plugin in the Studio edit data model can communicate with the instance of that same plugin in the Studio playtest Server data model). Plugins can retrieve PluginConnection objects from this service, which provide an API for sending messages across the data model boundary. All access to this class is restricted to Plugin security. The command bar is not currently supported.

History 4

Members 3

CanHaveConnectionType

Parameters (1)
typePluginConnectionTargetType
Returns (1)
bool

Checks if the current data model can potentially have connections of a given PluginConnectionTargetType. Note that it is possible for this function to return true even if no such connections currently exist.

SecurityPluginSecurity
Thread safetyUnsafe

History 1

Connected

Parameters (1)
connPluginConnection

Fires just after a new PluginConnection successfully connects. Plugins may listen for this signal to learn when a new data model that they can communicate with becomes available.

Note: On startup, it is possible some PluginConnections already exist. Plugins should query PluginConnectionService:GetPluginConnectionsOfType() for each type they are interested in after connecting to this function.

SecurityPluginSecurity
Thread safetyUnsafe

History 1

GetPluginConnectionsOfType

Parameters (1)
typePluginConnectionTargetType
Returns (1)
Array

Returns a list of currently connected PluginConnection objects with the given connection type. Each PluginConnection from this list will initially have their Connected property set to true and correspond to a connected data model related to the current data model according to their PluginConnectionTargetType. For example, an edit data model may have PluginConnectionTargetType.Test connections to communicate with its ongoing playtest data models, and each test data model will have an PluginConnectionTargetType.Edit connection back to its edit data model.

SecurityPluginSecurity
Thread safetyUnsafe

History 1

Settings