43 lines
1.4 KiB
Lua
43 lines
1.4 KiB
Lua
---@meta
|
|
|
|
---
|
|
---`lovr` is the single global table that is exposed to every LÖVR app. It contains a set of **modules** and a set of **callbacks**.
|
|
---
|
|
---@class lovr
|
|
lovr = {}
|
|
|
|
---
|
|
---Get the current major, minor, and patch version of LÖVR.
|
|
---
|
|
---@return number major # The major version.
|
|
---@return number minor # The minor version.
|
|
---@return number patch # The patch number.
|
|
function lovr.getVersion() end
|
|
|
|
---
|
|
---The superclass of all LÖVR objects.
|
|
---
|
|
---In addition to the methods here, all objects have a `__tostring` metamethod that returns the name of the object's type.
|
|
---
|
|
---So `tostring(object) == 'Blob'` will check if a LÖVR object is a Blob.
|
|
---
|
|
---
|
|
---### NOTE:
|
|
---Note that the functions here don't apply to any vector objects, see `Vectors`.
|
|
---
|
|
---@class lovr.Object
|
|
local Object = {}
|
|
|
|
---
|
|
---Immediately destroys Lua's reference to the object it's called on.
|
|
---
|
|
---After calling this function on an object, it is an error to do anything with the object from Lua (call methods on it, pass it to other functions, etc.).
|
|
---
|
|
---If nothing else is using the object, it will be destroyed immediately, which can be used to destroy something earlier than it would normally be garbage collected in order to reduce memory.
|
|
---
|
|
---
|
|
---### NOTE:
|
|
---The object may not be destroyed immediately if something else is referring to it (e.g. it is pushed to a Channel or exists in the payload of a pending event).
|
|
---
|
|
function Object:release() end
|