Skip to content

Commit 55123c5

Browse files
fensoftfensoft
authored
add ficsit-network addon (#308)
1 parent 855a9a4 commit 55123c5

5 files changed

Lines changed: 2087 additions & 0 deletions

File tree

‎addons/ficsit-network/info.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/LuaLS/LLS-Addons/main/schemas/addon_info.schema.json",
3+
"name": "FicsIt-Networks",
4+
"description": "Definitions for the FicsIt-Networks Lua API and reflection system.",
5+
"size": 80993,
6+
"hasPlugin": false
7+
}

‎addons/ficsit-network/module/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# FicsIt-Networks Definitions for LuaLS
2+
Generated LuaLS addon definitions for the FicsIt-Networks Lua API and reflection system.
3+
4+
Source documentation:
5+
- https://docs.ficsit.app/ficsit-networks/latest/lua/index.html
6+
- https://github.com/Panakotta00/FicsIt-Networks/tree/master/docs/modules/ROOT/pages

‎addons/ficsit-network/module/config.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/LuaLS/LLS-Addons/main/schemas/addon_config.schema.json",
3+
"name": "FicsIt-Networks",
4+
"words": [
5+
"async",
6+
"classes",
7+
"component",
8+
"computer",
9+
"event",
10+
"filesystem",
11+
"findItem",
12+
"future",
13+
"microcontroller",
14+
"sleep",
15+
"structs"
16+
],
17+
"settings": {
18+
"Lua.diagnostics.globals": [
19+
"async",
20+
"classes",
21+
"component",
22+
"computer",
23+
"event",
24+
"eventTask",
25+
"filesystem",
26+
"findItem",
27+
"future",
28+
"microcontroller",
29+
"sleep",
30+
"structs",
31+
"timeoutTask"
32+
]
33+
}
34+
}

