diff --git a/docs/latest/Functions-(Global-Behaviours).md b/docs/latest/Functions-(Global-Behaviours).md index 1c72cce..787ef6a 100644 --- a/docs/latest/Functions-(Global-Behaviours).md +++ b/docs/latest/Functions-(Global-Behaviours).md @@ -4,9 +4,11 @@ |Argument|Datatype|Description | |--------|--------|------------------------------------------------------| -|`x` |number | | -|`y` |number | | -|`z` |number | | +|`x` |number |x-position of the player's "head" in the scene | +|`y` |number |y-position of the player's "head" in the scene | +|`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.   @@ -14,11 +16,13 @@ **Returns:** N/A (`undefined`) -|Argument |Datatype|Description | -|-----------|--------|------------------------------------------------------| -|`xVelocity`|number | | -|`yVelocity`|number | | -|`zVelocity`|number | | +|Argument |Datatype|Description | +|-----------|--------|---------------------------------------------------------------| +|`xVelocity`|number |x-component of the velocity of the player's "head" in the scene| +|`yVelocity`|number |y-component of the velocity of the player's "head" in the scene| +|`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 | | | +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()` @@ -40,6 +46,8 @@ |--------|--------|------------------------------------------------------| |None | | | +Resumes all sound instances paused by `FAudio_PauseAll()`. +   ## `~_StopAll()` @@ -48,4 +56,6 @@ |Argument|Datatype|Description | |--------|--------|------------------------------------------------------| -|None | | | \ No newline at end of file +|None | | | + +Stops all currently playing sound instances. \ No newline at end of file