diff options
| author | jacqueline <me@jacqueline.id.au> | 2024-01-05 17:15:47 +1100 |
|---|---|---|
| committer | jacqueline <me@jacqueline.id.au> | 2024-01-05 17:15:47 +1100 |
| commit | e12a68a74d9527d4becde122da4ff1ad6550564e (patch) | |
| tree | 1d987e513efe693bc48817acbc0e89d7db044828 /src/lua/stubs/queue.lua | |
| parent | aa1dd3d522aa60c2e8ec31ccc49b3459b4f0f8e2 (diff) | |
| download | tangara-fw-e12a68a74d9527d4becde122da4ff1ad6550564e.tar.gz | |
split lua stubs into one set for ldoc, and one set for lua-ls
Diffstat (limited to 'src/lua/stubs/queue.lua')
| -rw-r--r-- | src/lua/stubs/queue.lua | 22 |
1 files changed, 0 insertions, 22 deletions
diff --git a/src/lua/stubs/queue.lua b/src/lua/stubs/queue.lua deleted file mode 100644 index 000c35d3..00000000 --- a/src/lua/stubs/queue.lua +++ /dev/null @@ -1,22 +0,0 @@ ---- Properties and functions for inspecting and manipulating the track playback queue --- @module queue - -local queue = {} - ---- queue.position returns the index in the queue of the currently playing track. This may be zero if the queue is empty. --- @treturn types.Property a positive integer property, which is a 1-based index -function queue.position() end - ---- queue.size returns the total number of tracks in the queue, including tracks which have already been played. --- @treturn types.Property a positive integer property -function queue.size() end - ---- queue.replay determines whether or not the queue will be restarted after the final track is played. --- @treturn types.Property a writeable boolean property -function queue.replay() end - ---- queue.random 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. --- @treturn types.Property a writeable boolean property -function queue.random() end - -return queue
\ No newline at end of file |