‎addons/ficsit-network/module/library/ficsit_network_api.lua‎

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,243 @@
1+
---@meta
2+
-- Auto-generated from FicsIt-Networks docs.
3+
4+
---@type fun(fn,...):Future
5+
async = async
6+
7+
---@type fun(name:string):ItemType?
8+
findItem = findItem
9+
10+
---@type fun(...)
11+
print = print
12+
13+
---@type fun(seconds:number)
14+
sleep = sleep
15+
16+
---@type ClassLib
17+
classes = classes
18+
19+
---@type Future
20+
eventTask = eventTask
21+
22+
---@type StructLib
23+
structs = structs
24+
25+
---@type Future
26+
timeoutTask = timeoutTask
27+
28+
---@class component
29+
component = component or {}
30+
--- Signature: component.findComponent((string query | xref:/reflection/classes/Class.adoc[Class] type)...)
31+
---@return string[]
32+
function component.findComponent(...) end
33+
--- Signature: component.proxy((id: string | ids: string[])...)
34+
---@return Object|Object[]
35+
function component.proxy(...) end
36+
37+
---@class computer
38+
computer = computer or {}
39+
---@type FINMediaSubsystem
40+
computer.media = computer.media
41+
--- Signature: computer.attentionPing(position: xref:/reflection/structs/Vector.adoc[Vector], username: string?)
42+
function computer.attentionPing(...) end
43+
--- Signature: computer.beep(pitch: number)
44+
function computer.beep(...) end
45+
--- Signature: computer.demote()
46+
function computer.demote(...) end
47+
--- Signature: computer.getEEPROM()
48+
---@return string
49+
function computer.getEEPROM(...) end
50+
--- Signature: computer.getInstance()
51+
---@return ComputerCase
52+
function computer.getInstance(...) end
53+
--- Signature: computer.getMemory() -> (usage: integer, capacity: integer)
54+
function computer.getMemory(...) end
55+
--- Signature: computer.getPCIDevices(type: Class<T>?)
56+
---@generic T:Object
57+
---@param type Class<T>?
58+
---@return T[]
59+
function computer.getPCIDevices(type) end
60+
--- Signature: computer.isPromoted()
61+
---@return boolean
62+
function computer.isPromoted(...) end
63+
--- Signature: computer.log(verbosity: integer, message: string)
64+
function computer.log(...) end
65+
--- Signature: computer.magicTime() -> (integer, string, string)
66+
function computer.magicTime(...) end
67+
--- Signature: computer.millis()
68+
---@return integer
69+
function computer.millis(...) end
70+
--- Signature: computer.panic(error: string)
71+
function computer.panic(...) end
72+
--- Signature: computer.promote()
73+
function computer.promote(...) end
74+
--- Signature: computer.reset()
75+
function computer.reset(...) end
76+
--- Signature: computer.setEEPROM(code: string)
77+
function computer.setEEPROM(...) end
78+
--- Signature: computer.skip()
79+
function computer.skip(...) end
80+
--- Signature: computer.stop()
81+
function computer.stop(...) end
82+
--- Signature: computer.textNotification(text: string, username: string?)
83+
function computer.textNotification(...) end
84+
--- Signature: computer.time()
85+
---@return number
86+
function computer.time(...) end
87+
88+
---@class debug
89+
debug = debug or {}
90+
--- Signature: debug.getinfo()
91+
function debug.getinfo(...) end
92+
--- Signature: debug.log(string...)
93+
function debug.log(...) end
94+
--- Signature: debug.traceback()
95+
function debug.traceback(...) end
96+
97+
---@class event
98+
event = event or {}
99+
--- Signature: event.clear()
100+
function event.clear(...) end
101+
--- Signature: event.filter(params: { event?: string|string[], sender?: xref:/reflection/classes/Object.adoc[Object]|xref:/reflection/classes/Object.adoc[Object][], values?: table<string,any> })
102+
---@return EventFilter
103+
function event.filter(...) end
104+
--- Signature: event.ignore(...: xref:/reflection/classes/Object.adoc[Object])
105+
function event.ignore(...) end
106+
--- Signature: event.ignoreAll()
107+
function event.ignoreAll(...) end
108+
--- Signature: event.listen(...: xref:/reflection/classes/Object.adoc[Object])
109+
function event.listen(...) end
110+
--- Signature: event.listening()
111+
---@return Object[]
112+
function event.listening(...) end
113+
--- Signature: event.pull(timeout: number?) -> (string?, xref:/reflection/classes/Object.adoc[Object], ...)
114+
function event.pull(...) end
115+
--- Signature: event.queue(filter: xref:/reflection/structs/EventFilter.adoc[EventFilter])
116+
---@return EventQueue
117+
function event.queue(...) end
118+
--- Signature: event.registerListener(filter: xref:/reflection/structs/EventFilter.adoc[EventFilter], cb: fun(event, sender, ...))
119+
---@return integer
120+
function event.registerListener(...) end
121+
--- Signature: event.waitFor(filter: xref:/reflection/structs/EventFilter.adoc[EventFilter])
122+
---@return Future
123+
function event.waitFor(...) end
124+
125+
---@class filesystem
126+
filesystem = filesystem or {}
127+
--- Signature: filesystem.analyzePath(...: string)
128+
---@return any
129+
function filesystem.analyzePath(...) end
130+
--- Signature: filesystem.children(path: string)
131+
---@return string[]
132+
function filesystem.children(...) end
133+
--- Signature: filesystem.createDir(path: string, recursive: bool)
134+
---@return boolean
135+
function filesystem.createDir(...) end
136+
--- Signature: filesystem.doFile(path: string)
137+
---@return any
138+
function filesystem.doFile(...) end
139+
--- Signature: filesystem.exists(path: string)
140+
---@return boolean
141+
function filesystem.exists(...) end
142+
--- Signature: filesystem.initFileSystem(path: string)
143+
---@return boolean
144+
function filesystem.initFileSystem(...) end
145+
--- Signature: filesystem.isDir(path: string)
146+
---@return boolean
147+
function filesystem.isDir(...) end
148+
--- Signature: filesystem.isFile(path: string)
149+
---@return boolean
150+
function filesystem.isFile(...) end
151+
--- Signature: filesystem.isNode(...: string)
152+
---@return any
153+
function filesystem.isNode(...) end
154+
--- Signature: filesystem.loadFile(path: string)
155+
---@return fun():any
156+
function filesystem.loadFile(...) end
157+
--- Signature: filesystem.makeFileSystem(type: string, name: string)
158+
---@return boolean
159+
function filesystem.makeFileSystem(...) end
160+
--- Signature: filesystem.meta(...: string)
161+
---@return any
162+
function filesystem.meta(...) end
163+
--- Signature: filesystem.mount(device: string, mountPoint: string)
164+
---@return boolean
165+
function filesystem.mount(...) end
166+
--- Signature: filesystem.move(from: string, to: string)
167+
---@return boolean
168+
function filesystem.move(...) end
169+
--- Signature: filesystem.open(path: string, mode: string)
170+
---@return File
171+
function filesystem.open(...) end
172+
--- Signature: filesystem.path([conversion: integer,] ...: string)
173+
---@return string
174+
function filesystem.path(...) end
175+
--- Signature: filesystem.remove(path: string, recursive: bool)
176+
---@return boolean
177+
function filesystem.remove(...) end
178+
--- Signature: filesystem.removeFileSystem(name: string)
179+
---@return boolean
180+
function filesystem.removeFileSystem(...) end
181+
--- Signature: filesystem.rename(path: string, name: string)
182+
---@return boolean
183+
function filesystem.rename(...) end
184+
--- Signature: filesystem.unmount(mountPoint: string)
185+
---@return boolean
186+
function filesystem.unmount(...) end
187+
188+
---@class function_
189+
function_ = function_ or {}
190+
---@type string
191+
function_.description = function_.description
192+
---@type string
193+
function_.displayName = function_.displayName
194+
---@type string
195+
function_.name = function_.name
196+
---@type string
197+
function_.quickRef = function_.quickRef
198+
199+
---@class future
200+
future = future or {}
201+
--- Signature: future.addTask(xref:/reflection/structs/Future.adoc[Future]...)
202+
function future.addTask(...) end
203+
--- Signature: future.any(xref:/reflection/structs/Future.adoc[Future]...)
204+
---@return Future
205+
function future.any(...) end
206+
--- Signature: future.async(thread)
207+
---@return Future
208+
function future.async(...) end
209+
--- Signature: future.join(xref:/reflection/structs/Future.adoc[Future]...)
210+
---@return Future
211+
function future.join(...) end
212+
--- Signature: future.loop()
213+
function future.loop(...) end
214+
--- Signature: future.run()
215+
function future.run(...) end
216+
--- Signature: future.sleep(seconds: number)
217+
---@return Future
218+
function future.sleep(...) end
219+
220+
---@class microcontroller
221+
microcontroller = microcontroller or {}
222+
---@type Object
223+
microcontroller.component = microcontroller.component
224+
---@type Microcontroller
225+
microcontroller.self = microcontroller.self
226+
--- Signature: microcontroller.broadcast(integer, ...)
227+
function microcontroller.broadcast(...) end
228+
--- Signature: microcontroller.close(integer...)
229+
function microcontroller.close(...) end
230+
--- Signature: microcontroller.closeAll()
231+
function microcontroller.closeAll(...) end
232+
--- Signature: microcontroller.getStorage(string)
233+
function microcontroller.getStorage(...) end
234+
--- Signature: microcontroller.open(integer...)
235+
function microcontroller.open(...) end
236+
--- Signature: microcontroller.send()
237+
function microcontroller.send(...) end
238+
--- Signature: microcontroller.setStorage(string)
239+
function microcontroller.setStorage(...) end
240+
241+
242+
243+

0 commit comments

Comments
 (0)