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.

Member index 6

HistoryMember
726Connected: bool
726SourceInstance: Instance
726SourceName: string
726TargetInstance: Instance
726TargetName: string
660RenameToDefault(): null
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(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 18

Members 6

Connected

TypeDefault
bool

Denotes whether the Wire is connected, meaning its SourceInstance, TargetInstance, SourceName, and TargetName properties are all assigned, the corresponding SourceName and TargetName pins exist on SourceInstance and TargetInstance respectively, and the connection does not result in a cyclic processing graph.

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.

History 3

Tags: [ReadOnly, NotReplicated]

RenameToDefault

Parameters (0)
No parameters.
Returns (1)
null

History 1

SourceInstance

TypeDefault
Instance

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

History 3

SourceName

TypeDefault
string

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.

History 3

TargetInstance

TypeDefault
Instance

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

History 3

TargetName

TypeDefault
string

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.

History 3

Settings