Compare commits
15 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5c3928bcbc | ||
|
|
2ed84471d6 | ||
|
|
29f7d06b2f | ||
|
|
ca19c86476 | ||
|
|
aa032aff3d | ||
|
|
71ec65e2fd | ||
|
|
298e473b8c | ||
|
|
dfefa5ff12 | ||
|
|
6097f9ae57 | ||
|
|
1abcef02f9 | ||
|
|
9aa00d749b | ||
|
|
882a4a3618 | ||
|
|
6d444856ca | ||
|
|
f0ab8ee644 | ||
|
|
d29d3b5d48 |
@@ -8,6 +8,28 @@ const iconDataPath = path.join(__dirname, "../", "docs/theme/.icons", "polytoria
|
||||
const yamlEnumPath = path.join(__dirname, "../", "yaml", "enums")
|
||||
const mdEnumPath = path.join(__dirname, "../", "docs/api", "enums")
|
||||
|
||||
// Cleanup md (excluding index.md files)
|
||||
if (fs.existsSync(mdAPIPath)) {
|
||||
const files = fs.readdirSync(mdAPIPath)
|
||||
for (const file of files) {
|
||||
if (file !== 'index.md') {
|
||||
const filePath = path.join(mdAPIPath, file)
|
||||
fs.rmSync(filePath, { recursive: true, force: true })
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (fs.existsSync(mdEnumPath)) {
|
||||
const files = fs.readdirSync(mdEnumPath)
|
||||
for (const file of files) {
|
||||
if (file !== 'index.md') {
|
||||
const filePath = path.join(mdEnumPath, file)
|
||||
fs.rmSync(filePath, { recursive: true, force: true })
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Create directories
|
||||
if (!fs.existsSync(mdAPIPath)) {
|
||||
fs.mkdirSync(mdAPIPath, { recursive: true })
|
||||
}
|
||||
@@ -68,7 +90,8 @@ for (const yamlFile of yamlFiles) {
|
||||
appendLine("")
|
||||
|
||||
if (c.IsStatic) {
|
||||
appendLine(`{{ staticclass(${c.Name.replace("Service", "")}) }}`)
|
||||
appendLine("")
|
||||
appendLine(`{{ staticclass(${c.StaticAlias ? `"${c.StaticAlias}"` : ""}) }}`)
|
||||
appendLine("")
|
||||
}
|
||||
|
||||
@@ -144,7 +167,7 @@ for (const yamlFile of yamlFiles) {
|
||||
fs.writeFileSync(mdPath, mk)
|
||||
}
|
||||
|
||||
console.log(`Converted ${yamlFiles.length} XML files to Markdown`)
|
||||
console.log(`Converted ${yamlFiles.length} YAML files to Markdown`)
|
||||
|
||||
// Process Enums
|
||||
const yamlEnumFiles = fs.readdirSync(yamlEnumPath).filter(file => file.endsWith('.yaml'));
|
||||
@@ -190,4 +213,4 @@ for (const yamlFile of yamlEnumFiles) {
|
||||
fs.writeFileSync(mdPath, mk)
|
||||
}
|
||||
|
||||
console.log(`Converted ${yamlEnumFiles.length} enum XML files to Markdown`)
|
||||
console.log(`Converted ${yamlEnumFiles.length} enum YAML files to Markdown`)
|
||||
58
autogen/package-lock.json
generated
58
autogen/package-lock.json
generated
@@ -1,58 +0,0 @@
|
||||
{
|
||||
"name": "autogen",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"dependencies": {
|
||||
"fast-xml-parser": "^5.3.3",
|
||||
"yaml": "^2.8.2"
|
||||
}
|
||||
},
|
||||
"node_modules/fast-xml-parser": {
|
||||
"version": "5.3.3",
|
||||
"resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.3.3.tgz",
|
||||
"integrity": "sha512-2O3dkPAAC6JavuMm8+4+pgTk+5hoAs+CjZ+sWcQLkX9+/tHRuTkQh/Oaifr8qDmZ8iEHb771Ea6G8CdwkrgvYA==",
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/NaturalIntelligence"
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"strnum": "^2.1.0"
|
||||
},
|
||||
"bin": {
|
||||
"fxparser": "src/cli/cli.js"
|
||||
}
|
||||
},
|
||||
"node_modules/strnum": {
|
||||
"version": "2.1.2",
|
||||
"resolved": "https://registry.npmjs.org/strnum/-/strnum-2.1.2.tgz",
|
||||
"integrity": "sha512-l63NF9y/cLROq/yqKXSLtcMeeyOfnSQlfMSlzFt/K73oIaD8DGaQWd7Z34X9GPiKqP5rbSh84Hl4bOlLcjiSrQ==",
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/NaturalIntelligence"
|
||||
}
|
||||
],
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/yaml": {
|
||||
"version": "2.8.2",
|
||||
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz",
|
||||
"integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==",
|
||||
"license": "ISC",
|
||||
"bin": {
|
||||
"yaml": "bin.mjs"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 14.6"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/eemeli"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"dependencies": {
|
||||
"fast-xml-parser": "^5.3.3",
|
||||
"yaml": "^2.8.2"
|
||||
}
|
||||
}
|
||||
@@ -15,6 +15,40 @@ if (!fs.existsSync(yamlEnumPath)) {
|
||||
|
||||
const data = JSON.parse(fs.readFileSync("def.json", "utf-8"))
|
||||
|
||||
// Track current classes and enums
|
||||
const currentClasses = new Set(data.Classes.map(c => c.Name))
|
||||
const currentEnums = new Set(data.Enums.map(e => e.Name))
|
||||
|
||||
// Clean up removed classes
|
||||
if (fs.existsSync(yamlAPIPath)) {
|
||||
const existingFiles = fs.readdirSync(yamlAPIPath)
|
||||
for (const file of existingFiles) {
|
||||
if (file.endsWith('.yaml')) {
|
||||
const className = path.basename(file, '.yaml')
|
||||
if (!currentClasses.has(className)) {
|
||||
const filePath = path.join(yamlAPIPath, file)
|
||||
fs.unlinkSync(filePath)
|
||||
console.log(`Removed obsolete class: ${className}`)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Clean up removed enums
|
||||
if (fs.existsSync(yamlEnumPath)) {
|
||||
const existingFiles = fs.readdirSync(yamlEnumPath)
|
||||
for (const file of existingFiles) {
|
||||
if (file.endsWith('.yaml')) {
|
||||
const enumName = path.basename(file, '.yaml')
|
||||
if (!currentEnums.has(enumName)) {
|
||||
const filePath = path.join(yamlEnumPath, file)
|
||||
fs.unlinkSync(filePath)
|
||||
console.log(`Removed obsolete enum: ${enumName}`)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Process Classes
|
||||
for (const c of data.Classes) {
|
||||
let yamlPath = path.join(yamlAPIPath, c.Name + ".yaml")
|
||||
@@ -32,8 +66,8 @@ for (const c of data.Classes) {
|
||||
let existingClassDescription = "Missing Documentation";
|
||||
|
||||
if (fs.existsSync(yamlPath)) {
|
||||
const existingXml = fs.readFileSync(yamlPath, "utf-8");
|
||||
const existingData = yaml.parse(existingXml);
|
||||
const existingYaml = fs.readFileSync(yamlPath, "utf-8");
|
||||
const existingData = yaml.parse(existingYaml);
|
||||
|
||||
// Preserve existing class description
|
||||
if (existingData.Description) {
|
||||
@@ -117,8 +151,8 @@ for (const e of data.Enums) {
|
||||
let existingDescriptions = {};
|
||||
let existingEnumDescription = "";
|
||||
if (fs.existsSync(yamlPath)) {
|
||||
const existingXml = fs.readFileSync(yamlPath, "utf-8");
|
||||
const existingData = yaml.parse(existingXml);
|
||||
const existingYaml = fs.readFileSync(yamlPath, "utf-8");
|
||||
const existingData = yaml.parse(existingYaml);
|
||||
|
||||
existingEnumDescription = existingData.Description || "";
|
||||
|
||||
|
||||
7
docs/tutorials/index.md
Normal file
7
docs/tutorials/index.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Tutorials
|
||||
weight: 3
|
||||
empty: true
|
||||
---
|
||||
|
||||
# Tutorials
|
||||
80
docs/tutorials/migration.md
Normal file
80
docs/tutorials/migration.md
Normal file
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: Migrating to 2.0
|
||||
description: Guide on how you can migrate your place to 2.0
|
||||
---
|
||||
|
||||
!! WORK IN PROGRESS !!
|
||||
|
||||
# Migrating to 2.0
|
||||
|
||||
Tutorial on how to migrate to 2.0
|
||||
|
||||
## Lua 5.2 -> Luau
|
||||
|
||||
This is the biggest compatibility breaking change for 2.0. The transition from Lua 5.2 (Moonsharp) to Luau. One of the big change being the now non-available `goto` statements. Which you'll have to switch to `continue` statement instead.
|
||||
|
||||
## Tweening
|
||||
|
||||
Tweening has been revamped in 2.0. You should create a tween object first, then tween it from there. Example:
|
||||
|
||||
```lua
|
||||
local part: Part = script.Parent
|
||||
local origin = part.Position
|
||||
local tw = Tween:NewTween()
|
||||
|
||||
print("Tween Start!")
|
||||
|
||||
tw:TweenVector3(origin, origin + Vector3.New(0, 10, 0), 10, function(val)
|
||||
part.Position = val
|
||||
end)
|
||||
|
||||
tw.Finished:Wait()
|
||||
|
||||
print("Tween Finished!")
|
||||
```
|
||||
|
||||
## Particles
|
||||
|
||||
Particles has been revamped in 2.0.
|
||||
|
||||
## Datastore retrieving
|
||||
|
||||
Datastore now no longer requires waiting for it to load first.
|
||||
|
||||
```lua
|
||||
local ds = Datastore:GetDatastore("datastore1")
|
||||
ds:SetAsync("coins", 11)
|
||||
local coins: number = ds:GetAsync("coins")
|
||||
print(coins)
|
||||
```
|
||||
|
||||
You may notice that these function now require Async suffix, which brings us to:
|
||||
|
||||
## Async functions
|
||||
|
||||
Some function will now be required to be async in non compatibility mode. These include but not limited to: Http requests, Datastore data retrieving, Insert via InsertService etc.
|
||||
|
||||
Example HTTP Request made with 2.0:
|
||||
|
||||
```lua
|
||||
local success, res = pcall(function()
|
||||
return Http:GetAsync("http://example.com/")
|
||||
end)
|
||||
print(success, res)
|
||||
```
|
||||
|
||||
To run multiple tasks simultaneously, use `spawn`
|
||||
|
||||
```lua
|
||||
spawn(function()
|
||||
local success, res = pcall(function()
|
||||
return Http:GetAsync("https://example.com")
|
||||
end)
|
||||
print(success, res)
|
||||
end)
|
||||
|
||||
local ds = Datastore:GetDatastore("datastore1")
|
||||
ds:SetAsync("coins", 11)
|
||||
local coins: number = ds:GetAsync("coins")
|
||||
print(coins)
|
||||
```
|
||||
14
main.py
14
main.py
@@ -122,10 +122,18 @@ def define_env(env):
|
||||
</div>"""
|
||||
|
||||
@env.macro
|
||||
def staticclass(className):
|
||||
return """<div data-search-exclude markdown>
|
||||
def staticclass(className = ""):
|
||||
if className != "":
|
||||
return """<div data-search-exclude markdown>
|
||||
!!! tip "Static Class"
|
||||
This object is a static class. It can be accessed by using its name as a keyword.
|
||||
This object is a static class. It can be accessed like this: `%s`.
|
||||
|
||||
Additionally, it cannot be created in the creator menu or with `Instance.New()`.
|
||||
</div>""" % (className)
|
||||
else:
|
||||
return """<div data-search-exclude markdown>
|
||||
!!! tip "Static Class"
|
||||
This object is a static class.
|
||||
|
||||
Additionally, it cannot be created in the creator menu or with `Instance.New()`.
|
||||
</div>"""
|
||||
|
||||
51
package-lock.json
generated
51
package-lock.json
generated
@@ -7,7 +7,56 @@
|
||||
"": {
|
||||
"name": "docs-2",
|
||||
"version": "1.0.0",
|
||||
"license": "ISC"
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"fast-xml-parser": "^5.3.3",
|
||||
"yaml": "^2.8.2"
|
||||
}
|
||||
},
|
||||
"node_modules/fast-xml-parser": {
|
||||
"version": "5.3.3",
|
||||
"resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-5.3.3.tgz",
|
||||
"integrity": "sha512-2O3dkPAAC6JavuMm8+4+pgTk+5hoAs+CjZ+sWcQLkX9+/tHRuTkQh/Oaifr8qDmZ8iEHb771Ea6G8CdwkrgvYA==",
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/NaturalIntelligence"
|
||||
}
|
||||
],
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"strnum": "^2.1.0"
|
||||
},
|
||||
"bin": {
|
||||
"fxparser": "src/cli/cli.js"
|
||||
}
|
||||
},
|
||||
"node_modules/strnum": {
|
||||
"version": "2.1.2",
|
||||
"resolved": "https://registry.npmjs.org/strnum/-/strnum-2.1.2.tgz",
|
||||
"integrity": "sha512-l63NF9y/cLROq/yqKXSLtcMeeyOfnSQlfMSlzFt/K73oIaD8DGaQWd7Z34X9GPiKqP5rbSh84Hl4bOlLcjiSrQ==",
|
||||
"funding": [
|
||||
{
|
||||
"type": "github",
|
||||
"url": "https://github.com/sponsors/NaturalIntelligence"
|
||||
}
|
||||
],
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/yaml": {
|
||||
"version": "2.8.2",
|
||||
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz",
|
||||
"integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==",
|
||||
"license": "ISC",
|
||||
"bin": {
|
||||
"yaml": "bin.mjs"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 14.6"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/eemeli"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,11 +9,15 @@
|
||||
"scripts": {
|
||||
"dev": "npm run gen && mkdocs serve",
|
||||
"build": "npm run gen && mkdocs build",
|
||||
"setup": "npm i && npm run gen && mkdocs build",
|
||||
"setup": "npm i && node autogen/mdgen.js && mkdocs build",
|
||||
"gen": "node autogen/yamlgen.js && node autogen/mdgen.js"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"type": "commonjs"
|
||||
"type": "commonjs",
|
||||
"dependencies": {
|
||||
"fast-xml-parser": "^5.3.3",
|
||||
"yaml": "^2.8.2"
|
||||
}
|
||||
}
|
||||
10
yaml/enums/AddonPermission.yaml
Normal file
10
yaml/enums/AddonPermission.yaml
Normal file
@@ -0,0 +1,10 @@
|
||||
Name: AddonPermission
|
||||
InternalName: AddonPermissionEnum
|
||||
Options:
|
||||
- Name: IORead
|
||||
Description: ""
|
||||
- Name: IOWrite
|
||||
Description: ""
|
||||
- Name: ScriptSource
|
||||
Description: ""
|
||||
Description: ""
|
||||
12
yaml/enums/BlendMode.yaml
Normal file
12
yaml/enums/BlendMode.yaml
Normal file
@@ -0,0 +1,12 @@
|
||||
Name: BlendMode
|
||||
InternalName: BlendModeEnum
|
||||
Options:
|
||||
- Name: Mix
|
||||
Description: ""
|
||||
- Name: Add
|
||||
Description: ""
|
||||
- Name: Subtract
|
||||
Description: ""
|
||||
- Name: Multiply
|
||||
Description: ""
|
||||
Description: ""
|
||||
8
yaml/enums/FontStyle.yaml
Normal file
8
yaml/enums/FontStyle.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
Name: FontStyle
|
||||
InternalName: FontStyleEnum
|
||||
Options:
|
||||
- Name: Normal
|
||||
Description: ""
|
||||
- Name: Italic
|
||||
Description: ""
|
||||
Description: ""
|
||||
22
yaml/enums/FontWeight.yaml
Normal file
22
yaml/enums/FontWeight.yaml
Normal file
@@ -0,0 +1,22 @@
|
||||
Name: FontWeight
|
||||
InternalName: FontWeightEnum
|
||||
Options:
|
||||
- Name: Thin
|
||||
Description: ""
|
||||
- Name: ExtraLight
|
||||
Description: ""
|
||||
- Name: Light
|
||||
Description: ""
|
||||
- Name: Regular
|
||||
Description: ""
|
||||
- Name: Medium
|
||||
Description: ""
|
||||
- Name: SemiBold
|
||||
Description: ""
|
||||
- Name: Bold
|
||||
Description: ""
|
||||
- Name: ExtraBold
|
||||
Description: ""
|
||||
- Name: Black
|
||||
Description: ""
|
||||
Description: ""
|
||||
10
yaml/enums/GradientImageFill.yaml
Normal file
10
yaml/enums/GradientImageFill.yaml
Normal file
@@ -0,0 +1,10 @@
|
||||
Name: GradientImageFill
|
||||
InternalName: GradientImageFillEnum
|
||||
Options:
|
||||
- Name: Linear
|
||||
Description: ""
|
||||
- Name: Radial
|
||||
Description: ""
|
||||
- Name: Square
|
||||
Description: ""
|
||||
Description: ""
|
||||
14
yaml/enums/ParticleEmissionShape.yaml
Normal file
14
yaml/enums/ParticleEmissionShape.yaml
Normal file
@@ -0,0 +1,14 @@
|
||||
Name: ParticleEmissionShape
|
||||
InternalName: ParticleEmissionShapeEnum
|
||||
Options:
|
||||
- Name: Point
|
||||
Description: ""
|
||||
- Name: Sphere
|
||||
Description: ""
|
||||
- Name: SphereSurface
|
||||
Description: ""
|
||||
- Name: Box
|
||||
Description: ""
|
||||
- Name: Ring
|
||||
Description: ""
|
||||
Description: ""
|
||||
8
yaml/enums/ParticleSimulationSpace.yaml
Normal file
8
yaml/enums/ParticleSimulationSpace.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
Name: ParticleSimulationSpace
|
||||
InternalName: ParticleSimulationSpaceEnum
|
||||
Options:
|
||||
- Name: Local
|
||||
Description: ""
|
||||
- Name: World
|
||||
Description: ""
|
||||
Description: ""
|
||||
@@ -44,7 +44,7 @@ Methods:
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Check if player of ID has the achievement, asynchronously.
|
||||
|
||||
56
yaml/types/AddonObject.yaml
Normal file
56
yaml/types/AddonObject.yaml
Normal file
@@ -0,0 +1,56 @@
|
||||
Name: AddonObject
|
||||
BaseType: null
|
||||
Properties:
|
||||
- Name: Identifier
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: AddonName
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: AddonIcon
|
||||
Type: PTImageAsset
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods:
|
||||
- Name: RequestPermissions
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: perms
|
||||
Type: "{ AddonPermissionEnum }"
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: CreateToolItem
|
||||
ReturnType: AddonToolItem
|
||||
Parameters:
|
||||
- Name: txt
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events:
|
||||
- Name: CleanupReceived
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Missing Documentation
|
||||
13
yaml/types/AddonToolItem.yaml
Normal file
13
yaml/types/AddonToolItem.yaml
Normal file
@@ -0,0 +1,13 @@
|
||||
Name: AddonToolItem
|
||||
BaseType: null
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events:
|
||||
- Name: Pressed
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Missing Documentation
|
||||
@@ -1,53 +0,0 @@
|
||||
Name: AssetService
|
||||
BaseType: Instance
|
||||
Properties: []
|
||||
Methods:
|
||||
- Name: NewAsset
|
||||
ReturnType: BaseAsset
|
||||
Parameters:
|
||||
- Name: assetClassName
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Create new asset with the class name
|
||||
- Name: NewPTImage
|
||||
ReturnType: PTImageAsset
|
||||
Parameters:
|
||||
- Name: imgID
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Create new image from Polytoria with the target ID
|
||||
- Name: NewPTAudio
|
||||
ReturnType: PTAudioAsset
|
||||
Parameters:
|
||||
- Name: audioID
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Create new audio from Polytoria with the target ID
|
||||
- Name: NewPTMesh
|
||||
ReturnType: PTMeshAsset
|
||||
Parameters:
|
||||
- Name: assetID
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Create new mesh from Polytoria with the target ID
|
||||
Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
Description: Service for managing assets
|
||||
@@ -12,7 +12,7 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Description: Create new asset with the class name
|
||||
- Name: NewPTImage
|
||||
ReturnType: PTImageAsset
|
||||
Parameters:
|
||||
@@ -23,7 +23,7 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Description: Create new image from Polytoria with the target ID
|
||||
- Name: NewPTAudio
|
||||
ReturnType: PTAudioAsset
|
||||
Parameters:
|
||||
@@ -34,7 +34,7 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Description: Create new audio from Polytoria with the target ID
|
||||
- Name: NewPTMesh
|
||||
ReturnType: PTMeshAsset
|
||||
Parameters:
|
||||
@@ -45,10 +45,32 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Create new mesh from Polytoria with the target ID
|
||||
- Name: GetFileLinkByPath
|
||||
ReturnType: FileLinkAsset
|
||||
Parameters:
|
||||
- Name: path
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: GetFileLinkByID
|
||||
ReturnType: FileLinkAsset
|
||||
Parameters:
|
||||
- Name: id
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Assets
|
||||
Description: Missing Documentation
|
||||
Description: Service for managing/creating assets
|
||||
|
||||
@@ -8,6 +8,20 @@ Properties:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Target font to use
|
||||
- Name: FontWeight
|
||||
Type: FontWeightEnum
|
||||
IsAccessibleByScripts: false
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: FontStyle
|
||||
Type: FontStyleEnum
|
||||
IsAccessibleByScripts: false
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
|
||||
@@ -173,7 +173,7 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
- Name: maxDistance
|
||||
@@ -194,7 +194,7 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
- Name: maxDistance
|
||||
|
||||
@@ -1,6 +1,13 @@
|
||||
Name: ChatService
|
||||
BaseType: Instance
|
||||
Properties: []
|
||||
Properties:
|
||||
- Name: ChatPredicate
|
||||
Type: function
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods:
|
||||
- Name: BroadcastMessage
|
||||
ReturnType: nil
|
||||
@@ -42,6 +49,9 @@ Events:
|
||||
Type: string
|
||||
Description: Fires when new message has been received from either
|
||||
`BroadcastMessage` or `UnicastMessage`
|
||||
- Name: MessageDeclined
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
|
||||
@@ -64,6 +64,20 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Removes the point at the specified index from the color series.
|
||||
- Name: GetOffsets
|
||||
ReturnType: "{ number }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: GetColors
|
||||
ReturnType: "{ Color }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: SetOffset
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
@@ -101,6 +115,21 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Gets the offset at the specified point in the color series.
|
||||
- Name: AddPoint
|
||||
ReturnType: number
|
||||
Parameters:
|
||||
- Name: offset
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: color
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Lerp
|
||||
ReturnType: Color
|
||||
Parameters:
|
||||
|
||||
21
yaml/types/CreatorAddons.yaml
Normal file
21
yaml/types/CreatorAddons.yaml
Normal file
@@ -0,0 +1,21 @@
|
||||
Name: CreatorAddons
|
||||
BaseType: Instance
|
||||
Properties: []
|
||||
Methods:
|
||||
- Name: Register
|
||||
ReturnType: AddonObject
|
||||
Parameters:
|
||||
- Name: identifier
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Addons
|
||||
Description: Missing Documentation
|
||||
@@ -43,9 +43,9 @@ Methods:
|
||||
IsStatic: false
|
||||
Description: Commit the current action
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
StaticAlias: History
|
||||
Description: CreatorHistory is a class that manages history (undo-redo) of this
|
||||
game instance. This class is only available in the creator.
|
||||
|
||||
@@ -24,6 +24,13 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Select all children of the instance
|
||||
- Name: GetSelected
|
||||
ReturnType: "{ Instance }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Deselect
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
@@ -64,10 +71,16 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Check if instance has been selected
|
||||
Events: []
|
||||
IsStatic: false
|
||||
Events:
|
||||
- Name: Selected
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
- Name: Deselected
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
StaticAlias: Selections
|
||||
Description: CreatorSelections is an object that manages selections in the game
|
||||
instance. This class is only available in the creator.
|
||||
|
||||
@@ -16,7 +16,7 @@ Methods:
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Retrieves a value from the datastore asynchronously using the
|
||||
@@ -32,7 +32,7 @@ Methods:
|
||||
Type: any
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Stores a value in the datastore asynchronously using the specified key.
|
||||
@@ -43,14 +43,18 @@ Methods:
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Removes a value from the datastore asynchronously using the specified key.
|
||||
Events:
|
||||
- Name: Loaded
|
||||
Arguments: ""
|
||||
Description: Fires when this datastore has been loaded
|
||||
- Name: Disconnect
|
||||
ReturnType: nil
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
|
||||
@@ -153,72 +153,6 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Rotates the object by the specified Euler angles.
|
||||
- Name: InverseTransformPoint
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
- Name: point
|
||||
Type: Vector3
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Transforms a point from world space to local space.
|
||||
- Name: TransformPoint
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
- Name: point
|
||||
Type: Vector3
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Transforms a point from local space to world space.
|
||||
- Name: InverseTransformDirection
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
- Name: direction
|
||||
Type: Vector3
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Transforms a direction from world space to local space.
|
||||
- Name: TransformDirection
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
- Name: direction
|
||||
Type: Vector3
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Transforms a direction from local space to world space.
|
||||
- Name: InverseTransformVector
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
- Name: vector
|
||||
Type: Vector3
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Transforms a vector from world space to local space.
|
||||
- Name: InverseTransformPosition
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
- Name: position
|
||||
Type: Vector3
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Transforms a position from world space to local space.
|
||||
- Name: GetBounds
|
||||
ReturnType: Bounds
|
||||
Parameters: []
|
||||
|
||||
@@ -48,7 +48,7 @@ Methods:
|
||||
IsOptional: true
|
||||
DefaultValue: "10000"
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -57,7 +57,7 @@ Methods:
|
||||
Description: Casts a ray from origin with a specified direction and returns a
|
||||
RayResult for the first hit object.
|
||||
- Name: RaycastAll
|
||||
ReturnType: table
|
||||
ReturnType: "{ RayResult }"
|
||||
Parameters:
|
||||
- Name: origin
|
||||
Type: Vector3
|
||||
@@ -72,7 +72,7 @@ Methods:
|
||||
IsOptional: true
|
||||
DefaultValue: "1000"
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -81,7 +81,7 @@ Methods:
|
||||
Description: Casts a ray from origin with a specified direction and returns a
|
||||
RayResult array for all hit objects.
|
||||
- Name: OverlapSphere
|
||||
ReturnType: table
|
||||
ReturnType: "{ Instance }"
|
||||
Parameters:
|
||||
- Name: origin
|
||||
Type: Vector3
|
||||
@@ -92,7 +92,7 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -101,7 +101,7 @@ Methods:
|
||||
Description: Returns a list of instances intersecting with the sphere in the
|
||||
given position and radius.
|
||||
- Name: OverlapBox
|
||||
ReturnType: table
|
||||
ReturnType: "{ Instance }"
|
||||
Parameters:
|
||||
- Name: pos
|
||||
Type: Vector3
|
||||
@@ -116,7 +116,7 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
|
||||
@@ -29,6 +29,13 @@ Properties:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The uptime of this game in seconds.
|
||||
- Name: ServerTime
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: InstanceCount
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
|
||||
@@ -15,6 +15,13 @@ Properties:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the max range that this object can be dragged.
|
||||
- Name: UseDragForce
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: PermissionMode
|
||||
Type: GrabbablePermissionModeEnum
|
||||
IsAccessibleByScripts: true
|
||||
|
||||
@@ -1,52 +1,52 @@
|
||||
Name: Vehicle
|
||||
BaseType: PhysicalModel
|
||||
Name: GradientImageAsset
|
||||
BaseType: ImageAsset
|
||||
Properties:
|
||||
- Name: MaxSpeed
|
||||
- Name: Series
|
||||
Type: ColorSeries
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Width
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the forward force limit in kg/s.
|
||||
- Name: SteerLimit
|
||||
Description: Missing Documentation
|
||||
- Name: Height
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the steering limit in degrees.
|
||||
- Name: Force
|
||||
Type: number
|
||||
Description: Missing Documentation
|
||||
- Name: Fill
|
||||
Type: GradientImageFillEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the forward force in kg/s.
|
||||
- Name: Brake
|
||||
Type: number
|
||||
Description: Missing Documentation
|
||||
- Name: FillFrom
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the break amount in kg/s.
|
||||
- Name: Steering
|
||||
Type: number
|
||||
Description: Missing Documentation
|
||||
- Name: FillTo
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the steering angle in degrees
|
||||
- Name: Driver
|
||||
Type: Player
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the current driver of this vehicle.
|
||||
Description: Missing Documentation
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Vehicle class represents a vehicle that can be driven by a player
|
||||
Description: Missing Documentation
|
||||
@@ -1,10 +1,10 @@
|
||||
Name: Hidden
|
||||
BaseType: Instance
|
||||
BaseType: HiddenBase
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
StaticAlias: Hidden
|
||||
Description: Hidden is a object used for hiding instances.
|
||||
|
||||
10
yaml/types/HiddenBase.yaml
Normal file
10
yaml/types/HiddenBase.yaml
Normal file
@@ -0,0 +1,10 @@
|
||||
Name: HiddenBase
|
||||
BaseType: Instance
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Missing Documentation
|
||||
@@ -30,6 +30,13 @@ Properties:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The response payload returned by the server as a string buffer.
|
||||
- Name: Buffer
|
||||
Type: buffer
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
|
||||
@@ -104,6 +104,97 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sends a PATCH request to the specified url.
|
||||
- Name: GetBufferAsync
|
||||
ReturnType: buffer
|
||||
Parameters:
|
||||
- Name: url
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: headers
|
||||
Type: table
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: PostBufferAsync
|
||||
ReturnType: buffer
|
||||
Parameters:
|
||||
- Name: url
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: body
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: headers
|
||||
Type: table
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: PutBufferAsync
|
||||
ReturnType: buffer
|
||||
Parameters:
|
||||
- Name: url
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: body
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: headers
|
||||
Type: table
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: DeleteBufferAsync
|
||||
ReturnType: buffer
|
||||
Parameters:
|
||||
- Name: url
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: body
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: headers
|
||||
Type: table
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: PatchBufferAsync
|
||||
ReturnType: buffer
|
||||
Parameters:
|
||||
- Name: url
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: body
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: headers
|
||||
Type: table
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
|
||||
@@ -3,7 +3,7 @@ BaseType: Instance
|
||||
Properties: []
|
||||
Methods:
|
||||
- Name: ReadBytesFromPath
|
||||
ReturnType: string
|
||||
ReturnType: buffer
|
||||
Parameters:
|
||||
- Name: path
|
||||
Type: string
|
||||
@@ -13,6 +13,17 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Read the file data from path
|
||||
- Name: ReadTextFromPath
|
||||
ReturnType: string
|
||||
Parameters:
|
||||
- Name: path
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: WriteBytesToPath
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
@@ -21,22 +32,37 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: bytes
|
||||
Type: string
|
||||
Type: buffer
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: true
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Write data to file in the project
|
||||
- Name: WriteTextToPath
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: path
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: txt
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: ListProjectFiles
|
||||
ReturnType: table
|
||||
ReturnType: "{ string }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: List all files in the project
|
||||
- Name: ReadBytesFromID
|
||||
ReturnType: string
|
||||
ReturnType: buffer
|
||||
Parameters:
|
||||
- Name: id
|
||||
Type: string
|
||||
|
||||
52
yaml/types/ImageSky.yaml
Normal file
52
yaml/types/ImageSky.yaml
Normal file
@@ -0,0 +1,52 @@
|
||||
Name: ImageSky
|
||||
BaseType: Sky
|
||||
Properties:
|
||||
- Name: TopImage
|
||||
Type: ImageAsset
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: BottomImage
|
||||
Type: ImageAsset
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: LeftImage
|
||||
Type: ImageAsset
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: RightImage
|
||||
Type: ImageAsset
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: FrontImage
|
||||
Type: ImageAsset
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: BackImage
|
||||
Type: ImageAsset
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Missing Documentation
|
||||
@@ -83,7 +83,7 @@ Methods:
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -172,13 +172,17 @@ Events:
|
||||
Description: Fires when gamepad has been disconnected
|
||||
- Name: KeyDown
|
||||
Arguments:
|
||||
Name: keycode
|
||||
Type: KeyCodeEnum
|
||||
- Name: keycode
|
||||
Type: KeyCodeEnum
|
||||
- Name: gameFocused
|
||||
Type: boolean
|
||||
Description: Fires when key has been pressed
|
||||
- Name: KeyUp
|
||||
Arguments:
|
||||
Name: keycode
|
||||
Type: KeyCodeEnum
|
||||
- Name: keycode
|
||||
Type: KeyCodeEnum
|
||||
- Name: gameFocused
|
||||
Type: boolean
|
||||
Description: Fires when key has been released
|
||||
- Name: AxisValueChanged
|
||||
Arguments:
|
||||
|
||||
@@ -17,15 +17,22 @@ Properties:
|
||||
Description: Determine if children is editable, this is to be used if this
|
||||
instance is a Linked model. Only used in creator.
|
||||
- Name: Tags
|
||||
Type: table
|
||||
Type: "{ string }"
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Tags associated with this instance.
|
||||
- Name: Archivable
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods:
|
||||
- Name: GetDescendants
|
||||
ReturnType: table
|
||||
ReturnType: "{ Instance }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
@@ -68,6 +75,28 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Finds a child of this instance by class name.
|
||||
- Name: FindChildWithTag
|
||||
ReturnType: Instance
|
||||
Parameters:
|
||||
- Name: tag
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: GetChildrenWithTag
|
||||
ReturnType: "{ Instance }"
|
||||
Parameters:
|
||||
- Name: tag
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: FindAncestorByClass
|
||||
ReturnType: Instance
|
||||
Parameters:
|
||||
@@ -106,14 +135,14 @@ Methods:
|
||||
IsStatic: false
|
||||
Description: Move children to specified index
|
||||
- Name: GetChildren
|
||||
ReturnType: table
|
||||
ReturnType: "{ Instance }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Gets all children of this instance.
|
||||
- Name: GetChildrenOfClass
|
||||
ReturnType: table
|
||||
ReturnType: "{ Instance }"
|
||||
Parameters:
|
||||
- Name: className
|
||||
Type: string
|
||||
|
||||
@@ -1,54 +0,0 @@
|
||||
Name: InteractionPrompt
|
||||
BaseType: Dynamic
|
||||
Properties:
|
||||
- Name: Title
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: WIP
|
||||
- Name: SubTitle
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: WIP
|
||||
- Name: HoldDuration
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: WIP
|
||||
- Name: Key
|
||||
Type: KeyCodeEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: WIP
|
||||
- Name: UseDefaultUI
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: WIP
|
||||
Methods: []
|
||||
Events:
|
||||
- Name: Triggered
|
||||
Arguments: ""
|
||||
Description: WIP
|
||||
- Name: TriggerStarted
|
||||
Arguments: ""
|
||||
Description: WIP
|
||||
- Name: TriggerReleased
|
||||
Arguments: ""
|
||||
Description: WIP
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: WIP class, not functional yet
|
||||
@@ -1,5 +1,5 @@
|
||||
Name: Inventory
|
||||
BaseType: Hidden
|
||||
BaseType: HiddenBase
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
|
||||
@@ -64,6 +64,13 @@ Properties:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether an animation is currently playing on the mesh.
|
||||
- Name: Loading
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods:
|
||||
- Name: PlayAnimation
|
||||
ReturnType: nil
|
||||
@@ -96,20 +103,23 @@ Methods:
|
||||
IsStatic: false
|
||||
Description: Stops the specified animation on the mesh.
|
||||
- Name: GetAnimations
|
||||
ReturnType: table
|
||||
ReturnType: "{ string }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Gets a list of all animations available on the mesh.
|
||||
- Name: GetAnimationInfo
|
||||
ReturnType: table
|
||||
ReturnType: "{ MeshAnimationInfo }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events: []
|
||||
Events:
|
||||
- Name: Loaded
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
|
||||
10
yaml/types/MissingInstance.yaml
Normal file
10
yaml/types/MissingInstance.yaml
Normal file
@@ -0,0 +1,10 @@
|
||||
Name: MissingInstance
|
||||
BaseType: Instance
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Missing Documentation
|
||||
@@ -50,6 +50,13 @@ Properties:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the offset position of the NPC's nametag.
|
||||
- Name: NametagVisibleRadius
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: DisplayName
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
|
||||
@@ -122,6 +122,21 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Adds an Instance value to the message with the specified key.
|
||||
- Name: AddBuffer
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: key
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: buffer
|
||||
Type: buffer
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: GetString
|
||||
ReturnType: string
|
||||
Parameters:
|
||||
@@ -210,6 +225,17 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Gets an Instance value from the message with the specified key.
|
||||
- Name: GetBuffer
|
||||
ReturnType: buffer
|
||||
Parameters:
|
||||
- Name: key
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: New
|
||||
ReturnType: NetMessage
|
||||
Parameters: []
|
||||
|
||||
@@ -16,8 +16,8 @@ Methods:
|
||||
Parameters:
|
||||
- Name: msg
|
||||
Type: NetMessage
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
- Name: _
|
||||
Type: any
|
||||
IsOptional: true
|
||||
@@ -31,12 +31,12 @@ Methods:
|
||||
Parameters:
|
||||
- Name: msg
|
||||
Type: NetMessage
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
- Name: player
|
||||
Type: Player
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
@@ -46,8 +46,8 @@ Methods:
|
||||
Parameters:
|
||||
- Name: msg
|
||||
Type: NetMessage
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
@@ -62,8 +62,6 @@ Events:
|
||||
Description: Fires when server receives message from client
|
||||
- Name: InvokedClient
|
||||
Arguments:
|
||||
- Name: sender
|
||||
Type: nil
|
||||
- Name: msg
|
||||
Type: NetMessage
|
||||
Description: Fires when client receives message from server
|
||||
|
||||
@@ -27,7 +27,7 @@ Methods:
|
||||
- Name: __tostring
|
||||
ReturnType: string
|
||||
Parameters:
|
||||
- Name: signal
|
||||
- Name: _
|
||||
Type: PTSignal
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
|
||||
@@ -1,9 +1,16 @@
|
||||
Name: Particles
|
||||
BaseType: Dynamic
|
||||
Properties:
|
||||
- Name: Playing
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Image
|
||||
Type: ImageAsset
|
||||
IsAccessibleByScripts: false
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
@@ -30,12 +37,61 @@ Properties:
|
||||
IsStatic: false
|
||||
Description: Determines the number of particles emitted.
|
||||
- Name: Gravity
|
||||
Type: number
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the gravity effect applied to the particles.
|
||||
- Name: VelocityDirection
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: InitialVelocity
|
||||
Type: NumberRange
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Spread
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Flatness
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Scale
|
||||
Type: NumberRange
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: HueVariation
|
||||
Type: NumberRange
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: BlendMode
|
||||
Type: BlendModeEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Shaded
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
@@ -43,13 +99,27 @@ Properties:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the particles are shaded.
|
||||
- Name: Autoplay
|
||||
Type: boolean
|
||||
- Name: EmissionShape
|
||||
Type: ParticleEmissionShapeEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the particle system plays automatically.
|
||||
Description: Missing Documentation
|
||||
- Name: EmissionShapeScale
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: SimulationSpace
|
||||
Type: ParticleSimulationSpaceEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods:
|
||||
- Name: Play
|
||||
ReturnType: nil
|
||||
|
||||
@@ -42,7 +42,7 @@ Methods:
|
||||
IsStatic: false
|
||||
Description: Sets the network authority of this object to the specified player.
|
||||
- Name: GetTouching
|
||||
ReturnType: table
|
||||
ReturnType: "{ Physical }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
|
||||
@@ -43,7 +43,7 @@ Methods:
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: plrs
|
||||
Type: table
|
||||
Type: "{ Player }"
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: to
|
||||
@@ -73,7 +73,7 @@ Methods:
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: players
|
||||
Type: table
|
||||
Type: "{ Player }"
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: accessID
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
Name: PlayerDefaults
|
||||
BaseType: Hidden
|
||||
BaseType: HiddenBase
|
||||
Properties:
|
||||
- Name: MaxHealth
|
||||
Type: number
|
||||
|
||||
@@ -24,7 +24,7 @@ Properties:
|
||||
Description: The number of players currently in the game.
|
||||
Methods:
|
||||
- Name: GetPlayers
|
||||
ReturnType: table
|
||||
ReturnType: "{ Player }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
|
||||
@@ -131,6 +131,10 @@ Methods:
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: loadTool
|
||||
Type: boolean
|
||||
IsOptional: true
|
||||
DefaultValue: "True"
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
@@ -156,7 +160,18 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Set Bone override mode
|
||||
Description: Missing Documentation
|
||||
- Name: SetAnimationOverrideTo
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: to
|
||||
Type: boolean
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: SetBoneOverridePosition
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
@@ -171,7 +186,7 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Set bone override position
|
||||
Description: Missing Documentation
|
||||
- Name: SetBoneOverrideRotation
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
@@ -186,7 +201,7 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Set bone override rotation
|
||||
Description: Missing Documentation
|
||||
- Name: GetBoneOverridePosition
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
@@ -197,7 +212,7 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Get bone override position
|
||||
Description: Missing Documentation
|
||||
- Name: GetBoneOverrideRotation
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
@@ -208,7 +223,7 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Get bone override rotation
|
||||
Description: Missing Documentation
|
||||
Events:
|
||||
- Name: RagdollStarted
|
||||
Arguments: ""
|
||||
|
||||
@@ -2,8 +2,8 @@ Name: PurchasesService
|
||||
BaseType: Instance
|
||||
Properties: []
|
||||
Methods:
|
||||
- Name: Prompt
|
||||
ReturnType: nil
|
||||
- Name: PromptAsync
|
||||
ReturnType: boolean
|
||||
Parameters:
|
||||
- Name: player
|
||||
Type: Player
|
||||
@@ -13,10 +13,10 @@ Methods:
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsAsync: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Prompts the specified player to purchase the asset with the given asset ID.
|
||||
Description: Missing Documentation
|
||||
- Name: OwnsItemAsync
|
||||
ReturnType: boolean
|
||||
Parameters:
|
||||
|
||||
@@ -3,7 +3,7 @@ BaseType: Instance
|
||||
Properties:
|
||||
- Name: Source
|
||||
Type: string
|
||||
IsAccessibleByScripts: false
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
@@ -14,7 +14,7 @@ Properties:
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine if this script should run, can be set to false in runtime to stop running script when it yields.
|
||||
Description: Missing Documentation
|
||||
- Name: LinkedScript
|
||||
Type: FileLinkAsset
|
||||
IsAccessibleByScripts: false
|
||||
@@ -60,6 +60,17 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Calls a function in the script asynchronously with the given arguments.
|
||||
- Name: LinkWithScriptFile
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: scriptPath
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
|
||||
@@ -2,6 +2,46 @@ Name: ScriptSharedTable
|
||||
BaseType: null
|
||||
Properties: []
|
||||
Methods:
|
||||
- Name: Clear
|
||||
ReturnType: nil
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Remove
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: key
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: ClearPrefix
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: prefix
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: ClearSuffix
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: suffix
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: __index
|
||||
ReturnType: any
|
||||
Parameters:
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
Name: ServerHidden
|
||||
BaseType: Hidden
|
||||
BaseType: HiddenBase
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
|
||||
10
yaml/types/SocialService.yaml
Normal file
10
yaml/types/SocialService.yaml
Normal file
@@ -0,0 +1,10 @@
|
||||
Name: SocialService
|
||||
BaseType: Instance
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Social
|
||||
Description: Missing Documentation
|
||||
@@ -50,7 +50,7 @@ Properties:
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if this sound is paused
|
||||
Description: Missing Documentation
|
||||
- Name: MaxDistance
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
@@ -112,7 +112,7 @@ Methods:
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Pause the sound if it is currently playing.
|
||||
Description: Missing Documentation
|
||||
- Name: Stop
|
||||
ReturnType: nil
|
||||
Parameters: []
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
Name: Temporary
|
||||
BaseType: Hidden
|
||||
BaseType: ServerHidden
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
|
||||
@@ -210,6 +210,29 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Tweens a Vector3 between two specified values.
|
||||
- Name: TweenQuaternion
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: from
|
||||
Type: Quaternion
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: to
|
||||
Type: Quaternion
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: time
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: callback
|
||||
Type: function
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Play
|
||||
ReturnType: nil
|
||||
Parameters: []
|
||||
|
||||
@@ -77,14 +77,21 @@ Properties:
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: If true, this UI field can grab the UI focus via cursor.
|
||||
Description: Missing Documentation
|
||||
- Name: ZIndex
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The Z-Index layer value
|
||||
Description: Missing Documentation
|
||||
- Name: AbsolutePosition
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: AbsoluteSize
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
|
||||
@@ -90,6 +90,12 @@ Events:
|
||||
Name: text
|
||||
Type: string
|
||||
Description: Fires when user changed the text
|
||||
- Name: FocusEnter
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
- Name: FocusExit
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
Name: VehicleSeat
|
||||
BaseType: Seat
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: A seat for Vehicle
|
||||
@@ -1,31 +0,0 @@
|
||||
Name: VehicleWheel
|
||||
BaseType: Dynamic
|
||||
Properties:
|
||||
- Name: UseForTraction
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if this wheel should be used for traction.
|
||||
- Name: UseForSteering
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if this wheel should be used for steering.
|
||||
- Name: Radius
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the radius for this wheel.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: A wheel for the vehicle
|
||||
Reference in New Issue
Block a user