nik
/
FAudioGMS-Docs
forked from MoonsideGames/FAudioGMS-Docs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

some minor clarifications

main
cosmonaut 2021-11-02 16:42:12 -07:00
parent 80d36bd87b
commit 82e445d83c
2 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/latest/Functions-(Essentials).md
View File

@ -32,3 +32,5 @@
|Argument|Datatype|Description| |Argument|Datatype|Description|
|--------|--------|-----------| |--------|--------|-----------|
|None | | | |None | | |
This will automatically free all memory allocated by FAudioGMS. All FAudioGMS-related IDs are invalid after this function is called. Calling any FAudioGMS function after `FAudioGMS_Destroy()` is called will do nothing.

16
docs/latest/Functions-(Sound-Instances).md
View File

@ -9,7 +9,9 @@
|`soundInstanceID`|number |Sound instance to target | |`soundInstanceID`|number |Sound instance to target |
|`loop` |boolean |Whether the sound instance should replay from the start when it finishes playing| |`loop` |boolean |Whether the sound instance should replay from the start when it finishes playing|
Plays the given sound instance. If the sound instance is set to *not* loop (`loop` is `false`) then `FAudio_SoundInstance_DestroyWhenFinished()` will be called automatically for the sound instance. Plays the given sound instance.
?> Note that once playback is complete the sound instance will not automatically be destroyed unless FAudioGMS_SoundInstance_DestroyWhenFinished is used.
   
@ -25,18 +27,6 @@ Pauses playback of a sound instance. It can later be resumed by calling `FAudio_
   
## `~_SoundInstance_Resume(soundInstanceID)`
**Returns:** N/A (`undefined`)
|Argument |Datatype|Description |
|-----------------|--------|------------------------------------------------------|
|`soundInstanceID`|number |Sound instance to target |
Resumes playback of a sound instance that has been paused by `FAudio_SoundInstance_Pause()`. If the sound instance in question hasn't been paused then this function does nothing.
 
## `~_SoundInstance_Stop(soundInstanceID)` ## `~_SoundInstance_Stop(soundInstanceID)`
**Returns:** N/A (`undefined`) **Returns:** N/A (`undefined`)