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

Update Functions-(Global-Behaviours).md

main
Juju Adams 2021-11-02 22:08:01 +00:00
parent c7a5269b26
commit e82fcd593e
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/latest/Functions-(Global-Behaviours).md
View File

@ -4,9 +4,11 @@
|Argument|Datatype|Description | |Argument|Datatype|Description |
|--------|--------|------------------------------------------------------| |--------|--------|------------------------------------------------------|
|`x` |number | | |`x` |number |x-position of the player's "head" in the scene |
|`y` |number | | |`y` |number |y-position of the player's "head" in the scene |
|`z` |number | | |`z` |number |z-position of the player's "head" in the scene |
Sets the "head" position for the player in 3D space. This affects panning and volume for 3D audio.
   
@ -15,10 +17,12 @@
**Returns:** N/A (`undefined`) **Returns:** N/A (`undefined`)
|Argument |Datatype|Description | |Argument |Datatype|Description |
|-----------|--------|------------------------------------------------------| |-----------|--------|---------------------------------------------------------------|
|`xVelocity`|number | | |`xVelocity`|number |x-component of the velocity of the player's "head" in the scene|
|`yVelocity`|number | | |`yVelocity`|number |y-component of the velocity of the player's "head" in the scene|
|`zVelocity`|number | | |`zVelocity`|number |z-component of the velocity of the player's "head" in the scene|
Sets the velocity for the player in 3D space. This affects the pitch of 3D audio via the [Doppler effect](https://en.wikipedia.org/wiki/Doppler_effect).
   
@ -30,6 +34,8 @@
|--------|--------|------------------------------------------------------| |--------|--------|------------------------------------------------------|
|None | | | |None | | |
Pauses all sound instances, which is useful for stopping audio when the game loses focus. This function sets a separate pause state to the one set by [`FAudio_SoundInstance_Pause`](Functions-(Sound-Instances)?id=_soundinstance_pausesoundinstanceid).
   
## `~_ResumeAll()` ## `~_ResumeAll()`
@ -40,6 +46,8 @@
|--------|--------|------------------------------------------------------| |--------|--------|------------------------------------------------------|
|None | | | |None | | |
Resumes all sound instances paused by `FAudio_PauseAll()`.
   
## `~_StopAll()` ## `~_StopAll()`
@ -49,3 +57,5 @@
|Argument|Datatype|Description | |Argument|Datatype|Description |
|--------|--------|------------------------------------------------------| |--------|--------|------------------------------------------------------|
|None | | | |None | | |
Stops all currently playing sound instances.