Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Wire

Connects one or more Instances to form a processing graph of their streams. At the moment, only audio streams are supported, but this may expand in the future.

Memory categoryInstances

Member index 5

HistoryMember
592Connected: bool
592SourceInstance: Instance
592SourceName: string
592TargetInstance: Instance
592TargetName: string
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: 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()
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

Wire connects one or more Instances to form a processing graph of their streams. Each Wire connects a source and target instance, and a source and target "pin" within each of those instances. Pins are string identifiers that select which stream is to be carried by the wire.

At the moment, only audio streams are supported, but this may expand in the future.

The following instances may be connected by Wires:

History 12

Members 5

Connected

TypeDefault
boolfalse

Denotes whether the Wire is connected, meaning its SourceInstance, TargetInstance, SourceName, and TargetName properties are all assigned, the connection is valid, and the connection does not result in a cyclic processing graph. Cyclic processing graphs are invalid since they can result in infinite computation; attempting to create one will log an error.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryConnections
Loaded/Savedfalse/true

History 2

Tags: [ReadOnly, NotReplicated]

SourceInstance

TypeDefault
Instance

The Instance producing a stream to be carried over the wire. At the moment, only audio streams are wirable.

Thread safetyReadSafe
CategoryConnections
Loaded/Savedtrue

History 2

SourceName

TypeDefault
stringOutput

The name of the pin on SourceInstance that is producing a stream. At the moment, various audio instances only have an Output pin, but this may expand in the future. The default value of this property is Output so it is not yet necessary to change.

Thread safetyReadSafe
CategoryConnections
Loaded/Savedtrue

History 2

TargetInstance

TypeDefault
Instance

The Instance intended to receive a stream from SourceInstance. Currently, only audio streams are wirable.

Thread safetyReadSafe
CategoryConnections
Loaded/Savedtrue

History 2

TargetName

TypeDefault
stringInput

The name of the pin on TargetInstance that is receiving a stream. At the moment, audio instances typically have an Input pin, but AudioCompressor has an additional Sidechain pin. This may expand in the future.

Thread safetyReadSafe
CategoryConnections
Loaded/Savedtrue

History 2

Settings