From 5614071252da9866a94b61fd8b3aee571b618ed4 Mon Sep 17 00:00:00 2001 From: Juju Adams Date: Tue, 2 Nov 2021 21:41:53 +0000 Subject: [PATCH] Experiment with shortened function names --- docs/latest/Function-Index.md | 70 +++++++++++----------- docs/latest/Functions-(Sound-Instances).md | 40 ++++++------- 2 files changed, 55 insertions(+), 55 deletions(-) diff --git a/docs/latest/Function-Index.md b/docs/latest/Function-Index.md index ad19026..148bcc8 100644 --- a/docs/latest/Function-Index.md +++ b/docs/latest/Function-Index.md @@ -2,38 +2,38 @@ !> `FAudioGMS_Init()` and `FAudioGMS_Update()` are absolutely essential to FAudio playback. You should run `FAudioGMS_Init()` at the start of your game (usually on boot) and `FAudioGMS_Update()` should be run once every frame, usually in the Step event of a persistent instance. -- [`FAudioGMS_Init(spatialDistanceScale, timestep)`](Functions-(Essentials)?id=faudiogms_initspatialdistancescale-timestep) -- [`FAudioGMS_Update()`](Functions-(Essentials)?id=faudiogms_update) -- [`FAudioGMS_Destroy()`](Functions-(Essentials)?id=faudiogms_destroy) +- [`FAudioGMS_Init(spatialDistanceScale, timestep)`](Functions-(Essentials)?id=_initspatialdistancescale-timestep) +- [`FAudioGMS_Update()`](Functions-(Essentials)?id=_update) +- [`FAudioGMS_Destroy()`](Functions-(Essentials)?id=_destroy)   ## [Loading Sound Assets](Functions-(Loading-Sound-Assets)) -- [`FAudioGMS_StaticSound_LoadWAV(filePath)`](Functions-(Loading-Sound-Assets)?id=faudiogms_staticsound_loadwavfilepath) -- [`FAudioGMS_StaticSound_CreateSoundInstance(staticSoundID)`](Functions-(Loading-Sound-Assets)?id=faudiogms_staticsound_createsoundinstance) -- [`FAudioGMS_StaticSound_Destroy(staticSoundID)`](Functions-(Loading-Sound-Assets)?id=faudiogms_staticsound_destroystaticsoundid) -- [`FAudioGMS_StreamingSound_LoadOGG(filePath)`](Functions-(Loading-Sound-Assets)?id=faudiogms_streamingsound_loadoggfilepath) +- [`FAudioGMS_StaticSound_LoadWAV(filePath)`](Functions-(Loading-Sound-Assets)?id=_staticsound_loadwavfilepath) +- [`FAudioGMS_StaticSound_CreateSoundInstance(staticSoundID)`](Functions-(Loading-Sound-Assets)?id=_staticsound_createsoundinstance) +- [`FAudioGMS_StaticSound_Destroy(staticSoundID)`](Functions-(Loading-Sound-Assets)?id=_staticsound_destroystaticsoundid) +- [`FAudioGMS_StreamingSound_LoadOGG(filePath)`](Functions-(Loading-Sound-Assets)?id=_streamingsound_loadoggfilepath)   ## [Sound Instances](Functions-(Sound-Instances)) -- [`FAudioGMS_SoundInstance_Play(soundInstanceID, loop)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_playsoundinstanceid-loop) -- [`FAudioGMS_SoundInstance_Pause(soundInstanceID)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_pausesoundinstanceid) -- [`FAudioGMS_SoundInstance_Stop(soundInstanceID)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_stopsoundinstanceid) -- [`FAudioGMS_SoundInstance_Destroy(soundInstanceID)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_destroysoundinstanceid) -- [`FAudioGMS_SoundInstance_DestroyWhenFinished(soundInstanceID)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_destroywhenfinishedsoundinstanceid) -- [`FAudioGMS_SoundInstance_SetPan(soundInstanceID, pan)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setpansoundinstanceid-pan) -- [`FAudioGMS_SoundInstance_SetPitch(soundInstanceID, pitch)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setpitchsoundinstanceid-pitch) -- [`FAudioGMS_SoundInstance_SetVolume(soundInstanceID, volume)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setvolumesoundinstanceid-volume) -- [`FAudioGMS_SoundInstance_Set3DPosition(soundInstanceID, x, y, z)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_set3dpositionsoundinstanceid-x-y-z) -- [`FAudioGMS_SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_set3dvelocitysoundinstanceid-xvelocity-yvelocity-zvelocity) -- [`FAudioGMS_SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_settrackpositioninsecondssoundinstanceid-trackpositioninseconds) -- [`FAudioGMS_SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setvolumeovertimesoundinstanceid-volume-milliseconds) -- [`FAudioGMS_SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_setlowpassfiltersoundinstanceid-lowpassfilter-q) -- [`FAudioGMS_SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_sethighpassfiltersoundinstanceid-lowpassfilter-q) -- [`FAudioGMS_SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)`](Functions-(Sound-Instances)?id=faudiogms_soundinstance_sethighpassfiltersoundinstanceid-highpassfilter-q) +- [`FAudioGMS_SoundInstance_Play(soundInstanceID, loop)`](Functions-(Sound-Instances)?id=_soundinstance_playsoundinstanceid-loop) +- [`FAudioGMS_SoundInstance_Pause(soundInstanceID)`](Functions-(Sound-Instances)?id=_soundinstance_pausesoundinstanceid) +- [`FAudioGMS_SoundInstance_Stop(soundInstanceID)`](Functions-(Sound-Instances)?id=_soundinstance_stopsoundinstanceid) +- [`FAudioGMS_SoundInstance_Destroy(soundInstanceID)`](Functions-(Sound-Instances)?id=_soundinstance_destroysoundinstanceid) +- [`FAudioGMS_SoundInstance_DestroyWhenFinished(soundInstanceID)`](Functions-(Sound-Instances)?id=_soundinstance_destroywhenfinishedsoundinstanceid) +- [`FAudioGMS_SoundInstance_SetPan(soundInstanceID, pan)`](Functions-(Sound-Instances)?id=_soundinstance_setpansoundinstanceid-pan) +- [`FAudioGMS_SoundInstance_SetPitch(soundInstanceID, pitch)`](Functions-(Sound-Instances)?id=_soundinstance_setpitchsoundinstanceid-pitch) +- [`FAudioGMS_SoundInstance_SetVolume(soundInstanceID, volume)`](Functions-(Sound-Instances)?id=_soundinstance_setvolumesoundinstanceid-volume) +- [`FAudioGMS_SoundInstance_Set3DPosition(soundInstanceID, x, y, z)`](Functions-(Sound-Instances)?id=_soundinstance_set3dpositionsoundinstanceid-x-y-z) +- [`FAudioGMS_SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)`](Functions-(Sound-Instances)?id=_soundinstance_set3dvelocitysoundinstanceid-xvelocity-yvelocity-zvelocity) +- [`FAudioGMS_SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)`](Functions-(Sound-Instances)?id=_soundinstance_settrackpositioninsecondssoundinstanceid-trackpositioninseconds) +- [`FAudioGMS_SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)`](Functions-(Sound-Instances)?id=_soundinstance_setvolumeovertimesoundinstanceid-volume-milliseconds) +- [`FAudioGMS_SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)`](Functions-(Sound-Instances)?id=_soundinstance_setlowpassfiltersoundinstanceid-lowpassfilter-q) +- [`FAudioGMS_SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)`](Functions-(Sound-Instances)?id=_soundinstance_sethighpassfiltersoundinstanceid-lowpassfilter-q) +- [`FAudioGMS_SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)`](Functions-(Sound-Instances)?id=_soundinstance_sethighpassfiltersoundinstanceid-highpassfilter-q) - [`FAudioGMS_SoundInstance_GetPitch(soundInstanceID)`]() - [`FAudioGMS_SoundInstance_GetVolume(soundInstanceID)`]() - [`FAudioGMS_SoundInstance_GetTrackLengthInSeconds(soundInstanceID)`]() @@ -43,21 +43,21 @@ ## [Effect Chains](Functions-(Effect-Chains)) -- [`FAudioGMS_EffectChain_Create()`](Functions-(Effect-Chains)?id=faudiogms_effectchain_create) -- [`FAudioGMS_EffectChain_Destroy(effectChainID)`](Functions-(Effect-Chains)?id=faudiogms_effectchain_destroyeffectchainid) -- [`FAudioGMS_EffectChain_AddDefaultReverb(effectChainID)`](Functions-(Effect-Chains)?id=faudiogms_effectchain_adddefaultreverbeffectchainid) -- [`FAudioGMS_EffectChain_AddReverb(...)`](Functions-(Effect-Chains)?id=faudiogms_effectchain_addreverb) -- [`FAudioGMS_SoundInstance_SetEffectChain(soundInstanceID, effectChainID, effectGain)`](Functions-(Effect-Chains)?id=faudiogms_soundinstance_seteffectchainsoundinstanceid-effectchainid-effectgain) -- [`FAudioGMS_SoundInstance_SetEffectGain(soundInstanceID, effectGain)`](Functions-(Effect-Chains)?id=faudiogms_soundinstance_seteffectgainsoundinstanceid-effectgain) -- [`FAudioGMS_SetMasteringEffectChain(effectChainID, effectGain)`](Functions-(Effect-Chains)?id=faudiogms_setmasteringeffectchaineffectchainid-effectgain) -- [`FAudioGMS_SetMasteringEffectGain(effectGain)`](Functions-(Effect-Chains)?id=faudiogms_setmasteringeffectgaineffectgain) +- [`FAudioGMS_EffectChain_Create()`](Functions-(Effect-Chains)?id=_effectchain_create) +- [`FAudioGMS_EffectChain_Destroy(effectChainID)`](Functions-(Effect-Chains)?id=_effectchain_destroyeffectchainid) +- [`FAudioGMS_EffectChain_AddDefaultReverb(effectChainID)`](Functions-(Effect-Chains)?id=_effectchain_adddefaultreverbeffectchainid) +- [`FAudioGMS_EffectChain_AddReverb(...)`](Functions-(Effect-Chains)?id=_effectchain_addreverb) +- [`FAudioGMS_SoundInstance_SetEffectChain(soundInstanceID, effectChainID, effectGain)`](Functions-(Effect-Chains)?id=_soundinstance_seteffectchainsoundinstanceid-effectchainid-effectgain) +- [`FAudioGMS_SoundInstance_SetEffectGain(soundInstanceID, effectGain)`](Functions-(Effect-Chains)?id=_soundinstance_seteffectgainsoundinstanceid-effectgain) +- [`FAudioGMS_SetMasteringEffectChain(effectChainID, effectGain)`](Functions-(Effect-Chains)?id=_setmasteringeffectchaineffectchainid-effectgain) +- [`FAudioGMS_SetMasteringEffectGain(effectGain)`](Functions-(Effect-Chains)?id=_setmasteringeffectgaineffectgain)   ## [Global Behaviours](Functions-(Global-Behaviours)) -- [`FAudioGMS_SetListenerPosition(x, y, z)`](Functions-(Global-Behaviours)?id=faudiogms_setlistenerpositionx-y-z) -- [`FAudioGMS_SetListenerVelocity(xVelocity, yVelocity, zVelocity)`](Functions-(Global-Behaviours)?id=faudiogms_setlistenerpositionxvelocity-yvelocity-zvelocity) -- [`FAudioGMS_PauseAll()`](Functions-(Global-Behaviours)?id=faudiogms_pauseall) -- [`FAudioGMS_ResumeAll()`](Functions-(Global-Behaviours)?id=faudiogms_resumeall) -- [`FAudioGMS_StopAll`](Functions-(Global-Behaviours)?id=faudiogms_stopall) \ No newline at end of file +- [`FAudioGMS_SetListenerPosition(x, y, z)`](Functions-(Global-Behaviours)?id=_setlistenerpositionx-y-z) +- [`FAudioGMS_SetListenerVelocity(xVelocity, yVelocity, zVelocity)`](Functions-(Global-Behaviours)?id=_setlistenerpositionxvelocity-yvelocity-zvelocity) +- [`FAudioGMS_PauseAll()`](Functions-(Global-Behaviours)?id=_pauseall) +- [`FAudioGMS_ResumeAll()`](Functions-(Global-Behaviours)?id=_resumeall) +- [`FAudioGMS_StopAll`](Functions-(Global-Behaviours)?id=_stopall) \ No newline at end of file diff --git a/docs/latest/Functions-(Sound-Instances).md b/docs/latest/Functions-(Sound-Instances).md index 3ee109f..1915d07 100644 --- a/docs/latest/Functions-(Sound-Instances).md +++ b/docs/latest/Functions-(Sound-Instances).md @@ -1,4 +1,4 @@ -## `FAudioGMS_SoundInstance_Play(soundInstanceID, loop)` +## `_SoundInstance_Play(soundInstanceID, loop)` **Returns:** N/A (`undefined`) @@ -9,7 +9,7 @@   -## `FAudioGMS_SoundInstance_Pause(soundInstanceID)` +## `_SoundInstance_Pause(soundInstanceID)` **Returns:** N/A (`undefined`) @@ -19,7 +19,7 @@   -## `FAudioGMS_SoundInstance_Stop(soundInstanceID)` +## `_SoundInstance_Stop(soundInstanceID)` **Returns:** N/A (`undefined`) @@ -29,7 +29,7 @@   -## `FAudioGMS_SoundInstance_Destroy(soundInstanceID)` +## `_SoundInstance_Destroy(soundInstanceID)` **Returns:** N/A (`undefined`) @@ -39,7 +39,7 @@   -## `FAudioGMS_SoundInstance_DestroyWhenFinished(soundInstanceID)` +## `_SoundInstance_DestroyWhenFinished(soundInstanceID)` **Returns:** N/A (`undefined`) @@ -49,7 +49,7 @@   -## `FAudioGMS_SoundInstance_SetPan(soundInstanceID, pan)` +## `_SoundInstance_SetPan(soundInstanceID, pan)` **Returns:** N/A (`undefined`) @@ -60,7 +60,7 @@   -## `FAudioGMS_SoundInstance_SetPitch(soundInstanceID, pitch)` +## `_SoundInstance_SetPitch(soundInstanceID, pitch)` **Returns:** N/A (`undefined`) @@ -71,7 +71,7 @@   -## `FAudioGMS_SoundInstance_SetVolume(soundInstanceID, volume)` +## `_SoundInstance_SetVolume(soundInstanceID, volume)` **Returns:** N/A (`undefined`) @@ -82,7 +82,7 @@   -## `FAudioGMS_SoundInstance_Set3DPosition(soundInstanceID, x, y, z)` +## `_SoundInstance_Set3DPosition(soundInstanceID, x, y, z)` **Returns:** N/A (`undefined`) @@ -95,7 +95,7 @@   -## `FAudioGMS_SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)` +## `_SoundInstance_Set3DVelocity(soundInstanceID, xVelocity, yVelocity, zVelocity)` **Returns:** N/A (`undefined`) @@ -108,7 +108,7 @@   -## `FAudioGMS_SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)` +## `_SoundInstance_SetTrackPositionInSeconds(soundInstanceID, trackPositionInSeconds)` **Returns:** N/A (`undefined`) @@ -119,7 +119,7 @@   -## `FAudioGMS_SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)` +## `_SoundInstance_SetVolumeOverTime(soundInstanceID, volume, milliseconds)` **Returns:** N/A (`undefined`) @@ -131,7 +131,7 @@   -## `FAudioGMS_SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)` +## `_SoundInstance_SetLowPassFilter(soundInstanceID, lowPassFilter, Q)` **Returns:** N/A (`undefined`) @@ -143,7 +143,7 @@   -## `FAudioGMS_SoundInstance_SetHighPassFilter(soundInstanceID, lowPassFilter, Q)` +## `_SoundInstance_SetHighPassFilter(soundInstanceID, lowPassFilter, Q)` **Returns:** N/A (`undefined`) @@ -155,7 +155,7 @@   -## `FAudioGMS_SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)` +## `_SoundInstance_SetHighPassFilter(soundInstanceID, highPassFilter, Q)` **Returns:** N/A (`undefined`) @@ -167,7 +167,7 @@   -## `FAudioGMS_SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)` +## `_SoundInstance_SetBandPassFilter(soundInstanceID, bandPassFilter, Q)` **Returns:** N/A (`undefined`) @@ -179,7 +179,7 @@   -## `FAudioGMS_SoundInstance_GetPitch(soundInstanceID)` +## `_SoundInstance_GetPitch(soundInstanceID)` **Returns:** Number, the pitch of the sound instance, with `1` being no pitch shift @@ -189,7 +189,7 @@   -## `FAudioGMS_SoundInstance_GetVolume(soundInstanceID)` +## `_SoundInstance_GetVolume(soundInstanceID)` **Returns:** Number, the volume of the sound instance, from `0` (inaudible) to `1` (full volume) @@ -199,7 +199,7 @@   -## `FAudioGMS_SoundInstance_GetTrackLengthInSeconds(soundInstanceID)` +## `_SoundInstance_GetTrackLengthInSeconds(soundInstanceID)` **Returns:** Number, the track length (in seconds) @@ -209,7 +209,7 @@   -## `FAudioGMS_SoundInstance_GetTrackPositionInSeconds(soundInstanceID)` +## `_SoundInstance_GetTrackPositionInSeconds(soundInstanceID)` **Returns:** Number, the track position (in seconds)