Class
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.
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:
AudioAnalyzerAudioChannelMixerAudioChannelSplitterAudioChorusAudioCompressorAudioDeviceInputAudioDeviceOutputAudioDistortionAudioEchoAudioEmitterAudioEqualizerAudioFaderAudioFilterAudioFlangerAudioGateAudioLimiterAudioListenerAudioPitchShifterAudioPlayerAudioRecorderAudioReverbAudioSpeechToTextAudioTextToSpeechAudioTremoloVideoPlayerVideoDisplay
Properties 5#
Connectedboolean | Denotes whether the Wire is carrying a stream of data.ReadSafeReadOnlyNotReplicated |
SourceInstanceInstance | The Instance producing a stream to be carried over the wire.ReadSafe |
SourceNamestring | The name of the pin on SourceInstance that is
producing a stream.ReadSafe |
TargetInstanceInstance | The Instance to receive a stream from
SourceInstance.ReadSafe |
TargetNamestring | The name of the pin on TargetInstance that is
receiving a stream.ReadSafe |
Connected: boolean#
ReadOnlyNotReplicatedReadSafe
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.
SourceInstance: Instance#
ReadSafe
The Instance producing a stream to be carried over the wire. At
the moment, only audio streams are wirable.
SourceName: string#
ReadSafe
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.
TargetInstance: Instance#
ReadSafe
The Instance intended to receive a stream from
SourceInstance. Currently, only audio streams
are wirable.
TargetName: string#
ReadSafe
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.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild