Annotations

---@alias userID integer The ID of a user

---@alias modes "r" | "w"

---@alias DeviceSide
---| '"left"' # The left side of the device
---| '"right"' # The right side of the device
---| '"top"' # The top side of the device
---| '"bottom"' # The bottom side of the device
---| '"front"' # The front side of the device
---| '"back"' # The back side of the device

---@param side DeviceSide
local function checkSide(side) end

local A = "Hello"
local B = "World"

---@alias myLiteralAlias `A` | `B`

---@param x myLiteralAlias
function foo(x) end

local A = "Hello"
local B = "World"

---@alias myLiteralAlias `A` | `B`

---@param x myLiteralAlias
function foo(x) end

---@param key string Must be a string
local function doSomething(key) end

local x = nil

doSomething(x --[[@as string]])

---@async
---Perform an asynchronous HTTP GET request
function http.get(url) end

---@type integer | string
local x

---@cast x string
print(x) --> x: string

---@type integer
local x

---@cast x +boolean
print(x) --> x: integer | boolean

---@type integer|string
local x

---@cast x -integer
print(x) --> x: string

---@type string
local x --> x: string

---@cast x +boolean, +number
print(x) --> x:string | boolean | number

---@type string
local x

---@cast x +?
print(x) --> x:string?

---@class Car
local Car = {}

---@class Vehicle
local Vehicle = {}

---@class Plane: Vehicle
local Plane = {}

---@class (exact) Point
---@field x number
---@field y number
local Point = {}
Point.x = 1 -- OK
Point.y = 2 -- OK
Point.z = 3 -- Warning

---@class table<K, V>: { [K]: V }

---@deprecated
function outdated() end

---@diagnostic disable-next-line: unused-local

---@diagnostic enable:spell-check

---@enum colors
local COLORS = {
	black = 0,
	red = 2,
	green = 4,
	yellow = 8,
	blue = 16,
	white = 32
}

---@param color colors
local function setColor(color) end

setColor(COLORS.green)

---@enum (key) Direction
local direction = {
    LEFT = 1,
    RIGHT = 2,
}

---@param dir Direction
local function move(dir)
    assert(dir == "LEFT" or dir == "RIGHT")

    assert(direction[dir] == 1 or direction[dir] == 2)
    assert(direction[dir] == direction.LEFT or direction[dir] == direction.RIGHT)
end

move("LEFT")

---@class Person
---@field height number The height of this person in cm
---@field weight number The weight of this person in kg
---@field firstName string The first name of this person
---@field lastName? string The last name of this person
---@field age integer The age of this person

---@param person Person
local function hire(person) end

---@class Animal
---@field private legs integer
---@field eyes integer

---@class Dog:Animal
local myDog = {}

---Child class Dog CANNOT use private field legs
function myDog:legCount()
	return self.legs
end

---@class Animal
---@field protected legs integer
---@field eyes integer

---@class Dog:Animal
local myDog = {}

---Child class Dog can use protected field legs
function myDog:legCount()
	return self.legs
end

---@class Numbers
---@field named string
---@field [string] integer
local Numbers = {}

---@generic T : integer
---@param p1 T
---@return T, T[]
function Generic(p1) end

-- v1: string
-- v2: string[]
local v1, v2 = Generic("String")

-- v3: integer
-- v4: integer[]
local v3, v4 = Generic(10)

---@class Vehicle
local Vehicle = {}
function Vehicle:drive() end

---@generic T
---@param class `T` # the type is captured using `T`
---@return T       # generic type is returned
local function new(class) end

-- obj: Vehicle
local obj = new("Vehicle")

---@class Array<T>: { [integer]: T }

---@type Array<string>
local arr = {}

-- Warns that I am assigning a boolean to a string
arr[1] = false

arr[3] = "Correct"

---@class Dictionary<T>: { [string]: T }

---@type Dictionary<boolean>
local dict = {}

-- no warning despite assigning a string
dict["foo"] = "bar?"

dict["correct"] = true

---@meta [name]

---@module 'http'

--The above provides the same as
require 'http'
--within the language server

---@module 'http'
local http

--The above provides the same as
local http = require 'http'
--within the language server

---@return string username
---@nodiscard
function getUsername() end

---@class Vector
---@operator add(Vector): Vector

---@type Vector
local v1
---@type Vector
local v2

--> v3: Vector
local v3 = v1 + v2

---@class Passcode
---@operator unm:integer

---@type Passcode
local pA

local pB = -pA
--> integer

---@class URL
---@operator call:string
local URL = {}

---@param objectID integer The id of the object to remove
---@param whenOutOfView boolean Only remove the object when it is not visible
---@return boolean success If the object was successfully removed
---@overload fun(objectID: integer): boolean
local function removeObject(objectID, whenOutOfView) end

---@overload fun(a: string): boolean
local foo = setmetatable({}, {
	__call = function(a)
		print(a)
        return true
	end,
})

local bool = foo("myString")

---@class Animal
---@field private eyes integer
local Animal = {}

---@package
---This cannot be accessed in another file
function Animal:eyesCount()
    return self.eyes
end

---@param username string The name to set for this user
function setUsername(username) end

---@param setting string The name of the setting
---@param value string|number|boolean The value of the setting
local function settings.set(setting, value) end

---@param role string The name of the role
---@param isActive? boolean If the role is currently active
---@return Role
function Role.new(role, isActive) end

---@param index integer
---@param ... string Tags to add to this entry
local function addTags(index, ...) end

---@class Box

---@generic T
---@param objectID integer The ID of the object to set the type of
---@param type `T` The type of object to set
---@return `T` object The object as a Lua object
local function setObjectType(objectID, type) end

--> boxObject: Box
local boxObject = setObjectType(1, "Box")

---@param mode string
---|"'immediate'"  # comment 1
---|"'async'" # comment 2
function bar(mode) end

local A = 0
local B = 1

---@param active integer
---| `A` # Has a value of 0
---| `B` # Has a value of 1
function set(active) end

---@class Animal
---@field private eyes integer
local Animal = {}

---@private
function Animal:eyesCount()
    return self.eyes
end

---@class Dog:Animal
local myDog = {}

---NOT PERMITTED!
myDog:eyesCount();

---@class Animal
---@field private eyes integer
local Animal = {}

---@protected
function Animal:eyesCount()
    return self.eyes
end

---@class Dog:Animal
local myDog = {}

---Permitted because function is protected, not private.
myDog:eyesCount();

---@return boolean
local function isEnabled() end

---@return boolean enabled
local function isEnabled() end

---@return boolean enabled If the item is enabled
local function isEnabled() end

---@return boolean # If the item is enabled
local function isEnabled() end

---@return boolean|nil error
local function makeRequest() end

---@return integer count Number of nicknames found
---@return string ...
local function getNicknames() end

---Hovering the below function will show a link that jumps to http.get()

---@see http.get
function request(url) end

---@source C:/Users/me/Documents/program/myFile.c
local a

---@source file:///C:/Users/me/Documents/program/myFile.c:10
local b

---@source local/file.c
local c

---@source local/file.c:10:8
local d

---@type boolean
local x

---@type string[]
local names

---@type { [string]: boolean }
local statuses

---@type table<userID, Player>
local players

---@type boolean|number|"yes"|"no"
local x

---@type fun(name: string, value: any): boolean
local x

---@vararg string
function concat(...) end

---@version >5.2, JIT
function hello() end

---@version 5.4
---@class Entry