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`)
|
||||
@@ -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)
|
||||
```
|
||||
12
main.py
12
main.py
@@ -122,10 +122,18 @@ def define_env(env):
|
||||
</div>"""
|
||||
|
||||
@env.macro
|
||||
def staticclass(className):
|
||||
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>"""
|
||||
|
||||
6
autogen/package-lock.json → package-lock.json
generated
6
autogen/package-lock.json → package-lock.json
generated
@@ -1,9 +1,13 @@
|
||||
{
|
||||
"name": "autogen",
|
||||
"name": "docs-2",
|
||||
"version": "1.0.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "docs-2",
|
||||
"version": "1.0.0",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"fast-xml-parser": "^5.3.3",
|
||||
"yaml": "^2.8.2"
|
||||
@@ -9,10 +9,15 @@
|
||||
"scripts": {
|
||||
"dev": "npm run gen && mkdocs serve",
|
||||
"build": "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: ""
|
||||
@@ -6,11 +6,13 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Specifies the character attachment point
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Accessory represents a attachable object that can be equipped by a
|
||||
CharacterModel.
|
||||
|
||||
@@ -6,6 +6,7 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine if achievement sound effect should play when user
|
||||
receives an achievement
|
||||
- Name: NotifyAchievements
|
||||
@@ -13,28 +14,10 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine if achievement toast should show when user receives an
|
||||
achievement
|
||||
Methods:
|
||||
- Name: Award
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: userID
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: achievementID
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: callback
|
||||
Type: function
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Award achievement to the user
|
||||
- Name: AwardAsync
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
@@ -50,25 +33,6 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Award achievement to the user asynchronously.
|
||||
- Name: HasAchievement
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: userID
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: achievementID
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: callback
|
||||
Type: function
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Check if user of ID has the achievement.
|
||||
- Name: HasAchievementAsync
|
||||
ReturnType: boolean
|
||||
Parameters:
|
||||
@@ -80,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.
|
||||
@@ -93,4 +57,5 @@ Events:
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Achievements
|
||||
Description: Service for managing achievements
|
||||
|
||||
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
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: WIP class
|
||||
|
||||
@@ -42,4 +42,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: WIP class
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Name: AssetService
|
||||
Name: AssetsService
|
||||
BaseType: Instance
|
||||
Properties: []
|
||||
Methods:
|
||||
@@ -46,8 +46,31 @@ Methods:
|
||||
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
|
||||
Description: Service for managing assets
|
||||
StaticAlias: Assets
|
||||
Description: Service for managing/creating assets
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Abstract class for audio
|
||||
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Base class for all assets
|
||||
|
||||
@@ -22,5 +22,6 @@ Events:
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: BindableEvent are events that can be called to communicate between
|
||||
scripts in the same boundary.
|
||||
|
||||
@@ -6,18 +6,21 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the target position that the body applies forces to get to.
|
||||
- Name: Force
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines how much force the body applies.
|
||||
- Name: AcceptanceDistance
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines how close the body has to be to the target position to
|
||||
stop applying forces to it.
|
||||
Methods: []
|
||||
@@ -25,5 +28,6 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: BodyPosition are objects that apply a force to their parent until
|
||||
it moves toward the target position.
|
||||
|
||||
@@ -6,10 +6,12 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The value of this object.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: BoolValue is a ValueBase that stores a boolean.
|
||||
|
||||
@@ -6,36 +6,42 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the center point of the bounds.
|
||||
- Name: Size
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the size of the bounds.
|
||||
- Name: Extents
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the extents of the bounds.
|
||||
- Name: Start
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The origin point
|
||||
- Name: End
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The ending point
|
||||
- Name: Volume
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the volume of the bounds.
|
||||
Methods:
|
||||
- Name: New
|
||||
@@ -60,6 +66,32 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Creates a new Bounds object with the specified position and size.
|
||||
- Name: __eq
|
||||
ReturnType: boolean
|
||||
Parameters:
|
||||
- Name: a
|
||||
Type: Bounds
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: b
|
||||
Type: Bounds
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Missing Documentation
|
||||
- Name: __tostring
|
||||
ReturnType: string
|
||||
Parameters:
|
||||
- Name: v
|
||||
Type: Bounds
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Missing Documentation
|
||||
- Name: ClosestPoint
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
@@ -188,4 +220,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Represents a bounding box in 3D space.
|
||||
|
||||
@@ -6,10 +6,12 @@ Properties:
|
||||
IsAccessibleByScripts: false
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The target audio to use
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Audio asset that's built-in with the client
|
||||
|
||||
@@ -6,10 +6,26 @@ Properties:
|
||||
IsAccessibleByScripts: false
|
||||
IsReadOnly: false
|
||||
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
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Font asset that's built-in with the client
|
||||
|
||||
@@ -6,36 +6,42 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines or returns the camera's current mode.
|
||||
- Name: FOV
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines or returns the camera's field of view.
|
||||
- Name: ClipThroughWalls
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the camera should clip through walls.
|
||||
- Name: MinDistance
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The camera's minimum distance from the player in Follow mode.
|
||||
- Name: MaxDistance
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines camera's maximum distance from the player in Follow mode.
|
||||
- Name: Distance
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the distance between the camera and the player when the
|
||||
camera is in Follow mode.
|
||||
- Name: ScrollSensitivity
|
||||
@@ -43,12 +49,14 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the scroll move speed of the camera.
|
||||
- Name: Orthographic
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the camera should render in orthographic
|
||||
(2D) mode or not (3D).
|
||||
- Name: FollowLerp
|
||||
@@ -56,90 +64,105 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not to use lerping in Follow mode.
|
||||
- Name: LerpSpeed
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the lerp speed of the camera when lerping is enabled.
|
||||
- Name: OrthographicSize
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the half-size of the camera when in orthographic mode.
|
||||
- Name: PositionOffset
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the camera's offset from its position.
|
||||
- Name: RotationOffset
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the camera's offset from its rotation.
|
||||
- Name: IsFirstPerson
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns whether or not the camera is in first person.
|
||||
- Name: CanLock
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine if camera can be ctrl locked.
|
||||
- Name: SensitivityMultiplier
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Multipler for camera sensitivity
|
||||
- Name: Sensitivity
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Current sensitivity of the camera
|
||||
- Name: HorizontalSpeed
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the horizontal movement speed of the camera in Follow mode.
|
||||
- Name: VerticalSpeed
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the vertical move speed of the camera.
|
||||
- Name: ScrollLerpSpeed
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the lerp amount when scrolling
|
||||
- Name: CtrlLocked
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine if camera is in Ctrl lock mode
|
||||
- Name: AlwaysLocked
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine if camera should always be in locked mode
|
||||
- Name: Target
|
||||
Type: Dynamic
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The target of Follow mode
|
||||
Methods:
|
||||
- Name: ViewportPointToRay
|
||||
@@ -150,7 +173,7 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
- Name: maxDistance
|
||||
@@ -171,7 +194,7 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
- Name: maxDistance
|
||||
@@ -258,4 +281,5 @@ Events:
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Camera is a class that represents the local player's camera.
|
||||
|
||||
@@ -6,24 +6,28 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns whenever the capture is on cooldown.
|
||||
- Name: CanCapture
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if user/scripts can take a picture.
|
||||
- Name: DefaultCaptureOverlay
|
||||
Type: UIField
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Default capture overlay for all captures
|
||||
- Name: SpectatorAttach
|
||||
Type: Dynamic
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Attaches a spectator camera at dynamic for use with spectator mode.
|
||||
Methods:
|
||||
- Name: TakePhotoAtDynamic
|
||||
@@ -74,4 +78,5 @@ Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Capture
|
||||
Description: Service for capturing photos
|
||||
|
||||
@@ -6,6 +6,7 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The animator for this character
|
||||
Methods:
|
||||
- Name: GetAttachment
|
||||
@@ -23,4 +24,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Base class for Character Models
|
||||
|
||||
@@ -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,7 +49,11 @@ 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
|
||||
StaticAlias: Chat
|
||||
Description: Chat is a static class used for various actions regarding the chat.
|
||||
|
||||
@@ -6,5 +6,6 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: ClientScript is a script that runs locally for each player. It can
|
||||
only see what the player can see.
|
||||
|
||||
@@ -6,24 +6,28 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Red color component
|
||||
- Name: G
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Green color component
|
||||
- Name: B
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Blue color component
|
||||
- Name: A
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Alpha (opacity) color component
|
||||
Methods:
|
||||
- Name: New
|
||||
@@ -86,6 +90,77 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Creates a new Color with the set R, G, B and A values
|
||||
- Name: __add
|
||||
ReturnType: Color
|
||||
Parameters:
|
||||
- Name: a
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: b
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Missing Documentation
|
||||
- Name: __sub
|
||||
ReturnType: Color
|
||||
Parameters:
|
||||
- Name: a
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: b
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Missing Documentation
|
||||
- Name: __mul
|
||||
ReturnType: any
|
||||
Parameters:
|
||||
- Name: a
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: b
|
||||
Type: any
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Missing Documentation
|
||||
- Name: __eq
|
||||
ReturnType: boolean
|
||||
Parameters:
|
||||
- Name: a
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: b
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Missing Documentation
|
||||
- Name: __tostring
|
||||
ReturnType: string
|
||||
Parameters:
|
||||
- Name: v
|
||||
Type: Color
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Missing Documentation
|
||||
- Name: Random
|
||||
ReturnType: Color
|
||||
Parameters: []
|
||||
@@ -127,6 +202,7 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: >-
|
||||
Color is a data type that represents a color.
|
||||
|
||||
|
||||
@@ -6,29 +6,34 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine the brightness adjustment
|
||||
- Name: Contrast
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine the contrast adjustment
|
||||
- Name: Saturation
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine the saturation adjustment
|
||||
- Name: TintColor
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine the tint color
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: ColorAdjustModifier is a LightingModifier that allows the
|
||||
adjustment of lighting
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
Name: ColorSeries
|
||||
BaseType: ValueType
|
||||
BaseType: null
|
||||
Properties:
|
||||
- Name: PointCount
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the point count of this color series
|
||||
Methods:
|
||||
- Name: New
|
||||
@@ -30,6 +31,13 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Create color series by this color range
|
||||
- Name: Clear
|
||||
ReturnType: nil
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: SetColor
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
@@ -56,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:
|
||||
@@ -93,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:
|
||||
@@ -108,5 +145,6 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Color series is a data type that represents a collection of color
|
||||
and points, also known as gradient.
|
||||
|
||||
@@ -6,10 +6,12 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The value of this object.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: ColorValue is an object that holds a Color value.
|
||||
|
||||
@@ -6,6 +6,7 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the user card (in the upper right hand
|
||||
corner above the leaderboard) is visible.
|
||||
- Name: UseChat
|
||||
@@ -13,46 +14,61 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the chat box is visible.
|
||||
- Name: UseHealthBar
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the player's health bar is visible.
|
||||
- Name: UseLeaderboard
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the player list/leaderboard is visible.
|
||||
- Name: UseHotbar
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the hot bar is visible.
|
||||
- Name: UseBackpack
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: UseMenuButton
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the menu button is visible.
|
||||
- Name: UseEmoteWheel
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the emote wheel is visible.
|
||||
- Name: CanRespawn
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the player can respawn.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: CoreUI
|
||||
Description: CoreUI is a static class that allows for the toggling of certain core GUI.
|
||||
|
||||
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
|
||||
@@ -6,6 +6,7 @@ Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: CreatorContext
|
||||
Description: CreatorContextService is a service that manage per game specific
|
||||
tools, such as Selections and History. This class is only available in the
|
||||
creator.
|
||||
|
||||
@@ -3,8 +3,9 @@ BaseType: PlayerGUI
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: PlayerGUI
|
||||
Description: CreatorGUI is an object that allows GUI to overlay on top of the
|
||||
viewport in the creator. This class is only available in the creator.
|
||||
|
||||
@@ -43,8 +43,9 @@ Methods:
|
||||
IsStatic: false
|
||||
Description: Commit the current action
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: History
|
||||
Description: CreatorHistory is a class that manages history (undo-redo) of this
|
||||
game instance. This class is only available in the creator.
|
||||
|
||||
@@ -6,59 +6,69 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the target tool mode
|
||||
- Name: TargetPartColor
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the target part color
|
||||
- Name: TargetPartMaterial
|
||||
Type: PartMaterialEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the target part material
|
||||
- Name: MoveSnapEnabled
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the move snapping value
|
||||
- Name: MoveSnapping
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns whenever the move snapping is enabled by the user
|
||||
- Name: UserMoveSnapping
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the move snapping value defined by the user
|
||||
- Name: RotateSnapEnabled
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns whenever the rotate snapping is enabled by the user
|
||||
- Name: RotateSnapping
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the rotate snapping value
|
||||
- Name: UserRotateSnapping
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the rotate snapping value defined by the user
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: CreatorInterface represent the user interface of the creator. 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,9 +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: Selections
|
||||
Description: CreatorSelections is an object that manages selections in the game
|
||||
instance. This class is only available in the creator.
|
||||
|
||||
@@ -6,24 +6,21 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: The interface
|
||||
- Name: Clipboard
|
||||
Type: CreatorClipboard
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
Description: The clipboard
|
||||
- Name: CurrentGame
|
||||
Type: Game
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Current active game
|
||||
- Name: LocalTestActive
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns true if local test is active
|
||||
Methods: []
|
||||
Events:
|
||||
@@ -36,5 +33,6 @@ Events:
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Creator
|
||||
Description: CreatorService is the class that manages the creator. This class is
|
||||
only available in the creator.
|
||||
|
||||
@@ -6,6 +6,7 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The key identifying this Datastore connection.
|
||||
Methods:
|
||||
- Name: GetAsync
|
||||
@@ -15,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
|
||||
@@ -31,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.
|
||||
@@ -42,15 +43,20 @@ 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
|
||||
StaticAlias: null
|
||||
Description: Datastore is an object that represent datastore connection.
|
||||
|
||||
@@ -17,5 +17,6 @@ Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Datastore
|
||||
Description: Datastore (not to be confused with the Datastore data type) is a
|
||||
service used for storing data between place sessions.
|
||||
|
||||
@@ -6,23 +6,27 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The image texture applied to the decal.
|
||||
- Name: Energy
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Energy multiplier for the decal.
|
||||
- Name: Color
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The color tint applied to the decal.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Decals are objects that can have an image texture and are wrapped
|
||||
around other objects.
|
||||
|
||||
@@ -6,66 +6,84 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The position of the object.
|
||||
- Name: Rotation
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The rotation of the object.
|
||||
- Name: Size
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The size of the object.
|
||||
- Name: LocalPosition
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The position of the object relative to its parent.
|
||||
- Name: LocalRotation
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The rotation of the object relative to its parent.
|
||||
- Name: LocalSize
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The size of the object relative to its parent.
|
||||
- Name: Quaternion
|
||||
Type: Quaternion
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The rotation of the object represented as a quaternion.
|
||||
- Name: LocalQuaternion
|
||||
Type: Quaternion
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Locked
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the object can be selected in the Creator.
|
||||
- Name: Forward
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The forward direction vector of the object.
|
||||
- Name: Right
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The right direction vector of the object.
|
||||
- Name: Up
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The up direction vector of the object.
|
||||
Methods:
|
||||
- Name: LookAt
|
||||
@@ -135,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: []
|
||||
@@ -212,5 +164,6 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Dynamic is the base class where all objects with a position,
|
||||
rotation and scale derive from.
|
||||
|
||||
@@ -6,54 +6,63 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The color of the entity.
|
||||
- Name: CastShadows
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the entity casts shadows.
|
||||
- Name: IsSpawn
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the part can be used as a spawn location or not.
|
||||
- Name: UseGravity
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the entity is affected by gravity.
|
||||
- Name: Mass
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the mass of the entity.
|
||||
- Name: Friction
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the friction of the entity.
|
||||
- Name: Drag
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the drag (air resistance) of the entity.
|
||||
- Name: AngularDrag
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the angular drag of the entity.
|
||||
- Name: Bounciness
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the bounciness of the entity.
|
||||
Methods:
|
||||
- Name: AddForce
|
||||
@@ -139,5 +148,6 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Entity represents a physics object that's related to building
|
||||
blocks (inherited by Part and Mesh)
|
||||
|
||||
@@ -6,24 +6,28 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the current camera which player is using to view
|
||||
- Name: Gravity
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The direction and strength of gravity in the world.
|
||||
- Name: PartDestroyHeight
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The height at which unanchored parts are destroyed when they fall below it.
|
||||
- Name: AutoGenerateNavMesh
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not to automatically build a navigation mesh
|
||||
for NPC pathfinding. This property is disabled by default so there are no
|
||||
performance issues with larger maps.
|
||||
@@ -44,7 +48,7 @@ Methods:
|
||||
IsOptional: true
|
||||
DefaultValue: "10000"
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -53,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
|
||||
@@ -68,7 +72,7 @@ Methods:
|
||||
IsOptional: true
|
||||
DefaultValue: "1000"
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -77,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
|
||||
@@ -88,7 +92,7 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -97,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
|
||||
@@ -112,7 +116,7 @@ Methods:
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -143,5 +147,6 @@ Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Environment
|
||||
Description: Environment is the primary object intended for storing active
|
||||
objects in the place.
|
||||
|
||||
@@ -6,12 +6,14 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the radius of this explosion
|
||||
- Name: Force
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the force of this explosion that will be applied to
|
||||
affected hits
|
||||
- Name: AffectAnchored
|
||||
@@ -19,18 +21,21 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if this explosion should affect anchored parts or not
|
||||
- Name: Damage
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Damage that is affected to player
|
||||
- Name: AffectPredicate
|
||||
Type: function
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: |-
|
||||
A predicate function deciding whenever this part should be accepted or not
|
||||
|
||||
@@ -51,5 +56,6 @@ Events:
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Explosion is a deadly explosion killing players and applying force
|
||||
to parts at the given position.
|
||||
|
||||
@@ -6,10 +6,12 @@ Properties:
|
||||
IsAccessibleByScripts: false
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The ID of the file
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Represents a link to a file path in the file system
|
||||
|
||||
@@ -17,4 +17,5 @@ Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Filter
|
||||
Description: FilterService is a service which processes and filter user inputs
|
||||
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Folder is similar to a model, used for storing objects in the place.
|
||||
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Base class for font assets
|
||||
|
||||
@@ -1,9 +1,31 @@
|
||||
Name: GUI
|
||||
BaseType: UIField
|
||||
Properties: []
|
||||
BaseType: Instance
|
||||
Properties:
|
||||
- Name: Visible
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: ZIndex
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: AbsoluteSize
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: GUI is a class that is used to create a GUI.
|
||||
|
||||
@@ -6,24 +6,28 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the canvas size for this GUI
|
||||
- Name: Shaded
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if this GUI3D should be affected by lighting
|
||||
- Name: FaceCamera
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if this GUI3D always face the camera?
|
||||
- Name: Transparent
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if the background should be transparent. Recommended to
|
||||
be set to false if transparent background is not needed.
|
||||
Methods: []
|
||||
@@ -31,4 +35,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: GUI3D is a class that allows GUI to be displayed in a 3D space.
|
||||
|
||||
@@ -6,30 +6,42 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns true if this current session is being tested locally
|
||||
- Name: GameID
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The ID of the current Polytoria place.
|
||||
- Name: ServerID
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The server ID of the current instance.
|
||||
- Name: UpTime
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
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
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The total number of instances currently loaded.
|
||||
Methods: []
|
||||
Events:
|
||||
@@ -45,5 +57,6 @@ Events:
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: game
|
||||
Description: Game is the root object in the Polytoria instance tree. It is the
|
||||
object from which everything is descended.
|
||||
|
||||
@@ -6,30 +6,42 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the force used to drag this object.
|
||||
- Name: MaxRange
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
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
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the permission mode for this grabber
|
||||
- Name: Dragger
|
||||
Type: Player
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the current dragger
|
||||
- Name: PermissionPredicate
|
||||
Type: function
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: >-
|
||||
A predicate function deciding whenever this player can grab this object.
|
||||
`PermissionMode` must be set to `GrabbablePermissionMode.Scripted`
|
||||
@@ -59,5 +71,6 @@ Events:
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Grabbable represents a object that can be dragged by user. It can
|
||||
be parented to Physical to give user ability to drag that object.
|
||||
|
||||
52
yaml/types/GradientImageAsset.yaml
Normal file
52
yaml/types/GradientImageAsset.yaml
Normal file
@@ -0,0 +1,52 @@
|
||||
Name: GradientImageAsset
|
||||
BaseType: ImageAsset
|
||||
Properties:
|
||||
- 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: Missing Documentation
|
||||
- Name: Height
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Fill
|
||||
Type: GradientImageFillEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: FillFrom
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: FillTo
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Missing Documentation
|
||||
@@ -6,76 +6,89 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the color emitting off the sun.
|
||||
- Name: SunDiscMultiplier
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the multiplier of the sun.
|
||||
- Name: SunDiscExponent
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the exponent of the sun.
|
||||
- Name: SunHaloColor
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the color of the sun halo.
|
||||
- Name: SunHaloExponent
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the exponent of the sun halo.
|
||||
- Name: SunHaloContribution
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the contribution of the sun halo.
|
||||
- Name: HorizonLineColor
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the horizon line's color.
|
||||
- Name: HorizonLineExponent
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the horizon line's exponent.
|
||||
- Name: HorizonLineContribution
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines how much the horizon line contributes.
|
||||
- Name: SkyGradientTop
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the top color of the gradient.
|
||||
- Name: SkyGradientBottom
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the bottom color of the gradient.
|
||||
- Name: SkyGradientExponent
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the gradient's exponent.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: GradientSky is a class that is used to set a gradient skybox in the world.
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
Name: Hidden
|
||||
BaseType: Instance
|
||||
BaseType: HiddenBase
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
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
|
||||
@@ -6,24 +6,28 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The target endpoint of the HTTP request.
|
||||
- Name: Method
|
||||
Type: HttpRequestMethodEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The HTTP method used for the request.
|
||||
- Name: Body
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The payload sent with the request.
|
||||
- Name: Headers
|
||||
Type: table
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: A table of HTTP headers to include with the request, represented as
|
||||
key-value pairs.
|
||||
Methods:
|
||||
@@ -38,4 +42,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: HttpRequestData represents the data required to construct an HTTP request
|
||||
|
||||
@@ -6,18 +6,21 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the HTTP request completed successfully.
|
||||
- Name: StatusCode
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The HTTP status code returned by the server.
|
||||
- Name: Headers
|
||||
Type: table
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: A table containing the HTTP response headers returned by the
|
||||
server, represented as key-value pairs.
|
||||
- Name: Body
|
||||
@@ -25,10 +28,19 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
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
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: HttpResponseData represents the result of an HTTP request.
|
||||
|
||||
@@ -104,8 +104,100 @@ 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
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Http
|
||||
Description: Http is a service used for HTTP communications and requests.
|
||||
|
||||
@@ -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
|
||||
@@ -61,5 +87,6 @@ Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: IO
|
||||
Description: Class for interacting with IO in project, only usable with scripts
|
||||
with the respective permission.
|
||||
|
||||
@@ -6,46 +6,54 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Specifies the image of the decal.
|
||||
- Name: TextureScale
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The scale of the texture on the decal.
|
||||
- Name: TextureOffset
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The offset of the texture on the decal.
|
||||
- Name: Color
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the color of the decal.
|
||||
- Name: CastShadows
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the decal should cast shadows.
|
||||
- Name: Shaded
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the decal should be affected by lighting.
|
||||
- Name: FaceCamera
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether or not the decal should always face the camera.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Decals are objects that can have an image texture and are placed in the world.
|
||||
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Base class for image assets
|
||||
|
||||
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
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Base class for input action
|
||||
|
||||
@@ -6,22 +6,26 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Collection of negative inputs
|
||||
- Name: Positive
|
||||
Type: InputButtonCollection
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Collection of positive inputs
|
||||
- Name: Value
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The value of the input
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: InputActionAxis is a class that represents input action of axis type.
|
||||
|
||||
@@ -6,12 +6,14 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Collection of button inputs.
|
||||
- Name: IsPressed
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns true if any of the button in the collection is currently
|
||||
being pressed.
|
||||
- Name: Weight
|
||||
@@ -19,6 +21,7 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Returns the current analog input of the button.
|
||||
Methods: []
|
||||
Events:
|
||||
@@ -31,4 +34,5 @@ Events:
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: InputActionButton is a class that represents input action of button type.
|
||||
|
||||
@@ -6,34 +6,40 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Collection of up inputs.
|
||||
- Name: Down
|
||||
Type: InputButtonCollection
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Collection of down inputs.
|
||||
- Name: Left
|
||||
Type: InputButtonCollection
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Collection of left inputs.
|
||||
- Name: Right
|
||||
Type: InputButtonCollection
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Collection of right inputs.
|
||||
- Name: Value
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The value of this input
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: InputActionVector2 is a class that represents input action of Vector2 type.
|
||||
|
||||
@@ -6,6 +6,7 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Key code for this button
|
||||
Methods:
|
||||
- Name: New
|
||||
@@ -26,8 +27,24 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Create new button of this keycode
|
||||
- Name: __eq
|
||||
ReturnType: boolean
|
||||
Parameters:
|
||||
- Name: a
|
||||
Type: InputButton
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
- Name: b
|
||||
Type: InputButton
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: true
|
||||
Description: Missing Documentation
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: InputButton is a class that represents a button KeyCode
|
||||
|
||||
@@ -28,4 +28,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: A collection of Input Buttons
|
||||
|
||||
@@ -6,73 +6,84 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the game window is currently focused.
|
||||
- Name: IsTouchscreen
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the input device is a touchscreen.
|
||||
- Name: IsGameFocused
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the game is currently focused.
|
||||
- Name: IsInputFocused
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether an input is currently focused.
|
||||
- Name: IsGamepadConnected
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether a gamepad is currently connected.
|
||||
- Name: IsMenuOpened
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the game menu is currently opened.
|
||||
- Name: CursorLocked
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the cursor is currently locked.
|
||||
- Name: CursorVisible
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the cursor is currently visible.
|
||||
- Name: MousePosition
|
||||
Type: Vector2
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the current position of the mouse cursor.
|
||||
- Name: ScreenWidth
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the width of the screen.
|
||||
- Name: ScreenHeight
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the height of the screen.
|
||||
Methods:
|
||||
- Name: GetMouseWorldPosition
|
||||
ReturnType: Vector3
|
||||
Parameters:
|
||||
- Name: ignoreList
|
||||
Type: table
|
||||
Type: "{ Instance }"
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
@@ -161,13 +172,17 @@ Events:
|
||||
Description: Fires when gamepad has been disconnected
|
||||
- Name: KeyDown
|
||||
Arguments:
|
||||
Name: keycode
|
||||
- Name: keycode
|
||||
Type: KeyCodeEnum
|
||||
- Name: gameFocused
|
||||
Type: boolean
|
||||
Description: Fires when key has been pressed
|
||||
- Name: KeyUp
|
||||
Arguments:
|
||||
Name: keycode
|
||||
- Name: keycode
|
||||
Type: KeyCodeEnum
|
||||
- Name: gameFocused
|
||||
Type: boolean
|
||||
Description: Fires when key has been released
|
||||
- Name: AxisValueChanged
|
||||
Arguments:
|
||||
@@ -179,5 +194,6 @@ Events:
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Input
|
||||
Description: InputService is a class used for retrieving user input data, such
|
||||
as the mouse and keyboard.
|
||||
|
||||
@@ -39,5 +39,6 @@ Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Insert
|
||||
Description: Insert is a class used for inserting user-generated models into
|
||||
your game via scripts.
|
||||
|
||||
@@ -6,23 +6,33 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Defines the parent of this instance in the hierarchy.
|
||||
- Name: EditableChildren
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: false
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
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
|
||||
@@ -65,6 +75,50 @@ 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:
|
||||
- Name: className
|
||||
Type: string
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: FindChildByIndex
|
||||
ReturnType: Instance
|
||||
Parameters:
|
||||
- Name: index
|
||||
Type: number
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: MoveChild
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
@@ -81,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
|
||||
@@ -208,6 +262,28 @@ Methods:
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the parent of this instance.
|
||||
- Name: __index
|
||||
ReturnType: any
|
||||
Parameters:
|
||||
- Name: indexer
|
||||
Type: any
|
||||
IsOptional: false
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: __newindex
|
||||
ReturnType: nil
|
||||
Parameters:
|
||||
- Name: indexer
|
||||
Type: any
|
||||
IsOptional: false
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events:
|
||||
- Name: ChildAdded
|
||||
Arguments:
|
||||
@@ -233,5 +309,6 @@ Events:
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Instance is the base class of all classes. Every class derives from
|
||||
it and has all properties, events and functions Instance has.
|
||||
|
||||
@@ -6,10 +6,12 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The value of this object.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: InstanceValue is an object that holds an Instance value.
|
||||
|
||||
@@ -6,10 +6,12 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The value of this object.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: IntValue is an object that holds an integer value.
|
||||
|
||||
@@ -1,48 +0,0 @@
|
||||
Name: InteractionPrompt
|
||||
BaseType: Dynamic
|
||||
Properties:
|
||||
- Name: Title
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
Description: WIP
|
||||
- Name: SubTitle
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
Description: WIP
|
||||
- Name: HoldDuration
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
Description: WIP
|
||||
- Name: Key
|
||||
Type: KeyCodeEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
Description: WIP
|
||||
- Name: UseDefaultUI
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: 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
|
||||
Description: WIP class, not functional yet
|
||||
@@ -1,9 +1,10 @@
|
||||
Name: Inventory
|
||||
BaseType: Hidden
|
||||
BaseType: HiddenBase
|
||||
Properties: []
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Inventory is a container for Tools, equippable by player.
|
||||
|
||||
@@ -6,28 +6,33 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the color of the light.
|
||||
- Name: Brightness
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the brightness of the light.
|
||||
- Name: Specular
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the specular intensity of the light.
|
||||
- Name: Shadows
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Enables or disables shadows cast by the light.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Light is an abstract base class for all light objects in the world.
|
||||
|
||||
@@ -6,48 +6,56 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the skybox to one of the preset skyboxes.
|
||||
- Name: AmbientSource
|
||||
Type: AmbientSourceEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the source of ambient lighting in the place.
|
||||
- Name: AmbientColor
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the ambient color of the lighting in the place.
|
||||
- Name: FogEnabled
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Enables or disables fog in the place.
|
||||
- Name: FogColor
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the color of the fog in the place.
|
||||
- Name: FogStartDistance
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the distance from the camera at which fog begins to appear.
|
||||
- Name: FogEndDistance
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Sets the distance from the camera at which fog stops appearing.
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: true
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: Lighting
|
||||
Description: Lighting is responsible for controlling the state of the lighting
|
||||
in the place. It provides many different options for creators to enhance and
|
||||
fine-tune the visuals of their worlds.
|
||||
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Base class for lighting modifiers
|
||||
|
||||
@@ -6,17 +6,20 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Length of this Marker
|
||||
- Name: AppearOnTop
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determine if this marker should appear on top of everything else in 3D
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Marker3D is a object that allows marking a specific point in world.
|
||||
This will hint an axis gizmo in local test and creator.
|
||||
|
||||
@@ -6,55 +6,71 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The mesh asset used by this Mesh.
|
||||
- Name: IncludeOffset
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Whether to keep the offset of the mesh or recenter it.
|
||||
- Name: CollisionType
|
||||
Type: CollisionTypeEnum
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The type of collision shape to apply to the mesh.
|
||||
- Name: PlayAnimationOnStart
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Whether to play the mesh's animation automatically when the mesh is loaded.
|
||||
- Name: UsePartColor
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Whether to use the color of the part this mesh is attached to.
|
||||
- Name: Color
|
||||
Type: Color
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The color of the mesh.
|
||||
- Name: CastShadows
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Whether the mesh casts shadows.
|
||||
- Name: CurrentAnimation
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the name of the current animation playing on the mesh.
|
||||
- Name: IsAnimationPlaying
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
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
|
||||
@@ -87,16 +103,27 @@ 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.
|
||||
Events: []
|
||||
- Name: GetAnimationInfo
|
||||
ReturnType: "{ MeshAnimationInfo }"
|
||||
Parameters: []
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Events:
|
||||
- Name: Loaded
|
||||
Arguments: ""
|
||||
Description: Missing Documentation
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Represents a part that can have custom mesh applied to it, the mesh
|
||||
may be from the Polytoria Store (Hats, Tools and Heads) or user-uploaded
|
||||
meshes.
|
||||
|
||||
31
yaml/types/MeshAnimationInfo.yaml
Normal file
31
yaml/types/MeshAnimationInfo.yaml
Normal file
@@ -0,0 +1,31 @@
|
||||
Name: MeshAnimationInfo
|
||||
BaseType: null
|
||||
Properties:
|
||||
- Name: Name
|
||||
Type: string
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: Length
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
- Name: IsPlaying
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Missing Documentation
|
||||
Methods: []
|
||||
Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Missing Documentation
|
||||
@@ -6,4 +6,5 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: true
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Base class for mesh assets
|
||||
|
||||
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
|
||||
@@ -6,5 +6,6 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: Model is an instance that can hold other instances, and which
|
||||
transform affects its children.
|
||||
|
||||
@@ -6,6 +6,7 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: ModuleScripts are specialized scripts to hold data that can be
|
||||
accessed by other scripts using the require() function. It is important to
|
||||
define and return a table in a ModuleScript. When the place starts, the server
|
||||
|
||||
@@ -6,120 +6,147 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The offset to the seat at which the NPC is positioned when sitting.
|
||||
- Name: Health
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The current health of the NPC.
|
||||
- Name: MaxHealth
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The maximum health of the NPC.
|
||||
- Name: JumpPower
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the jump power of the NPC.
|
||||
- Name: WalkSpeed
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the walking speed of the NPC.
|
||||
- Name: UseNametag
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines whether the NPC uses a nametag.
|
||||
- Name: NametagOffset
|
||||
Type: Vector3
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
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
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the display name of the NPC.
|
||||
- Name: JumpSound
|
||||
Type: Sound
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the sound played when the NPC jumps.
|
||||
- Name: IsSitting
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the NPC is currently sitting.
|
||||
- Name: IsDead
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the NPC is currently dead.
|
||||
- Name: HoldingTool
|
||||
Type: Tool
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the tool currently held by the NPC.
|
||||
- Name: SittingIn
|
||||
Type: Seat
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the seat in which the NPC is currently sitting.
|
||||
- Name: Character
|
||||
Type: CharacterModel
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: The character model associated with the NPC.
|
||||
- Name: MoveTarget
|
||||
Type: Dynamic
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines the instance the NPC should walk towards.
|
||||
- Name: OnGround
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the NPC is currently on the ground.
|
||||
- Name: OnCeiling
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the NPC is currently on the ceiling.
|
||||
- Name: NavDestinationDistance
|
||||
Type: number
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates the distance to the navigation destination.
|
||||
- Name: NavDestinationReached
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the NPC has reached its navigation destination.
|
||||
- Name: NavDestinationValid
|
||||
Type: boolean
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: true
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Indicates whether the navigation destination is valid.
|
||||
Methods:
|
||||
- Name: Kill
|
||||
@@ -247,6 +274,7 @@ Events:
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: NPC (non-player character) is an object similar to a Player but
|
||||
that can be controlled by code. Like players, it can walk and jump, and its
|
||||
body part colors can be customized.
|
||||
|
||||
@@ -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: []
|
||||
@@ -221,5 +247,6 @@ Events: []
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: false
|
||||
StaticAlias: null
|
||||
Description: Represents a network message used for communication between clients
|
||||
and servers.
|
||||
|
||||
@@ -6,6 +6,7 @@ Properties:
|
||||
IsAccessibleByScripts: true
|
||||
IsReadOnly: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
Description: Determines if this network event should send messages reliably.
|
||||
Recommended to be off if you're passing lot of data that doesn't need to
|
||||
arrive reliably.
|
||||
@@ -15,8 +16,8 @@ Methods:
|
||||
Parameters:
|
||||
- Name: msg
|
||||
Type: NetMessage
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
- Name: _
|
||||
Type: any
|
||||
IsOptional: true
|
||||
@@ -30,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
|
||||
@@ -45,8 +46,8 @@ Methods:
|
||||
Parameters:
|
||||
- Name: msg
|
||||
Type: NetMessage
|
||||
IsOptional: false
|
||||
DefaultValue: ""
|
||||
IsOptional: true
|
||||
DefaultValue: null
|
||||
IsAsync: false
|
||||
IsObsolete: false
|
||||
IsStatic: false
|
||||
@@ -61,14 +62,13 @@ 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
|
||||
IsStatic: false
|
||||
IsAbstract: false
|
||||
IsInstantiatable: true
|
||||
StaticAlias: null
|
||||
Description: NetworkEvents are events that can be called to communicate between
|
||||
server and client. NetMessages are the class used for sharing data between
|
||||
server and client when sending NetworkEvents.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user