Skip to content

Commit

Permalink
Update Functions-Runtime-Setup.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JujuAdams committed Sep 18, 2024
1 parent e349f6e commit 756689e
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions docs/6.1/Functions-Runtime-Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,23 +160,26 @@ No example provided.

## `VinylSetupMix`

`VinylSetupMix(mixName, [baseGain=1], [membersLoop], [membersDuckOn], [metadata])`
`VinylSetupMix(mixName, [baseGain=1], [membersLoop], [membersDuckOn], [membersEmitterAlias], [metadata])`

<!-- tabs:start -->

#### **Description**

*Returns:* N/A (`undefined`)

|Name |Datatype|Purpose |
|-----------------|--------|----------------------------------------------------------------|
|`mixName` |string |Name of the mix |
|`[baseGain]` |number |Optional, defaults to 1. Base gain for the mix |
|`[membersLoop]` |boolean |Optional. Whether members played on this mix default to looping |
|`[membersDuckOn]`|string |Optional. Which ducker to use by default for members of this mix|
|`[metadata]` |any |Optional. Metadata to attach to the mix |
|Name |Datatype|Purpose |
|-----------------------|--------|----------------------------------------------------------------------------|
|`mixName` |string |Name of the mix |
|`[baseGain]` |number |Optional, defaults to 1. Base gain for the mix |
|`[membersLoop]` |boolean |Optional. Whether members played on this mix default to looping |
|`[membersDuckOn]` |string |Optional. Which ducker to use by default for members of this mix |
|`[membersEmitterAlias]`|string |Optional. Which registered emitter to use by default for members of this mix|
|`[metadata]` |any |Optional. Metadata to attach to the mix |

Sets up a mix that can be used to control multiple sounds, patterns, and voices all at the same time. Mixes should be defined before sounds and patterns.
Sets up a mix that can be used to control multiple sounds, patterns, and voices all at the same time.

!> Mixes must be defined before sounds and patterns.

#### **Example**

Expand Down

0 comments on commit 756689e

Please sign in to comment.