update API for love2d and lovr

Author: sumneko

meta/3rd/love2d/library/love.audio.lua

@@ -161,7 +161,7 @@ function love.audio.setDopplerScale(scale) end
 ---
 ---Not all system supports audio effects. Use love.audio.isEffectsSupported to check.
 ---
----@overload fun(name: string, enabled: boolean):boolean
+---@overload fun(name: string, enabled?: boolean):boolean
 ---@param name string # The name of the effect.
 ---@param settings {type: love.EffectType, volume: number} # The settings to use for this effect, with the following fields:
 ---@return boolean success # Whether the effect was successfully created.
@@ -355,7 +355,7 @@ function Source:getDuration(unit) end
 ---This function returns nil if the effect was applied with no filter settings associated to it.
 ---
 ---@param name string # The name of the effect.
----@param filtersettings? table # An optional empty table that will be filled with the filter settings.
+---@param filtersettings table # An optional empty table that will be filled with the filter settings.
 ---@return {volume: number, highgain: number, lowgain: number} filtersettings # The settings for the filter associated to this effect, or nil if the effect is not present in this Source or has no filter associated. The table has the following fields:
 function Source:getEffect(name, filtersettings) end
 
@@ -597,31 +597,31 @@ function Source:tell(unit) end
 ---
 ---Sources do not get attenuated.
 ---
----| '"none"'
+---| "none"
 ---
 ---Inverse distance attenuation.
 ---
----| '"inverse"'
+---| "inverse"
 ---
 ---Inverse distance attenuation. Gain is clamped. In version 0.9.2 and older this is named '''inverse clamped'''.
 ---
----| '"inverseclamped"'
+---| "inverseclamped"
 ---
 ---Linear attenuation.
 ---
----| '"linear"'
+---| "linear"
 ---
 ---Linear attenuation. Gain is clamped. In version 0.9.2 and older this is named '''linear clamped'''.
 ---
----| '"linearclamped"'
+---| "linearclamped"
 ---
 ---Exponential attenuation.
 ---
----| '"exponent"'
+---| "exponent"
 ---
 ---Exponential attenuation. Gain is clamped. In version 0.9.2 and older this is named '''exponent clamped'''.
 ---
----| '"exponentclamped"'
+---| "exponentclamped"
 
 ---
 ---The different types of effects supported by love.audio.setEffect.
@@ -630,35 +630,35 @@ function Source:tell(unit) end
 ---
 ---Plays multiple copies of the sound with slight pitch and time variation. Used to make sounds sound "fuller" or "thicker".
 ---
----| '"chorus"'
+---| "chorus"
 ---
 ---Decreases the dynamic range of the sound, making the loud and quiet parts closer in volume, producing a more uniform amplitude throughout time.
 ---
----| '"compressor"'
+---| "compressor"
 ---
 ---Alters the sound by amplifying it until it clips, shearing off parts of the signal, leading to a compressed and distorted sound.
 ---
----| '"distortion"'
+---| "distortion"
 ---
 ---Decaying feedback based effect, on the order of seconds. Also known as delay; causes the sound to repeat at regular intervals at a decreasing volume.
 ---
----| '"echo"'
+---| "echo"
 ---
 ---Adjust the frequency components of the sound using a 4-band (low-shelf, two band-pass and a high-shelf) equalizer.
 ---
----| '"equalizer"'
+---| "equalizer"
 ---
 ---Plays two copies of the sound; while varying the phase, or equivalently delaying one of them, by amounts on the order of milliseconds, resulting in phasing sounds.
 ---
----| '"flanger"'
+---| "flanger"
 ---
 ---Decaying feedback based effect, on the order of milliseconds. Used to simulate the reflection off of the surroundings.
 ---
----| '"reverb"'
+---| "reverb"
 ---
 ---An implementation of amplitude modulation; multiplies the source signal with a simple waveform, to produce either volume changes, or inharmonic overtones.
 ---
----| '"ringmodulator"'
+---| "ringmodulator"
 
 ---
 ---The different types of waveforms that can be used with the '''ringmodulator''' EffectType.
@@ -667,19 +667,19 @@ function Source:tell(unit) end
 ---
 ---A sawtooth wave, also known as a ramp wave. Named for its linear rise, and (near-)instantaneous fall along time.
 ---
----| '"sawtooth"'
+---| "sawtooth"
 ---
 ---A sine wave. Follows a trigonometric sine function.
 ---
----| '"sine"'
+---| "sine"
 ---
 ---A square wave. Switches between high and low states (near-)instantaneously.
 ---
----| '"square"'
+---| "square"
 ---
 ---A triangle wave. Follows a linear rise and fall that repeats periodically.
 ---
----| '"triangle"'
+---| "triangle"
 
 ---
 ---Types of filters for Sources.
@@ -688,15 +688,15 @@ function Source:tell(unit) end
 ---
 ---Low-pass filter. High frequency sounds are attenuated.
 ---
----| '"lowpass"'
+---| "lowpass"
 ---
 ---High-pass filter. Low frequency sounds are attenuated.
 ---
----| '"highpass"'
+---| "highpass"
 ---
 ---Band-pass filter. Both high and low frequency sounds are attenuated based on the given parameters.
 ---
----| '"bandpass"'
+---| "bandpass"
 
 ---
 ---Types of audio sources.
@@ -707,15 +707,15 @@ function Source:tell(unit) end
 ---
 ---The whole audio is decoded.
 ---
----| '"static"'
+---| "static"
 ---
 ---The audio is decoded in chunks when needed.
 ---
