mirror of
https://github.com/lune-org/lune.git
synced 2024-12-12 13:00:37 +00:00
Fix roblox builting typedefs
This commit is contained in:
parent
435983f26b
commit
4023521f95
1 changed files with 31 additions and 1 deletions
|
@ -1,7 +1,7 @@
|
||||||
export type Instance = {}
|
export type Instance = {}
|
||||||
|
|
||||||
--[=[
|
--[=[
|
||||||
@class Process
|
@class Roblox
|
||||||
|
|
||||||
Built-in library for manipulating Roblox place & model files
|
Built-in library for manipulating Roblox place & model files
|
||||||
|
|
||||||
|
@ -23,6 +23,9 @@ export type Instance = {}
|
||||||
]=]
|
]=]
|
||||||
export type Roblox = {
|
export type Roblox = {
|
||||||
--[=[
|
--[=[
|
||||||
|
@within Roblox
|
||||||
|
@must_use
|
||||||
|
|
||||||
Reads a place file into a DataModel instance.
|
Reads a place file into a DataModel instance.
|
||||||
|
|
||||||
### Example usage
|
### Example usage
|
||||||
|
@ -31,9 +34,14 @@ export type Roblox = {
|
||||||
local roblox = require("@lune/roblox")
|
local roblox = require("@lune/roblox")
|
||||||
local game = roblox.readPlaceFile("filePath.rbxl")
|
local game = roblox.readPlaceFile("filePath.rbxl")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@param filePath The file path to read from
|
||||||
]=]
|
]=]
|
||||||
readPlaceFile: (filePath: string) -> Instance,
|
readPlaceFile: (filePath: string) -> Instance,
|
||||||
--[=[
|
--[=[
|
||||||
|
@within Roblox
|
||||||
|
@must_use
|
||||||
|
|
||||||
Reads a model file into a table of instances.
|
Reads a model file into a table of instances.
|
||||||
|
|
||||||
### Example usage
|
### Example usage
|
||||||
|
@ -42,9 +50,13 @@ export type Roblox = {
|
||||||
local roblox = require("@lune/roblox")
|
local roblox = require("@lune/roblox")
|
||||||
local instances = roblox.readModelFile("filePath.rbxm")
|
local instances = roblox.readModelFile("filePath.rbxm")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@param filePath The file path to read from
|
||||||
]=]
|
]=]
|
||||||
readModelFile: (filePath: string) -> { Instance },
|
readModelFile: (filePath: string) -> { Instance },
|
||||||
--[=[
|
--[=[
|
||||||
|
@within Roblox
|
||||||
|
|
||||||
Writes a DataModel instance to a place file.
|
Writes a DataModel instance to a place file.
|
||||||
|
|
||||||
### Example usage
|
### Example usage
|
||||||
|
@ -53,9 +65,14 @@ export type Roblox = {
|
||||||
local roblox = require("@lune/roblox")
|
local roblox = require("@lune/roblox")
|
||||||
roblox.writePlaceFile("filePath.rbxl", game)
|
roblox.writePlaceFile("filePath.rbxl", game)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@param filePath The file path to write to
|
||||||
|
@param dataModel The DataModel to write to the file
|
||||||
]=]
|
]=]
|
||||||
writePlaceFile: (filePath: string, dataModel: Instance) -> (),
|
writePlaceFile: (filePath: string, dataModel: Instance) -> (),
|
||||||
--[=[
|
--[=[
|
||||||
|
@within Roblox
|
||||||
|
|
||||||
Writes one or more instances to a model file.
|
Writes one or more instances to a model file.
|
||||||
|
|
||||||
### Example usage
|
### Example usage
|
||||||
|
@ -64,11 +81,22 @@ export type Roblox = {
|
||||||
local roblox = require("@lune/roblox")
|
local roblox = require("@lune/roblox")
|
||||||
roblox.writeModelFile("filePath.rbxm", { instance1, instance2, ... })
|
roblox.writeModelFile("filePath.rbxm", { instance1, instance2, ... })
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@param filePath The file path to write to
|
||||||
|
@param instances The array of instances to write to the file
|
||||||
]=]
|
]=]
|
||||||
writeModelFile: (filePath: string, instances: { Instance }) -> (),
|
writeModelFile: (filePath: string, instances: { Instance }) -> (),
|
||||||
--[=[
|
--[=[
|
||||||
|
@within Roblox
|
||||||
|
@must_use
|
||||||
|
|
||||||
Gets the current auth cookie, for usage with Roblox web APIs.
|
Gets the current auth cookie, for usage with Roblox web APIs.
|
||||||
|
|
||||||
|
Note that this auth cookie is formatted for use as a "Cookie" header,
|
||||||
|
and that it contains restrictions so that it may only be used for
|
||||||
|
official Roblox endpoints. To get the raw cookie value without any
|
||||||
|
additional formatting, you can pass `true` as the first and only parameter.
|
||||||
|
|
||||||
### Example usage
|
### Example usage
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
|
@ -91,6 +119,8 @@ export type Roblox = {
|
||||||
local responseLocation = responseTable.locations[1].location
|
local responseLocation = responseTable.locations[1].location
|
||||||
print("Download link to place: " .. responseLocation)
|
print("Download link to place: " .. responseLocation)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@param raw If the cookie should be returned as a pure value or not. Defaults to false
|
||||||
]=]
|
]=]
|
||||||
getAuthCookie: (raw: boolean?) -> string?,
|
getAuthCookie: (raw: boolean?) -> string?,
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue