Skip to content

Commit d2dabfd

Browse files
rbxphogenIgnisRBX
andauthored
Update ListenerLocation.yaml (#883)
## Changes Update ListenerLocation.yaml to describe each option the enum provides ## Checks By submitting your pull request for review, you agree to the following: - [x] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [x] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [x] To the best of my knowledge, all proposed changes are accurate. --------- Co-authored-by: IgnisRBX <[email protected]>
1 parent 6f7faa8 commit d2dabfd

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed
Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
11
name: ListenerLocation
22
type: enum
33
summary: ''
4-
description: ''
4+
description: |
5+
Provides a script-free and configuration-free way to spawn an `Class.AudioListener` by default. Determines where, if anywhere, a default `Class.AudioListener` should go.
56
code_samples: []
67
tags: []
78
deprecation_message: ''
89
items:
910
- name: Default
10-
summary: ''
11+
summary: |
12+
An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera` in experiences that enable voice chat.
1113
value: 0
1214
tags: []
1315
deprecation_message: ''
1416
- name: None
15-
summary: ''
17+
summary: |
18+
No `Class.AudioListener|AudioListeners` will be spawned by default.
1619
value: 1
1720
tags: []
1821
deprecation_message: ''
1922
- name: Character
20-
summary: ''
23+
summary: |
24+
An `Class.AudioListener` will be created and attached to the local player's
25+
`Class.Player.Character`.
2126
value: 2
2227
tags: []
2328
deprecation_message: ''
2429
- name: Camera
25-
summary: ''
30+
summary: |
31+
An `Class.AudioListener` will be created and parented to `Class.Workspace.CurrentCamera`.
2632
value: 3
2733
tags: []
2834
deprecation_message: ''

0 commit comments

Comments
 (0)