Updated Pull request targetting [Base] #20
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the `HowTo_ChangePitchAndVolume.md` file to enhance readability and clarity of the code and instructions. Changes include bold formatting for method and class names, added explanations for pitch and volume concepts, `using` statements, fields for sound effect and its properties, and modifications to the `Game.LoadContent` method. Also included notes on sound looping, state checking, and usage of `MathHelper.Clamp` method. Extended example added for key press detection and sound effect adjustment. Updated the copyright year to 2024. The subproject commit in MonoGame has been updated to `81ed391a4d0fd81e3ee4bfe2492ad9a0e7f4cfc5`.
Updated the heading "An extended example" to "An Extended Example" for improved readability and consistency in capitalization. Added a new method "IsKeyPressed" under the "Game.Draw" method to check if a specified key is pressed, returning a boolean value.
…ub.io into documentation-reviews
…ub.io into documentation-reviews
…e7777/docs.monogame.github.io into documentation-reviews
SimonDarksideJ
commented
May 29, 2024
|
|
||
| 2. In the [Game.LoadContent](xref:Microsoft.Xna.Framework.Game.LoadContent) method, set the **SoundEffectInstance** object to the return value of [SoundEffect.CreateInstance](xref:Microsoft.Xna.Framework.Audio.SoundEffect.CreateInstance). | ||
|
|
||
| 3. In the **[Game.LoadContent](xref:Microsoft.Xna.Framework.Game.LoadContent)** method, set the **SoundEffectInstance** object to the return value of **[SoundEffect.CreateInstance](xref:Microsoft.Xna.Framework.Audio.SoundEffect.CreateInstance)**. We also optionally define a variable **soundFile** to store the location of the sound file being used with the **[TitleContainer.OpenStream](xref:Microsoft.Xna.Framework.TitleContainer#Microsoft_Xna_Framework_TitleContainer_OpenStream_System_String_)** method, which is accessed with the **using** keyword, and include a field member variable called **soundEffect**, to hold the stream. |
There was a problem hiding this comment.
The text does not match the code below, consider revising
| > [!NOTE] | ||
| > Usings are declared at the top of the file to ensure that the necessary namespaces are available to the class. The fields are declared at the top of the class to ensure that they are accessible to all methods in the class. | ||
|
|
||
| 2. In the [Game.LoadContent](xref:Microsoft.Xna.Framework.Game.LoadContent) method, set the **SoundEffectInstance** object to the return value of [SoundEffect.CreateInstance](xref:Microsoft.Xna.Framework.Audio.SoundEffect.CreateInstance). |
There was a problem hiding this comment.
I updated SoundEffectInstance to SoundEffectInstance to match the styling used elsewhere in the doc. Please ensure to use consistent styling when referring to elements or classes.
| soundEffect = SoundEffect.FromStream(soundfile); | ||
| soundInstance = soundEffect.CreateInstance(); | ||
| ``` | ||
|
|
||
| 3. Adjust the sound to the desired level using the [SoundEffectInstance.Pitch](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance.Pitch) and [SoundEffectInstance.Volume](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance.Volume) properties. | ||
| 4. Adjust the sound to the desired level using the [SoundEffectInstance.Pitch](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance.Pitch) and [SoundEffectInstance.Volume](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance.Volume) properties. |
There was a problem hiding this comment.
Text does not match the code, I suggest the code needs to change here.
|
|
||
| ## An Extended Example | ||
|
|
||
| 1. Below the **[Game.Draw](xref:Microsoft.Xna.Framework.Game#Microsoft_Xna_Framework_Game_Draw_Microsoft_Xna_Framework_GameTime_)** method, create a new method called **IsKeyPressed**, which will check if a specified key is pressed and return a boolean value of true if it has been pressed. |
There was a problem hiding this comment.
I fixed the API references, as they work differently to the original XNA interpreter.
Note the change from
(xref:Microsoft.Xna.Framework.Game.Draw)
To
(xref:Microsoft.Xna.Framework.Game#Microsoft_Xna_Framework_Game_Draw_Microsoft_Xna_Framework_GameTime_)
Browse the API docs on the website to get the Method links
There was a problem hiding this comment.
There was a problem hiding this comment.
I need a quick hand at how to make the # extension not done web anchors in 15 years... and was unable to find that anchor...
SimonDarksideJ
pushed a commit
to SimonDarksideJ/docs.monogame.github.io
that referenced
this pull request
May 3, 2025
Chapter 18: Texture Sampling
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
HowTo_ChangePitchAndVolume.mdfile to enhance readability and clarity of the code and instructions.usingstatements, fields for sound effect and its properties, and modifications to theGame.LoadContentmethod.MathHelper.Clampmethod.81ed391a4d0fd81e3ee4bfe2492ad9a0e7f4cfc5.