Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a description for SoundService.DefaultListenerLocation #868

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add a description for SoundService.DefaultListenerLocation #868

wants to merge 3 commits into from

Conversation

rbxphogen
Copy link
Contributor

@rbxphogen rbxphogen commented Oct 17, 2024 •
edited
Loading

Changes

Adds a description for SoundService.DefaultListenerLocation

Checks

By submitting your pull request for review, you agree to the following:

  • 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.
  • 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.
  • To the best of my knowledge, all proposed changes are accurate.

@rbxphogen
Add a description for SoundService.DefaultListenerLocation
677b37c 
Adds a description for SoundService.DefaultListenerLocation
@github-actions github-actions bot added the engine reference Changes the Engine API Reference documentation label Oct 17, 2024
matthewzhang-rbx
matthewzhang-rbx reviewed Oct 17, 2024
View reviewed changes
content/en-us/reference/engine/classes/SoundService.yaml
- an `Class.AudioListener` will be created and parented-to `Class.Workspace.CurrentCamera`
- an `Class.AudioDeviceOutput` will be created and parented-to `Class.SoundService`
- a `Class.Wire` will be created and parented-to the previously-created `Class.AudioListener`
- `Class.Wire.SourceInstance` will be set to the previously-created `Class.AudioListener`, and `Class.Wire.TargetInstance` will be set to the previously-created `Class.AudioDeviceOutput`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation supports nested lists, right? We could indent this one forward to put it under the previous line about the wire

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does that need special syntax? I'm not familiar

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm I would think you indent the bullet one more time but I don't know how legit that is

matthewzhang-rbx
matthewzhang-rbx reviewed Oct 17, 2024
View reviewed changes
content/en-us/reference/engine/classes/SoundService.yaml
- an `Class.AudioDeviceOutput` will be created and parented-to `Class.SoundService`
- a `Class.Wire` will be created and parented-to the previously-created `Class.AudioListener`
- `Class.Wire.SourceInstance` will be set to the previously-created `Class.AudioListener`, and `Class.Wire.TargetInstance` will be set to the previously-created `Class.AudioDeviceOutput`
- the previously-created `Class.Attachment` will be updated once-per-frame to face the same direction as `Class.Workspace.CurrentCamera`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could move this line to be indented under the earlier line about the Attachment

@rbxphogen @matthewzhang-rbx
Apply suggestions from code review
76a3032 
Co-authored-by: matthewzhang-rbx <[email protected]>
@IgnisRBX
Copy link
Contributor

Since this is controlled by a Enum.ListenerLocation, it's best to put a very brief description of this property here, then fill out the options on the Enum.ListenerLocation page.

@rbxphogen
Copy link
Contributor Author

Since this is controlled by a Enum.ListenerLocation, it's best to put a very brief description of this property here, then fill out the options on the Enum.ListenerLocation page.

Makes sense; I'll submit a followup for that page

@rbxphogen
Copy link
Contributor Author

@IgnisRBX I created a PR for those docs here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthewzhang-rbx matthewzhang-rbx matthewzhang-rbx left review comments

@fumminger fumminger fumminger approved these changes

@sofiaconmorales sofiaconmorales Awaiting requested review from sofiaconmorales

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
engine reference Changes the Engine API Reference documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rbxphogen @IgnisRBX @fumminger @matthewzhang-rbx