summaryrefslogtreecommitdiff
path: root/luals-stubs/queue.lua
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2024-01-05 17:15:47 +1100
committerjacqueline <me@jacqueline.id.au>2024-01-05 17:15:47 +1100
commite12a68a74d9527d4becde122da4ff1ad6550564e (patch)
tree1d987e513efe693bc48817acbc0e89d7db044828 /luals-stubs/queue.lua
parentaa1dd3d522aa60c2e8ec31ccc49b3459b4f0f8e2 (diff)
downloadtangara-fw-e12a68a74d9527d4becde122da4ff1ad6550564e.tar.gz
split lua stubs into one set for ldoc, and one set for lua-ls
Diffstat (limited to 'luals-stubs/queue.lua')
-rw-r--r--luals-stubs/queue.lua11
1 files changed, 11 insertions, 0 deletions
diff --git a/luals-stubs/queue.lua b/luals-stubs/queue.lua
new file mode 100644
index 00000000..0c63b8c1
--- /dev/null
+++ b/luals-stubs/queue.lua
@@ -0,0 +1,11 @@
+--- @meta
+
+--- Properties and functions for inspecting and manipulating the track playback queue
+--- @class queue
+--- @field position Property The index in the queue of the currently playing track. This may be zero if the queue is empty. Writeable.
+--- @field size Property The total number of tracks in the queue, including tracks which have already been played.
+--- @field replay Property Whether or not the queue will be restarted after the final track is played. Writeable.
+--- @field random Property Determines whether, when progressing to the next track in the queue, the next track will be chosen randomly. The random selection algorithm used is a Miller Shuffle, which guarantees that no repeat selections will be made until every item in the queue has been played. Writeable.
+local queue = {}
+
+return queue