Browse Source

Source tags;

bjorn 4 years ago
parent
commit
66ffff33d8

File diff suppressed because it is too large
+ 66 - 23
api/init.lua


+ 1 - 0
api/lovr/audio/Source/clone.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceUtility',
   summary = 'Create an identical copy of the Source.',
   summary = 'Create an identical copy of the Source.',
   description = [[
   description = [[
     Creates a copy of the Source, referencing the same `Sound` object and inheriting all of the
     Creates a copy of the Source, referencing the same `Sound` object and inheriting all of the

+ 1 - 0
api/lovr/audio/Source/getDirectivity.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Get the directivity of the Source.',
   summary = 'Get the directivity of the Source.',
   description = [[
   description = [[
     Returns the directivity settings for the Source.
     Returns the directivity settings for the Source.

+ 1 - 0
api/lovr/audio/Source/getDuration.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Get the duration of the Source.',
   summary = 'Get the duration of the Source.',
   description = 'Returns the duration of the Source.',
   description = 'Returns the duration of the Source.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/audio/Source/getOrientation.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Get the orientation of the Source.',
   summary = 'Get the orientation of the Source.',
   description = 'Returns the orientation of the Source, in angle/axis representation.',
   description = 'Returns the orientation of the Source, in angle/axis representation.',
   arguments = {},
   arguments = {},

+ 1 - 0
api/lovr/audio/Source/getPose.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Get the pose of the Source.',
   summary = 'Get the pose of the Source.',
   description = 'Returns the position and orientation of the Source.',
   description = 'Returns the position and orientation of the Source.',
   arguments = {},
   arguments = {},

+ 1 - 0
api/lovr/audio/Source/getPosition.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Get the position of the Source.',
   summary = 'Get the position of the Source.',
   description = [[
   description = [[
     Returns the position of the Source, in meters.  Setting the position will cause the Source to
     Returns the position of the Source, in meters.  Setting the position will cause the Source to

+ 1 - 0
api/lovr/audio/Source/getRadius.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Get the radius of the Source.',
   summary = 'Get the radius of the Source.',
   description = [[
   description = [[
     Returns the radius of the Source, in meters.
     Returns the radius of the Source, in meters.

+ 1 - 0
api/lovr/audio/Source/getVolume.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Get the volume of the Source.',
   summary = 'Get the volume of the Source.',
   description = 'Returns the current volume factor for the Source.',
   description = 'Returns the current volume factor for the Source.',
   arguments = {
   arguments = {

+ 14 - 0
api/lovr/audio/Source/init.lua

@@ -14,5 +14,19 @@ return {
   constructors = {
   constructors = {
     'lovr.audio.newSource',
     'lovr.audio.newSource',
     'Source:clone'
     'Source:clone'
+  },
+  sections = {
+    {
+      name = 'Playback',
+      tag = 'sourcePlayback'
+    },
+    {
+      name = 'Spatial Effects',
+      tag = 'sourceEffects'
+    },
+    {
+      name = 'Utility',
+      tag = 'sourceUtility'
+    }
   }
   }
 }
 }

+ 1 - 0
api/lovr/audio/Source/isEffectEnabled.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Check if an effect is enabled.',
   summary = 'Check if an effect is enabled.',
   description = 'Returns whether a given `Effect` is enabled for the Source.',
   description = 'Returns whether a given `Effect` is enabled for the Source.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/audio/Source/isLooping.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Check if the Source is looping.',
   summary = 'Check if the Source is looping.',
   description = 'Returns whether or not the Source will loop when it finishes.',
   description = 'Returns whether or not the Source will loop when it finishes.',
   arguments = {},
   arguments = {},

+ 1 - 0
api/lovr/audio/Source/isPlaying.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Check if the Source is playing.',
   summary = 'Check if the Source is playing.',
   description = 'Returns whether or not the Source is playing.',
   description = 'Returns whether or not the Source is playing.',
   arguments = {},
   arguments = {},

+ 1 - 0
api/lovr/audio/Source/pause.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Pause the Source.',
   summary = 'Pause the Source.',
   description = [[
   description = [[
     Pauses the source.  It can be resumed with `Source:resume` or `Source:play`. If a paused source
     Pauses the source.  It can be resumed with `Source:resume` or `Source:play`. If a paused source

+ 1 - 0
api/lovr/audio/Source/play.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Play the Source.',
   summary = 'Play the Source.',
   description = 'Plays the Source.  This doesn\'t do anything if the Source is already playing.',
   description = 'Plays the Source.  This doesn\'t do anything if the Source is already playing.',
   arguments = {},
   arguments = {},

+ 1 - 0
api/lovr/audio/Source/seek.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Set the playback position of the Source.',
   summary = 'Set the playback position of the Source.',
   description = 'Seeks the Source to the specified position.',
   description = 'Seeks the Source to the specified position.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/audio/Source/setDirectivity.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Set the directivity of the Source.',
   summary = 'Set the directivity of the Source.',
   description = [[
   description = [[
     Sets the directivity settings for the Source.
     Sets the directivity settings for the Source.

+ 1 - 0
api/lovr/audio/Source/setEffectEnabled.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Enable or disable an effect.',
   summary = 'Enable or disable an effect.',
   description = 'Enables or disables an effect on the Source.',
   description = 'Enables or disables an effect on the Source.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/audio/Source/setLooping.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Set whether or not the Source loops.',
   summary = 'Set whether or not the Source loops.',
   description = 'Sets whether or not the Source loops.',
   description = 'Sets whether or not the Source loops.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/audio/Source/setOrientation.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Set the orientation of the Source.',
   summary = 'Set the orientation of the Source.',
   description = 'Sets the orientation of the Source in angle/axis representation.',
   description = 'Sets the orientation of the Source in angle/axis representation.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/audio/Source/setPose.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Set the pose of the Source.',
   summary = 'Set the pose of the Source.',
   description = 'Sets the position and orientation of the Source.',
   description = 'Sets the position and orientation of the Source.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/audio/Source/setPosition.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Set the position of the Source.',
   summary = 'Set the position of the Source.',
   description = [[
   description = [[
     Sets the position of the Source, in meters.  Setting the position will cause the Source to be
     Sets the position of the Source, in meters.  Setting the position will cause the Source to be

+ 1 - 0
api/lovr/audio/Source/setRadius.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourceEffects',
   summary = 'Set the radius of the Source.',
   summary = 'Set the radius of the Source.',
   description = [[
   description = [[
     Sets the radius of the Source, in meters.
     Sets the radius of the Source, in meters.

+ 1 - 0
api/lovr/audio/Source/setVolume.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Set the volume of the Source.',
   summary = 'Set the volume of the Source.',
   description = 'Sets the current volume factor for the Source.',
   description = 'Sets the current volume factor for the Source.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/audio/Source/stop.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Stop the Source.',
   summary = 'Stop the Source.',
   description = 'Stops the source, also rewinding it to the beginning.',
   description = 'Stops the source, also rewinding it to the beginning.',
   arguments = {},
   arguments = {},

+ 1 - 0
api/lovr/audio/Source/tell.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'sourcePlayback',
   summary = 'Get the playback position of the Source.',
   summary = 'Get the playback position of the Source.',
   description = 'Returns the current playback position of the Source.',
   description = 'Returns the current playback position of the Source.',
   arguments = {
   arguments = {

Some files were not shown because too many files changed in this diff