----| '"stream"'
+---| "stream"
 ---
 ---The audio must be manually queued by the user.
 ---
----| '"queue"'
+---| "queue"
 
 ---
 ---Units that represent time.
@@ -724,8 +724,8 @@ function Source:tell(unit) end
 ---
 ---Regular seconds.
 ---
----| '"seconds"'
+---| "seconds"
 ---
 ---Audio samples.
 ---
----| '"samples"'
+---| "samples"

meta/3rd/love2d/library/love.data.lua

@@ -9,7 +9,7 @@ love.data = {}
 ---
 ---Compresses a string or data using a specific compression algorithm.
 ---
----@overload fun(container: love.ContainerType, format: love.CompressedDataFormat, data: love.Data, level: number):love.CompressedData|string
+---@overload fun(container: love.ContainerType, format: love.CompressedDataFormat, data: love.Data, level?: number):love.CompressedData|string
 ---@param container love.ContainerType # What type to return the compressed data as.
 ---@param format love.CompressedDataFormat # The format to use when compressing the string.
 ---@param rawstring string # The raw (un-compressed) string to compress.
@@ -40,7 +40,7 @@ function love.data.decompress(container, compressedData) end
 ---
 ---Encode Data or a string to a Data or string in one of the EncodeFormats.
 ---
----@overload fun(container: love.ContainerType, format: love.EncodeFormat, sourceData: love.Data, linelength: number):love.ByteData|string
+---@overload fun(container: love.ContainerType, format: love.EncodeFormat, sourceData: love.Data, linelength?: number):love.ByteData|string
 ---@param container love.ContainerType # What type to return the encoded data as.
 ---@param format love.EncodeFormat # The format of the output data.
 ---@param sourceString string # The raw data to encode.
@@ -71,7 +71,7 @@ function love.data.hash(hashFunction, string) end
 ---
 ---Data:getPointer along with LuaJIT's FFI can be used to manipulate the contents of the ByteData object after it has been created.
 ---
----@overload fun(Data: love.Data, offset: number, size: number):love.ByteData
+---@overload fun(Data: love.Data, offset?: number, size?: number):love.ByteData
 ---@overload fun(size: number):love.ByteData
 ---@param datastring string # The byte string to copy.
 ---@return love.ByteData bytedata # The new Data object.
@@ -103,7 +103,7 @@ function love.data.pack(container, format, v1, ...) end
 ---
 ---This function behaves the same as Lua 5.3's string.unpack.
 ---
----@overload fun(format: string, data: love.Data, pos: number):number|boolean|string, number|boolean|string, number
+---@overload fun(format: string, data: love.Data, pos?: number):number|boolean|string, number|boolean|string, number
 ---@param format string # A string determining how the values were packed. Follows the rules of Lua 5.3's string.pack format strings.
 ---@param datastring string # A string containing the packed (serialized) data.
 ---@param pos? number # Where to start reading in the string. Negative values can be used to read relative from the end of the string.
@@ -140,19 +140,19 @@ function CompressedData:getFormat() end
 ---
 ---The LZ4 compression format. Compresses and decompresses very quickly, but the compression ratio is not the best. LZ4-HC is used when compression level 9 is specified. Some benchmarks are available here.
 ---
----| '"lz4"'
+---| "lz4"
 ---
 ---The zlib format is DEFLATE-compressed data with a small bit of header data. Compresses relatively slowly and decompresses moderately quickly, and has a decent compression ratio.
 ---
----| '"zlib"'
+---| "zlib"
 ---
 ---The gzip format is DEFLATE-compressed data with a slightly larger header than zlib. Since it uses DEFLATE it has the same compression characteristics as the zlib format.
 ---
----| '"gzip"'
+---| "gzip"
 ---
 ---Raw DEFLATE-compressed data (no header).
 ---
----| '"deflate"'
+---| "deflate"
 
 ---
 ---Return type of various data-returning functions.
@@ -161,11 +161,11 @@ function CompressedData:getFormat() end
 ---
 ---Return type is ByteData.
 ---
----| '"data"'
+---| "data"
 ---
 ---Return type is string.
 ---
----| '"string"'
+---| "string"
 
 ---
 ---Encoding format used to encode or decode data.
@@ -174,11 +174,11 @@ function CompressedData:getFormat() end
 ---
 ---Encode/decode data as base64 binary-to-text encoding.
 ---
----| '"base64"'
+---| "base64"
 ---
 ---Encode/decode data as hexadecimal string.
 ---
----| '"hex"'
+---| "hex"
 
 ---
 ---Hash algorithm of love.data.hash.
@@ -187,24 +187,24 @@ function CompressedData:getFormat() end
 ---
 ---MD5 hash algorithm (16 bytes).
 ---
----| '"md5"'
+---| "md5"
 ---
 ---SHA1 hash algorithm (20 bytes).
 ---
----| '"sha1"'
+---| "sha1"
 ---
 ---SHA2 hash algorithm with message digest size of 224 bits (28 bytes).
 ---
----| '"sha224"'
+---| "sha224"
 ---
 ---SHA2 hash algorithm with message digest size of 256 bits (32 bytes).
 ---
----| '"sha256"'
+---| "sha256"
 ---
 ---SHA2 hash algorithm with message digest size of 384 bits (48 bytes).
 ---
----| '"sha384"'
+---| "sha384"
 ---
 ---SHA2 hash algorithm with message digest size of 512 bits (64 bytes).
 ---
----| '"sha512"'
+---| "sha512"