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

Manual+In-Game: Feather/Manual info for audio_destroy_stream() is incorrect, and the function does not return its intended value correctly #4415

Closed
1 of 2 tasks
toby-yoyo opened this issue Jan 19, 2024 · 4 comments
Closed
1 of 2 tasks

Manual+In-Game: Feather/Manual info for audio_destroy_stream() is incorrect, and the function does not return its intended value correctly #4415

toby-yoyo opened this issue Jan 19, 2024 · 4 comments
Assignees
@toby-yoyo @YYBartT
Labels
docs-bug GameMaker Manual Bugs runner-bug In-game bugs with the "GameMaker Studio 2" runtimes
Milestone
2024.2

Comments

@toby-yoyo
Copy link

toby-yoyo commented Jan 19, 2024 •
edited
Loading

Description

There are several things wrong with audio_destroy_stream:

  • Feather/The manual suggests that function takes a string as an argument, when it actually takes a sound asset.
  • Feather/The manual suggests that the return value of the function is undefined when it is actually a real.
  • In the runner, the value type is set as int32. This means the function always returns '0'.
  • Feather/The manual should reflect that the value '1' is returned if the stream was successfully destroyed, and '-1' if it wasn't.

Expected Change

  • The return value of the function at runtime should be fixed (as above).
  • Feather/The manual should reflect the correct argument and return value type.

Steps To Reproduce

  1. Open the attached project: ghb-4415.zip
  2. Open the Create event of obj_run.
  3. Observe that feather complains about a sound asset being passed to audio_destroy_stream.
  4. Observe that feather suggests that the return type of audio_destroy_stream is undefined.
  5. Run the project on Windows and observe that the returned value is 0 regardless of whether the stream was successfully destroyed.

How reliably can you recreate this issue using your steps above?

Always

Which version of GameMaker are you reporting this issue for?

2023.11.1 (Monthly), Beta IDE v2024.200.0.461 Runtime v2024.200.0.485

Which platform(s) are you seeing the problem on?

Windows

Contact Us Package Attached?

  • I have attached my Contact Us Package

Sample Project Added?

  • I have included a small sample project
@toby-yoyo toby-yoyo added runner-bug In-game bugs with the "GameMaker Studio 2" runtimes docs-bug GameMaker Manual Bugs labels Jan 19, 2024
@toby-yoyo toby-yoyo mentioned this issue Jan 19, 2024
Closed
@toby-yoyo toby-yoyo changed the title [Manual+In-Game]: Feather/Manual info for audio_destroy_stream() is incorrect, and the function does not return its intended value correctly Manual+In-Game: Feather/Manual info for audio_destroy_stream() is incorrect, and the function does not return its intended value correctly Jan 19, 2024
YYBartT added a commit to YoYoGames/GameMaker-Manual that referenced this issue Jan 19, 2024
@YYBartT
[General]Manual+In-Game: Feather/Manual info for audio_destroy_stream…
4fa0ae8 
…() is incorrect, and the function does not return its intended value correctly

YoYoGames/GameMaker-Bugs#4415
* Changed the parameter: renamed to "sound", type changed to Sound Asset, return value to Real (int32 isn't a type we've documented so far in the manual)
* Tiny other changes to the page
@YYBartT YYBartT self-assigned this Jan 19, 2024
@YYBartT
Copy link

YYBartT commented Jan 19, 2024

Manual page updated (changed the parameter name to sound). Feather change is still todo.

@toby-yoyo toby-yoyo self-assigned this Jan 19, 2024
@stuckie stuckie added this to the 2024.2 milestone Jan 22, 2024
@toby-yoyo toby-yoyo moved this from Todo to In Progress in Team Workload Jan 22, 2024
This was referenced Jan 22, 2024
Merged
Closed
@toby-yoyo
Copy link
Author

Updated runtime behaviour and feather info:

  • Argument is now named sound and is of type Asset.GMSound.
  • Return value is now of type Real and will be 1 if successful and -1 if not.

Note:

@github-project-automation github-project-automation bot moved this from In Progress to Done in Team Workload Jan 23, 2024
@YYBartT YYBartT moved this from Done to Ready for QA in Team Workload Jan 23, 2024
@cameron-home
Copy link

Verified fixed for HTML5 in IDE v2024.200.0.472 Runtime v2024.200.0.488. To be verified in Windows in next beta build.

@cameron-home
Copy link

And now verified fixed in Windows and in manual on Bart's branch using IDE v2024.200.0.476 Runtime v2024.200.0.491

@cameron-home cameron-home moved this from Ready for QA to Verified in Team Workload Jan 31, 2024
@YYBartT YYBartT mentioned this issue Feb 6, 2024
Merged
gurpreetsinghmatharoo added a commit to YoYoGames/GameMaker-Manual that referenced this issue Feb 13, 2024
@gurpreetsinghmatharoo
Merge branch 'develop' into develop.gurpreet
aacb541 
* develop:
  [Feature] Review for PR #88
  [General] Fixed toc when-closed arrow icon, needed rotation
  [General] Added file for ToC when-closed arrow
  [General] added css appends for index and glossary colours
  [Feature] Sequence Audio FX Parameters review
  [General]variable_clone() doesn't copy script refs in arrays correctly YoYoGames/GameMaker-Bugs#4548 * Added an additional note to mention you cannot clone built-in structs
  [Feature]Audio FX Parameter Tracks YoYoGames/GameMaker-Bugs#3162 * Added a new page "Sound in Sequences" under "The Sequence Editor":   * Overview image, ways in which to add sounds, details on emitters, audio effects and the Inspector   * Reordering audio effects in the Track Panel   * Short section on audio emitters' positions in sequence instances (i.e. the sequence instance's transform is added to the emitter's position)   * Added GIFs & videos to make things clearer * "The Track Panel" page:   * Listed audio effects under "Adding Parameter Tracks" * "The Sequence Instance Struct" page:   * Added soundIndex property under activeTracks, which refers to the sound *instance* currently being played * "The Track Struct" page:   * Listed all audio effect track parameter names under "Name" * Replaced all occurrences of maximum number of effect slots value of 8 with a RH variable * Some typo fixes here and there, replaced hyperlinks with cross-references, names with variables, etc.
  [General]Add note to for page that explains multiple variable assignment using var
  [Feature]Add vertex_submit_ext which takes a known amount of Vertexes YoYoGames/GameMaker-Bugs#2754 * Provided some details on frozen vertex buffers (reside in VRAM) * Consistency between vertex_submit & vertex_submit_ext function pages * Moved "surface must exist" warning note to snippet and inserted that on the function pages * Added a full description for the second example on the vertex_submit_ext page, fixed the modulo calculation so the max number will include the final vertex All done
  [Feature]Vertex Buffer Update Functions YoYoGames/GameMaker-Bugs#3163 * Added function page using script & added to ToC, updated links * Added most page contents, examples still to review
  [Feature]Debugger: [Mac IDE] Unable to use F11 to 'Step into function call' as it is overridden by the system hotkey default YoYoGames/GameMaker-Bugs#2337 * Manually added to the Shortcuts page, it will be added automatically with the next export from the shortcuts
  [General]In-Game: get_string_async() causes games to come out of fullscreen, minimised and paused YoYoGames/GameMaker-Bugs#2255 * Added a note to the Dialog page, explaining that you can use borderless fullscreen if you want to use these functions * Moved notes on the async function pages to a snippet and inserted that * Some other visual changes on the pages
  [Feature]Included Files Refresh Button YoYoGames/GameMaker-Bugs#2729 * Updated screenshots on page, added an icon image for the Refresh button * Added a line about the button
  [Feature]Textures that are resized to fit a texture page size end up on a texture page of a smaller size YoYoGames/GameMaker-Bugs#4386 * Updated screenshot & removed list items for actual width & height on The Debug Overlay page
  [Feature]String Literal Hash Optimization YoYoGames/GameMaker-Bugs#2804 YoYoGames/GameMaker-Bugs#2821 * Added a note under "Struct Functions" on the Variable Functions page
  [General]Manual+In-Game: Feather/Manual info for audio_destroy_stream() is incorrect, and the function does not return its intended value correctly YoYoGames/GameMaker-Bugs#4415 * Changed the parameter: renamed to "sound", type changed to Sound Asset, return value to Real (int32 isn't a type we've documented so far in the manual) * Tiny other changes to the page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@toby-yoyo toby-yoyo

@YYBartT YYBartT

Labels
docs-bug GameMaker Manual Bugs runner-bug In-game bugs with the "GameMaker Studio 2" runtimes
Projects
Team Workload
Archived in project
Milestone
2024.2
Development

No branches or pull requests
4 participants
@stuckie @toby-yoyo @YYBartT @cameron-home