diff --git a/autogen/mdgen.js b/autogen/mdgen.js index 9425b14..c6bf2ae 100644 --- a/autogen/mdgen.js +++ b/autogen/mdgen.js @@ -1,43 +1,38 @@ const fs = require("fs") const path = require("path") -const { XMLParser } = require("fast-xml-parser"); +const yaml = require("yaml") -const xmlAPIPath = path.join(__dirname, "../", "xml", "types") +const yamlAPIPath = path.join(__dirname, "../", "yaml", "types") const mdAPIPath = path.join(__dirname, "../", "docs/api", "types") const iconDataPath = path.join(__dirname, "../", "docs/theme/.icons", "polytoria") -const xmlEnumPath = path.join(__dirname, "../", "xml", "enums") +const yamlEnumPath = path.join(__dirname, "../", "yaml", "enums") const mdEnumPath = path.join(__dirname, "../", "docs/api", "enums") if (!fs.existsSync(mdAPIPath)) { fs.mkdirSync(mdAPIPath, { recursive: true }) } -if (!fs.existsSync(xmlAPIPath)) { - fs.mkdirSync(xmlAPIPath, { recursive: true }) +if (!fs.existsSync(yamlAPIPath)) { + fs.mkdirSync(yamlAPIPath, { recursive: true }) } if (!fs.existsSync(mdEnumPath)) { fs.mkdirSync(mdEnumPath, { recursive: true }) } -if (!fs.existsSync(xmlEnumPath)) { - fs.mkdirSync(xmlEnumPath, { recursive: true }) +if (!fs.existsSync(yamlEnumPath)) { + fs.mkdirSync(yamlEnumPath, { recursive: true }) } -const parser = new XMLParser(); - // Process API Classes -const xmlFiles = fs.readdirSync(xmlAPIPath).filter(file => file.endsWith('.xml')); +const yamlFiles = fs.readdirSync(yamlAPIPath).filter(file => file.endsWith('.yaml')); -for (const xmlFile of xmlFiles) { - const xmlPath = path.join(xmlAPIPath, xmlFile) - const xmlContent = fs.readFileSync(xmlPath, "utf-8") - const data = parser.parse(xmlContent) +for (const yamlFile of yamlFiles) { + const yamlPath = path.join(yamlAPIPath, yamlFile) + const yamlContent = fs.readFileSync(yamlPath, "utf-8") - if (!data.ClassDef) continue; - - const c = data.ClassDef; - const className = path.basename(xmlFile, '.xml') + const c = yaml.parse(yamlContent); + const className = path.basename(yamlFile, '.yaml') let mdPath = path.join(mdAPIPath, className + ".md") let mk = "" const iconPath = path.join(iconDataPath, c.Name + ".svg") @@ -149,20 +144,17 @@ for (const xmlFile of xmlFiles) { fs.writeFileSync(mdPath, mk) } -console.log(`Converted ${xmlFiles.length} XML files to Markdown`) +console.log(`Converted ${yamlFiles.length} XML files to Markdown`) // Process Enums -const xmlEnumFiles = fs.readdirSync(xmlEnumPath).filter(file => file.endsWith('.xml')); +const yamlEnumFiles = fs.readdirSync(yamlEnumPath).filter(file => file.endsWith('.yaml')); -for (const xmlFile of xmlEnumFiles) { - const xmlPath = path.join(xmlEnumPath, xmlFile); - const xmlContent = fs.readFileSync(xmlPath, "utf-8"); - const data = parser.parse(xmlContent); +for (const yamlFile of yamlEnumFiles) { + const yamlPath = path.join(yamlEnumPath, yamlFile); + const yamlContent = fs.readFileSync(yamlPath, "utf-8"); - if (!data.EnumDef) continue; - - const e = data.EnumDef; - const enumName = path.basename(xmlFile, '.xml'); + const e = yaml.parse(yamlContent); + const enumName = path.basename(yamlFile, '.yaml'); let mdPath = path.join(mdEnumPath, enumName + ".md") let mk = "" @@ -198,4 +190,4 @@ for (const xmlFile of xmlEnumFiles) { fs.writeFileSync(mdPath, mk) } -console.log(`Converted ${xmlEnumFiles.length} enum XML files to Markdown`) \ No newline at end of file +console.log(`Converted ${yamlEnumFiles.length} enum XML files to Markdown`) \ No newline at end of file diff --git a/autogen/package-lock.json b/autogen/package-lock.json index 37a7c0a..f237b87 100644 --- a/autogen/package-lock.json +++ b/autogen/package-lock.json @@ -5,7 +5,8 @@ "packages": { "": { "dependencies": { - "fast-xml-parser": "^5.3.3" + "fast-xml-parser": "^5.3.3", + "yaml": "^2.8.2" } }, "node_modules/fast-xml-parser": { @@ -37,6 +38,21 @@ } ], "license": "MIT" + }, + "node_modules/yaml": { + "version": "2.8.2", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz", + "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" + } } } } diff --git a/autogen/package.json b/autogen/package.json index 324f2fc..212219c 100644 --- a/autogen/package.json +++ b/autogen/package.json @@ -1,5 +1,6 @@ { "dependencies": { - "fast-xml-parser": "^5.3.3" + "fast-xml-parser": "^5.3.3", + "yaml": "^2.8.2" } } diff --git a/autogen/xmlgen.js b/autogen/xmltoyaml.js similarity index 88% rename from autogen/xmlgen.js rename to autogen/xmltoyaml.js index 0d97370..61bb408 100644 --- a/autogen/xmlgen.js +++ b/autogen/xmltoyaml.js @@ -1,9 +1,12 @@ const fs = require("fs") +const yaml = require("yaml") const path = require("path") const { XMLBuilder, XMLParser } = require("fast-xml-parser"); const xmlAPIPath = path.join(__dirname, "../", "xml", "types") const xmlEnumPath = path.join(__dirname, "../", "xml", "enums") +const yamlAPIPath = path.join(__dirname, "../", "yaml", "types") +const yamlEnumPath = path.join(__dirname, "../", "yaml", "enums") if (!fs.existsSync(xmlAPIPath)) { fs.mkdirSync(xmlAPIPath, { recursive: true }) @@ -13,16 +16,22 @@ if (!fs.existsSync(xmlEnumPath)) { fs.mkdirSync(xmlEnumPath, { recursive: true }) } +if (!fs.existsSync(yamlAPIPath)) { + fs.mkdirSync(yamlAPIPath, { recursive: true }) +} + +if (!fs.existsSync(yamlEnumPath)) { + fs.mkdirSync(yamlEnumPath, { recursive: true }) +} + const data = JSON.parse(fs.readFileSync("def.json", "utf-8")) const parser = new XMLParser(); -const builder = new XMLBuilder({ - format: true -}); // Process Classes for (const c of data.Classes) { let xmlPath = path.join(xmlAPIPath, c.Name + ".xml") + let yamlPath = path.join(yamlAPIPath, c.Name + ".yaml") let obj = { ...c, @@ -80,7 +89,7 @@ for (const c of data.Classes) { } // Add class description - obj.Description = existingClassDescription; + obj.Description = existingClassDescription ?? ""; // Add properties for (const prop of c.Properties) { @@ -109,16 +118,13 @@ for (const c of data.Classes) { }) } - const xmlContent = builder.build({ - "?xml": "", - ClassDef: obj - }); - fs.writeFileSync(xmlPath, xmlContent) + fs.writeFileSync(yamlPath, yaml.stringify(obj)) } // Process Enums for (const e of data.Enums) { let xmlPath = path.join(xmlEnumPath, e.Name + ".xml") + let yamlPath = path.join(yamlEnumPath, e.Name + ".yaml") let obj = { ...e, @@ -156,9 +162,5 @@ for (const e of data.Enums) { }) } - const xmlContent = builder.build({ - "?xml": "", - EnumDef: obj - }); - fs.writeFileSync(xmlPath, xmlContent) + fs.writeFileSync(yamlPath, yaml.stringify(obj)) } \ No newline at end of file diff --git a/autogen/yamlgen.js b/autogen/yamlgen.js new file mode 100644 index 0000000..d458b04 --- /dev/null +++ b/autogen/yamlgen.js @@ -0,0 +1,147 @@ +const fs = require("fs") +const path = require("path") +const yaml = require("yaml") + +const yamlAPIPath = path.join(__dirname, "../", "yaml", "types") +const yamlEnumPath = path.join(__dirname, "../", "yaml", "enums") + +if (!fs.existsSync(yamlAPIPath)) { + fs.mkdirSync(yamlAPIPath, { recursive: true }) +} + +if (!fs.existsSync(yamlEnumPath)) { + fs.mkdirSync(yamlEnumPath, { recursive: true }) +} + +const data = JSON.parse(fs.readFileSync("def.json", "utf-8")) + +// Process Classes +for (const c of data.Classes) { + let yamlPath = path.join(yamlAPIPath, c.Name + ".yaml") + + let obj = { + ...c, + Properties: [], + Methods: [], + Events: [], + } + + // Load existing data if file exists + let existingDescriptions = { Properties: {}, Methods: {}, Events: {} }; + let existingArguments = { Events: {} }; + let existingClassDescription = "Missing Documentation"; + + if (fs.existsSync(yamlPath)) { + const existingXml = fs.readFileSync(yamlPath, "utf-8"); + const existingData = yaml.parse(existingXml); + + // Preserve existing class description + if (existingData.Description) { + existingClassDescription = existingData.Description; + } + + // Build lookup maps for existing descriptions + if (existingData.Properties) { + const props = Array.isArray(existingData.Properties) + ? existingData.Properties + : [existingData.Properties]; + props.forEach(p => { + if (p.Name) existingDescriptions.Properties[p.Name] = p.Description || ""; + }); + } + + if (existingData.Methods) { + const methods = Array.isArray(existingData.Methods) + ? existingData.Methods + : [existingData.Methods]; + methods.forEach(m => { + if (m.Name) existingDescriptions.Methods[m.Name] = m.Description || ""; + }); + } + + if (existingData.Events) { + const events = Array.isArray(existingData.Events) + ? existingData.Events + : [existingData.Events]; + events.forEach(e => { + if (e.Name) { + existingDescriptions.Events[e.Name] = e.Description || ""; + existingArguments.Events[e.Name] = e.Arguments || ""; + } + }); + } + } + + // Add class description + obj.Description = existingClassDescription; + + // Add properties + for (const prop of c.Properties) { + if (prop.IsObsolete) continue + obj.Properties.push({ + ...prop, + Description: existingDescriptions.Properties[prop.Name] || "Missing Documentation" + }) + } + + // Add methods + for (const m of c.Methods) { + if (m.IsObsolete) continue + obj.Methods.push({ + ...m, + Description: existingDescriptions.Methods[m.Name] || "Missing Documentation" + }) + } + + // Add events + for (const e of c.Events) { + obj.Events.push({ + ...e, + Description: existingDescriptions.Events[e.Name] || "Missing Documentation", + Arguments: existingArguments.Events[e.Name] || "" + }) + } + + fs.writeFileSync(yamlPath, yaml.stringify(obj)) +} + +// Process Enums +for (const e of data.Enums) { + let yamlPath = path.join(yamlEnumPath, e.Name + ".yaml") + + let obj = { + ...e, + Options: [] + } + + let existingDescriptions = {}; + let existingEnumDescription = ""; + if (fs.existsSync(yamlPath)) { + const existingXml = fs.readFileSync(yamlPath, "utf-8"); + const existingData = yaml.parse(existingXml); + + existingEnumDescription = existingData.Description || ""; + + if (existingData.Options) { + const options = Array.isArray(existingData.Options) + ? existingData.Options + : [existingData.Options]; + options.forEach(o => { + if (o.Name) existingDescriptions[o.Name] = o.Description || ""; + }); + } + } + + // Add enum description + obj.Description = existingEnumDescription || "Missing Documentation"; + + // Add options + for (const option of e.Options) { + obj.Options.push({ + Name: option, + Description: existingDescriptions[option] || "" + }) + } + + fs.writeFileSync(yamlPath, yaml.stringify(obj)) +} \ No newline at end of file diff --git a/package.json b/package.json index 8ee2200..56d3983 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "scripts": { "dev": "npm run gen && mkdocs serve", "build": "npm run gen && mkdocs build", - "gen": "node autogen/xmlgen.js && node autogen/mdgen.js" + "gen": "node autogen/yamlgen.js && node autogen/mdgen.js" }, "keywords": [], "author": "", diff --git a/xml/enums/AmbientSource.xml b/xml/enums/AmbientSource.xml deleted file mode 100644 index 3f7454e..0000000 --- a/xml/enums/AmbientSource.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - AmbientSource - AmbientSourceEnum - - Skybox - - - - Color - - - Missing Documentation - diff --git a/xml/enums/BuiltInAudioPreset.xml b/xml/enums/BuiltInAudioPreset.xml deleted file mode 100644 index 15e6645..0000000 --- a/xml/enums/BuiltInAudioPreset.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - BuiltInAudioPreset - BuiltInAudioPresetEnum - - Jump - - - - Explosion - - - Missing Documentation - diff --git a/xml/enums/CameraMode.xml b/xml/enums/CameraMode.xml deleted file mode 100644 index a99a1b1..0000000 --- a/xml/enums/CameraMode.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - CameraMode - CameraModeEnum - - Follow - - - - Free - - - - Scripted - - - Missing Documentation - diff --git a/xml/enums/CharacterAttachment.xml b/xml/enums/CharacterAttachment.xml deleted file mode 100644 index 784b674..0000000 --- a/xml/enums/CharacterAttachment.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - CharacterAttachment - CharacterAttachmentEnum - - Head - - - - Torso - - - - ShoulderRight - - - - ShoulderLeft - - - - Waist - - - - LegLeft - - - - LegRight - - - - FootLeft - - - - FootRight - - - - HandLeft - - - - HandRight - - - Missing Documentation - diff --git a/xml/enums/ClientPlatform.xml b/xml/enums/ClientPlatform.xml deleted file mode 100644 index 9a1b5c7..0000000 --- a/xml/enums/ClientPlatform.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - ClientPlatform - ClientPlatformEnum - - Desktop - - - - Mobile - - - - VR - - - Missing Documentation - diff --git a/xml/enums/CreatorToolMode.xml b/xml/enums/CreatorToolMode.xml deleted file mode 100644 index 4d632d6..0000000 --- a/xml/enums/CreatorToolMode.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - CreatorToolMode - ToolModeEnum - - Select - - - - Move - - - - Rotate - - - - Scale - - - - Paint - - - - Brush - - - Missing Documentation - diff --git a/xml/enums/ForceMode.xml b/xml/enums/ForceMode.xml deleted file mode 100644 index 12d6975..0000000 --- a/xml/enums/ForceMode.xml +++ /dev/null @@ -1,22 +0,0 @@ - - - ForceMode - ForceModeEnum - - Force - - - - Acceleration - - - - Impulse - - - - VelocityChange - - - Missing Documentation - diff --git a/xml/enums/GrabbablePermissionMode.xml b/xml/enums/GrabbablePermissionMode.xml deleted file mode 100644 index 6002785..0000000 --- a/xml/enums/GrabbablePermissionMode.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - GrabbablePermissionMode - GrabbablePermissionModeEnum - - None - - - - Everyone - - - - Scripted - - - Missing Documentation - diff --git a/xml/enums/HorizontalAlignment.xml b/xml/enums/HorizontalAlignment.xml deleted file mode 100644 index 1619f02..0000000 --- a/xml/enums/HorizontalAlignment.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - HorizontalAlignment - TextHorizontalAlignmentEnum - - Left - - - - Center - - - - Right - - - Missing Documentation - diff --git a/xml/enums/HttpRequestMethod.xml b/xml/enums/HttpRequestMethod.xml deleted file mode 100644 index ef19039..0000000 --- a/xml/enums/HttpRequestMethod.xml +++ /dev/null @@ -1,26 +0,0 @@ - - - HttpRequestMethod - HttpRequestMethodEnum - - Get - - - - Post - - - - Put - - - - Delete - - - - Patch - - - Missing Documentation - diff --git a/xml/enums/ImageStretchMode.xml b/xml/enums/ImageStretchMode.xml deleted file mode 100644 index feedd3d..0000000 --- a/xml/enums/ImageStretchMode.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - ImageStretchMode - ImageStretchModeEnum - - Stretch - - - - Centered - - - - Covered - - - Missing Documentation - diff --git a/xml/enums/ImageType.xml b/xml/enums/ImageType.xml deleted file mode 100644 index 35b8e2f..0000000 --- a/xml/enums/ImageType.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - ImageType - ImageTypeEnum - - Asset - - - - AssetThumbnail - - - - PlaceThumbnail - - - - UserAvatar - - - - UserAvatarHeadshot - - - - GuildIcon - - - - GuildBanner - - - - PlaceIcon - - - Missing Documentation - diff --git a/xml/enums/KeyCode.xml b/xml/enums/KeyCode.xml deleted file mode 100644 index ea01b7f..0000000 --- a/xml/enums/KeyCode.xml +++ /dev/null @@ -1,642 +0,0 @@ - - - KeyCode - KeyCodeEnum - - None - - - - Space - - - - Exclam - - - - QuotedBl - - - - Numbersign - - - - Dollar - - - - Percent - - - - Ampersand - - - - Apostrophe - - - - ParenLeft - - - - Parenright - - - - Asterisk - - - - Plus - - - - Comma - - - - Minus - - - - Period - - - - Slash - - - - Key0 - - - - Key1 - - - - Key2 - - - - Key3 - - - - Key4 - - - - Key5 - - - - Key6 - - - - Key7 - - - - Key8 - - - - Key9 - - - - Colon - - - - Semicolon - - - - Less - - - - Equal - - - - Greater - - - - Question - - - - At - - - - A - - - - B - - - - C - - - - D - - - - E - - - - F - - - - G - - - - H - - - - I - - - - J - - - - K - - - - L - - - - M - - - - N - - - - O - - - - P - - - - Q - - - - R - - - - S - - - - T - - - - U - - - - V - - - - W - - - - X - - - - Y - - - - Z - - - - BracketLeft - - - - Backslash - - - - BracketRight - - - - Asciicircum - - - - Underscore - - - - QuoteLeft - - - - BraceLeft - - - - Bar - - - - BraceRight - - - - Asciitilde - - - - Yen - - - - Section - - - - GamepadA - - - - GamepadB - - - - GamepadX - - - - GamepadY - - - - GamepadBack - - - - GamepadGuide - - - - GamepadStart - - - - GamepadLeftStick - - - - GamepadRightStick - - - - GamepadLeftShoulder - - - - GamepadRightShoulder - - - - GamepadDpadUp - - - - GamepadDpadDown - - - - GamepadDpadLeft - - - - GamepadDpadRight - - - - GamepadPaddle1 - - - - GamepadPaddle2 - - - - GamepadPaddle3 - - - - GamepadPaddle4 - - - - GamepadTouchpad - - - - MouseLeft - - - - MouseRight - - - - MouseMiddle - - - - MouseWheelUp - - - - MouseWheelDown - - - - MouseWheelLeft - - - - MouseWheelRight - - - - MouseXbutton1 - - - - MouseXbutton2 - - - - GamepadAxisLeftX - - - - GamepadAxisLeftY - - - - GamepadAxisRightX - - - - GamepadAxisRightY - - - - GamepadAxisTriggerLeft - - - - GamepadAxisTriggerRight - - - - Special - - - - Escape - - - - Tab - - - - Backtab - - - - Backspace - - - - Enter - - - - KpEnter - - - - Insert - - - - Delete - - - - Left - - - - Up - - - - Right - - - - Down - - - - PageUp - - - - PageDown - - - - Shift - - - - Ctrl - - - - Meta - - - - Alt - - - - CapsLock - - - - NumLock - - - - ScrollLock - - - - F1 - - - - F2 - - - - F3 - - - - F4 - - - - F5 - - - - F6 - - - - F7 - - - - F8 - - - - F9 - - - - F10 - - - - F11 - - - - F12 - - - - Menu - - - - Hyper - - - - KpMultiply - - - - KpDivide - - - - KpSubtract - - - - KpPeriod - - - - KpAdd - - - - Kp0 - - - - Kp1 - - - - Kp2 - - - - Kp3 - - - - Kp4 - - - - Kp5 - - - - Kp6 - - - - Kp7 - - - - Kp8 - - - - Kp9 - - - - Unknown - - - Missing Documentation - diff --git a/xml/enums/MeshCollisionType.xml b/xml/enums/MeshCollisionType.xml deleted file mode 100644 index bbef14d..0000000 --- a/xml/enums/MeshCollisionType.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - MeshCollisionType - CollisionTypeEnum - - Bounds - - - - Convex - - - - Exact - - - Missing Documentation - diff --git a/xml/enums/PartMaterial.xml b/xml/enums/PartMaterial.xml deleted file mode 100644 index c8e5fc1..0000000 --- a/xml/enums/PartMaterial.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - PartMaterial - PartMaterialEnum - - SmoothPlastic - - - - Brick - - - - Concrete - - - - Dirt - - - - Fabric - - - - Grass - - - - Ice - - - - Marble - - - - Metal - - - - MetalGrid - - - - MetalPlate - - - - Neon - - - - Planks - - - - Plastic - - - - Plywood - - - - RustyIron - - - - Sand - - - - Sandstone - - - - Snow - - - - Stone - - - - Wood - - - Missing Documentation - diff --git a/xml/enums/PartShape.xml b/xml/enums/PartShape.xml deleted file mode 100644 index 572cf32..0000000 --- a/xml/enums/PartShape.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - PartShape - ShapeEnum - - Brick - - - - Sphere - - - - Cylinder - - - - Cone - - - - Wedge - - - - Corner - - - - Bevel - - - - Concave - - - - Truss - - - - Frame - - - Missing Documentation - diff --git a/xml/enums/SkyboxPreset.xml b/xml/enums/SkyboxPreset.xml deleted file mode 100644 index f3dcbf3..0000000 --- a/xml/enums/SkyboxPreset.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - SkyboxPreset - SkyboxEnum - - Day1 - - - - Day2 - - - - Day3 - - - - Day4 - - - - Day5 - - - - Day6 - - - - Day7 - - - - Morning1 - - - - Morning2 - - - - Morning3 - - - - Morning4 - - - - Night1 - - - - Night2 - - - - Night3 - - - - Night4 - - - - Night5 - - - - Sunset1 - - - - Sunset2 - - - - Sunset3 - - - - Sunset4 - - - - Sunset5 - - - Missing Documentation - diff --git a/xml/enums/TextFontPreset.xml b/xml/enums/TextFontPreset.xml deleted file mode 100644 index 18d4ef8..0000000 --- a/xml/enums/TextFontPreset.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - TextFontPreset - BuiltInTextFontPresetEnum - - SourceSans - - - - PressStart2P - - - - Montserrat - - - - RobotoMono - - - - Rubik - - - - Poppins - - - - Domine - - - - Fredoka - - - - ComicNeue - - - - Orbitron - - - - Papyrus - - - - ComicSansMS - - - Missing Documentation - diff --git a/xml/enums/TweenDirection.xml b/xml/enums/TweenDirection.xml deleted file mode 100644 index 1ebbb14..0000000 --- a/xml/enums/TweenDirection.xml +++ /dev/null @@ -1,22 +0,0 @@ - - - TweenDirection - TweenDirectionEnum - - In - - - - Out - - - - InOut - - - - OutIn - - - Missing Documentation - diff --git a/xml/enums/TweenTransition.xml b/xml/enums/TweenTransition.xml deleted file mode 100644 index ef1aa9e..0000000 --- a/xml/enums/TweenTransition.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - TweenTransition - TweenTransitionEnum - - Linear - - - - Sine - - - - Quint - - - - Quart - - - - Quad - - - - Expo - - - - Elastic - - - - Cubic - - - - Circ - - - - Bounce - - - - Back - - - - Spring - - - Missing Documentation - diff --git a/xml/enums/UILayoutAlignment.xml b/xml/enums/UILayoutAlignment.xml deleted file mode 100644 index 03e5243..0000000 --- a/xml/enums/UILayoutAlignment.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - UILayoutAlignment - UILayoutAlignmentEnum - - Left - - - - Center - - - - Right - - - Missing Documentation - diff --git a/xml/enums/UIMaskMode.xml b/xml/enums/UIMaskMode.xml deleted file mode 100644 index 558d781..0000000 --- a/xml/enums/UIMaskMode.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - UIMaskMode - MaskModeEnum - - Disabled - - - - ClipOnly - - - - ClipAndDraw - - - Missing Documentation - diff --git a/xml/enums/UIScrollMode.xml b/xml/enums/UIScrollMode.xml deleted file mode 100644 index 8a9ea1f..0000000 --- a/xml/enums/UIScrollMode.xml +++ /dev/null @@ -1,22 +0,0 @@ - - - UIScrollMode - ScrollModeEnum - - Disabled - - - - Auto - - - - AlwaysShow - - - - NeverShow - - - Missing Documentation - diff --git a/xml/enums/VerticalAlignment.xml b/xml/enums/VerticalAlignment.xml deleted file mode 100644 index c6dfc7d..0000000 --- a/xml/enums/VerticalAlignment.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - VerticalAlignment - TextVerticalAlignmentEnum - - Top - - - - Middle - - - - Bottom - - - Missing Documentation - diff --git a/xml/types/Accessory.xml b/xml/types/Accessory.xml deleted file mode 100644 index 6c303ef..0000000 --- a/xml/types/Accessory.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - Accessory - Dynamic - - TargetAttachment - CharacterAttachmentEnum - true - false - false - Specifies the character attachment point - - false - false - true - Accessory represents a attachable object that can be equipped by a CharacterModel. - diff --git a/xml/types/AchievementsService.xml b/xml/types/AchievementsService.xml deleted file mode 100644 index 56e71d9..0000000 --- a/xml/types/AchievementsService.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - AchievementsService - Instance - - UseAchievementSound - boolean - true - false - false - Determine if achievement sound effect should play when user receives an achievement - - - NotifyAchievements - boolean - true - false - false - Determine if achievement toast should show when user receives an achievement - - - Award - nil - - userID - number - false - - - - achievementID - number - false - - - - callback - function - false - - - false - false - false - Award achievement to the user - - - AwardAsync - nil - - userID - number - false - - - - achievementID - number - false - - - true - false - false - Award achievement to the user asynchronously. - - - HasAchievement - nil - - userID - number - false - - - - achievementID - number - false - - - - callback - function - false - - - false - false - false - Check if user of ID has the achievement. - - - HasAchievementAsync - boolean - - userID - number - false - - - - achievementID - number - false - - - false - false - false - Check if player of ID has the achievement, asynchronously. - - - GotAchievement - - achievementID - number - - Fires when the local player got an achievement - - true - false - false - Service for managing achievements - diff --git a/xml/types/Animation.xml b/xml/types/Animation.xml deleted file mode 100644 index a5aaef6..0000000 --- a/xml/types/Animation.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - Animation - Instance - false - false - true - Missing Documentation - diff --git a/xml/types/Animator.xml b/xml/types/Animator.xml deleted file mode 100644 index 8543386..0000000 --- a/xml/types/Animator.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - Animator - Instance - - PlayAnimation - nil - - animationKey - string - false - - - false - false - false - Missing Documentation - - - PlayOneshotAnimation - nil - - animationKey - string - false - - - false - false - false - Missing Documentation - - - StopAnimation - nil - false - false - false - Missing Documentation - - - StopOneshotAnimation - nil - false - false - false - Missing Documentation - - false - false - true - Missing Documentation - diff --git a/xml/types/AssetService.xml b/xml/types/AssetService.xml deleted file mode 100644 index 1444bae..0000000 --- a/xml/types/AssetService.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - AssetService - Instance - - NewAsset - BaseAsset - - assetClassName - string - false - - - false - false - false - Create new asset with the class name - - - NewPTImage - PTImageAsset - - imgID - number - false - - - false - false - false - Create new image from Polytoria with the target ID - - - NewPTAudio - PTAudioAsset - - audioID - number - false - - - false - false - false - Create new audio from Polytoria with the target ID - - - NewPTMesh - PTMeshAsset - - assetID - number - false - - - false - false - false - Create new mesh from Polytoria with the target ID - - true - false - false - Service for managing assets - diff --git a/xml/types/AudioAsset.xml b/xml/types/AudioAsset.xml deleted file mode 100644 index bba59f5..0000000 --- a/xml/types/AudioAsset.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - AudioAsset - ResourceAsset - false - true - false - Abstract class for audio - diff --git a/xml/types/BaseAsset.xml b/xml/types/BaseAsset.xml deleted file mode 100644 index a58fab4..0000000 --- a/xml/types/BaseAsset.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - BaseAsset - NetworkedObject - false - true - false - Base class for all assets - diff --git a/xml/types/BindableEvent.xml b/xml/types/BindableEvent.xml deleted file mode 100644 index 8a3bd7d..0000000 --- a/xml/types/BindableEvent.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - BindableEvent - Instance - - Invoke - nil - - par - any - false - - - false - false - false - Invoke this event with parameters - - - Invoked - - ... - any - - Fires when this event has been invoked - - false - false - true - BindableEvent are events that can be called to communicate between scripts in the same boundary. - diff --git a/xml/types/BodyPosition.xml b/xml/types/BodyPosition.xml deleted file mode 100644 index 0454238..0000000 --- a/xml/types/BodyPosition.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - BodyPosition - Instance - - TargetPosition - Vector3 - true - false - false - Determines the target position that the body applies forces to get to. - - - Force - number - true - false - false - Determines how much force the body applies. - - - AcceptanceDistance - number - true - false - false - Determines how close the body has to be to the target position to stop applying forces to it. - - false - false - true - BodyPosition are objects that apply a force to their parent until it moves toward the target position. - diff --git a/xml/types/BoolValue.xml b/xml/types/BoolValue.xml deleted file mode 100644 index 4867efc..0000000 --- a/xml/types/BoolValue.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - BoolValue - ValueBase - - Value - boolean - true - false - false - The value of this object. - - false - false - true - BoolValue is a ValueBase that stores a boolean. - diff --git a/xml/types/Bounds.xml b/xml/types/Bounds.xml deleted file mode 100644 index dd777fa..0000000 --- a/xml/types/Bounds.xml +++ /dev/null @@ -1,251 +0,0 @@ - - - Bounds - - - Center - Vector3 - true - true - false - Indicates the center point of the bounds. - - - Size - Vector3 - true - false - false - Determines the size of the bounds. - - - Extents - Vector3 - true - true - false - Indicates the extents of the bounds. - - - Start - Vector3 - true - true - false - Missing Documentation - - - End - Vector3 - true - false - false - Missing Documentation - - - Volume - number - true - true - false - Indicates the volume of the bounds. - - - New - Bounds - false - false - true - Creates a new Bounds object. - - - New - Bounds - - position - Vector3 - false - - - - size - Vector3 - false - - - false - false - true - Creates a new Bounds object with the specified position and size. - - - ClosestPoint - Vector3 - - bounds - Bounds - false - - - - point - Vector3 - false - - - false - false - true - Calculates the closest point on the bounds to the specified point. - - - Contains - boolean - - bounds - Bounds - false - - - - point - Vector3 - false - - - false - false - true - Returns whether the bounds contain the specified point. - - - Encapsulate - Bounds - - bounds - Bounds - false - - - - point - Vector3 - false - - - false - false - true - Expands the bounds by the specified amount. - - - Expand - Bounds - - bounds - Bounds - false - - - - amount - number - false - - - false - false - true - Expands the bounds by the specified amount. - - - Intersects - boolean - - bounds - Bounds - false - - - - other - Bounds - false - - - false - false - true - Determines whether the bounds intersect with another bounds. - - - SetMinMax - Bounds - - bounds - Bounds - false - - - - min - Vector3 - false - - - - max - Vector3 - false - - - false - false - true - Sets the minimum and maximum points of the bounds. - - - Distance - number - - bounds - Bounds - false - - - - point - Vector3 - false - - - false - false - true - Calculates the distance from the bounds to the specified point. - - - SqrDistance - number - - bounds - Bounds - false - - - - point - Vector3 - false - - - false - false - true - Calculates the squared distance from the bounds to the specified point. - - false - false - false - Represents a bounding box in 3D space. - diff --git a/xml/types/BuiltInAudioAsset.xml b/xml/types/BuiltInAudioAsset.xml deleted file mode 100644 index 599e2fb..0000000 --- a/xml/types/BuiltInAudioAsset.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - BuiltInAudioAsset - AudioAsset - - AudioPreset - BuiltInAudioPresetEnum - false - false - false - The target audio to use - - false - false - true - Audio asset that's built-in with the client - diff --git a/xml/types/BuiltInFontAsset.xml b/xml/types/BuiltInFontAsset.xml deleted file mode 100644 index 7e3a4d3..0000000 --- a/xml/types/BuiltInFontAsset.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - BuiltInFontAsset - FontAsset - - FontPreset - BuiltInTextFontPresetEnum - false - false - false - Target font to use - - false - false - true - Font asset that's built-in with the client - diff --git a/xml/types/Camera.xml b/xml/types/Camera.xml deleted file mode 100644 index 7b43dcf..0000000 --- a/xml/types/Camera.xml +++ /dev/null @@ -1,339 +0,0 @@ - - - Camera - Dynamic - - Mode - CameraModeEnum - true - false - false - Determines or returns the camera's current mode. - - - FOV - number - true - false - false - Determines or returns the camera's field of view. - - - ClipThroughWalls - boolean - true - false - false - Determines whether or not the camera should clip through walls. - - - MinDistance - number - true - false - false - The camera's minimum distance from the player in Follow mode. - - - MaxDistance - number - true - false - false - Determines camera's maximum distance from the player in Follow mode. - - - Distance - number - true - false - false - Determines the distance between the camera and the player when the camera is in Follow mode. - - - ScrollSensitivity - number - true - false - false - Determines the scroll move speed of the camera. - - - Orthographic - boolean - true - false - false - Determines whether or not the camera should render in orthographic (2D) mode or not (3D). - - - FollowLerp - boolean - true - false - false - Determines whether or not to use lerping in Follow mode. - - - LerpSpeed - number - true - false - false - Determines the lerp speed of the camera when lerping is enabled. - - - OrthographicSize - number - true - false - false - Determines the half-size of the camera when in orthographic mode. - - - PositionOffset - Vector3 - true - false - false - Determines the camera's offset from its position. - - - RotationOffset - Vector3 - true - false - false - Determines the camera's offset from its rotation. - - - IsFirstPerson - boolean - true - true - false - Returns whether or not the camera is in first person. - - - CanLock - boolean - true - false - false - Determine if camera can be ctrl locked. - - - SensitivityMultiplier - number - true - false - false - Multipler for camera sensitivity - - - Sensitivity - number - true - true - false - Current sensitivity of the camera - - - HorizontalSpeed - number - true - false - false - Determines the horizontal movement speed of the camera in Follow mode. - - - VerticalSpeed - number - true - false - false - Determines the vertical move speed of the camera. - - - ScrollLerpSpeed - number - true - false - false - Determines the lerp amount when scrolling - - - CtrlLocked - boolean - true - false - false - Determine if camera is in Ctrl lock mode - - - AlwaysLocked - boolean - true - false - false - Determine if camera should always be in locked mode - - - Target - Dynamic - true - false - false - The target of Follow mode - - - ViewportPointToRay - RayResult - - pos - Vector2 - false - - - - ignoreList - table - true - - - - maxDistance - number - true - 10000 - - false - false - false - Cast a ray from the camera at the specified ViewportPoint (Vector3 with components with values in range of 0 - 1 describing how far a point is to to right and to the top of the screen) into the game world - - - ScreenPointToRay - RayResult - - pos - Vector2 - false - - - - ignoreList - table - true - - - - maxDistance - number - true - 10000 - - false - false - false - Cast a ray from the camera at screen point into the game world - - - ViewportToScreenPoint - Vector2 - - pos - Vector2 - false - - - false - false - false - Transforms `pos` from viewport space into screen space. - - - ViewportToWorldPoint - Vector3 - - pos - Vector2 - false - - - false - false - false - Transforms `pos` from viewport space into world space. - - - WorldToViewportPoint - Vector2 - - pos - Vector3 - false - - - false - false - false - Transforms `pos` from world space into viewport space. - - - WorldToScreenPoint - Vector2 - - pos - Vector3 - false - - - false - false - false - Transforms `pos` from world space into screen space. - - - ScreenToViewportPoint - Vector2 - - pos - Vector2 - false - - - false - false - false - Transforms `pos` from screen space into viewport space. - - - ScreenToWorldPoint - Vector3 - - pos - Vector2 - false - - - false - false - false - Transforms `pos` from screen space into world space. - - - FirstPersonEntered - - Fires when camera has entered first person - - - FirstPersonExited - - Fires when camera has exited first person - - false - false - true - Camera is a class that represents the local player's camera. - diff --git a/xml/types/CaptureService.xml b/xml/types/CaptureService.xml deleted file mode 100644 index bd90943..0000000 --- a/xml/types/CaptureService.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - CaptureService - Instance - - OnCooldown - boolean - true - true - false - Returns whenever the capture is on cooldown. - - - CanCapture - boolean - true - false - false - Determines if user/scripts can take a picture. - - - DefaultCaptureOverlay - UIField - true - false - false - Default capture overlay for all captures - - - SpectatorAttach - Dynamic - true - false - false - Attaches a spectator camera at dynamic for use with spectator mode. - - - TakePhotoAtDynamic - nil - - dyn - Dynamic - false - - - - photoSize - Vector2 - true - - - - overlay - UIField - true - - - true - false - false - Take a photo at dynamic - - - TakePhotoAt - nil - - pos - Vector3 - false - - - - rot - Vector3 - false - - - - photoSize - Vector2 - true - - - - overlay - UIField - true - - - true - false - false - Take photo at `pos` for position and `rot` for rotation, optional `photoSize` defines the size, and optional UI `overlay` can be passed to include it in the result photo. - - true - false - false - Service for capturing photos - diff --git a/xml/types/CharacterModel.xml b/xml/types/CharacterModel.xml deleted file mode 100644 index 5be52b6..0000000 --- a/xml/types/CharacterModel.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - CharacterModel - Dynamic - - Animator - Animator - true - false - false - The animator for this character - - - GetAttachment - Dynamic - - attachmentEnum - CharacterAttachmentEnum - false - - - false - false - false - Get attachment dynamic from this character - - false - false - true - Base class for Character Models - diff --git a/xml/types/ChatService.xml b/xml/types/ChatService.xml deleted file mode 100644 index 84957e5..0000000 --- a/xml/types/ChatService.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - ChatService - Instance - - BroadcastMessage - nil - - msg - string - false - - - false - false - false - Sends a chat message to all players. - - - UnicastMessage - nil - - msg - string - false - - - - plr - Player - false - - - false - false - false - Sends a chat message to a specific player. - - - NewChatMessage - - sender - Player - - - message - string - - Fires when new chat message has been received from player - - - MessageReceived - - message - string - - Fires when new message has been received from either `BroadcastMessage` or `UnicastMessage` - - true - false - false - Chat is a static class used for various actions regarding the chat. - diff --git a/xml/types/ClientScript.xml b/xml/types/ClientScript.xml deleted file mode 100644 index a33f67e..0000000 --- a/xml/types/ClientScript.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - ClientScript - Script - false - false - true - ClientScript is a script that runs locally for each player. It can only see what the player can see. - diff --git a/xml/types/Color.xml b/xml/types/Color.xml deleted file mode 100644 index d832d0d..0000000 --- a/xml/types/Color.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - Color - - - R - number - true - false - false - Red color component - - - G - number - true - false - false - Green color component - - - B - number - true - false - false - Blue color component - - - A - number - true - false - false - Alpha (opacity) color component - - - New - Color - false - false - true - Creates a new Color with the set R, G, B and A values - - - New - Color - - d - number - false - - - false - false - true - Creates a new Color with the set R, G, B and A values - - - New - Color - - r - number - false - - - - g - number - false - - - - b - number - false - - - false - false - true - Creates a new Color with the set R, G, B and A values - - - New - Color - - r - number - false - - - - g - number - false - - - - b - number - false - - - - a - number - false - - - false - false - true - Creates a new Color with the set R, G, B and A values - - - Random - Color - false - false - true - Returns a random color with an alpha value of 1. - - - FromHex - Color - - hex - string - false - - - false - false - true - Creates a new Color from the specified hex value. - - - Lerp - Color - - a - Color - false - - - - b - Color - false - - - - t - number - false - - - false - false - true - Linearly interpolates colors a and b by t. - - false - false - false - Color is a data type that represents a color. - - The alpha property is between 0 and 1. 0 is fully transparent and 1 is fully visible. - diff --git a/xml/types/ColorAdjustModifier.xml b/xml/types/ColorAdjustModifier.xml deleted file mode 100644 index 503e4e2..0000000 --- a/xml/types/ColorAdjustModifier.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - ColorAdjustModifier - LightingModifier - - Brightness - number - true - false - false - Determine the brightness adjustment - - - Contrast - number - true - false - false - Determine the contrast adjustment - - - Saturation - number - true - false - false - Determine the saturation adjustment - - - TintColor - Color - true - false - false - Determine the tint color - - false - false - true - ColorAdjustModifier is a LightingModifier that allows the adjustment of lighting - diff --git a/xml/types/ColorSeries.xml b/xml/types/ColorSeries.xml deleted file mode 100644 index af331ca..0000000 --- a/xml/types/ColorSeries.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - ColorSeries - ValueType - - PointCount - number - true - true - false - Returns the point count of this color series - - - New - ColorSeries - false - false - true - Create color series by this color range - - - New - ColorSeries - - min - Color - false - - - - max - Color - false - - - false - false - true - Create color series by this color range - - - SetColor - nil - - point - number - false - - - - color - Color - false - - - false - false - false - Sets the color at the specified point in the color series. - - - RemovePoint - nil - - point - number - false - - - false - false - false - Removes the point at the specified index from the color series. - - - SetOffset - nil - - point - number - false - - - - offset - number - false - - - false - false - false - Sets the offset at the specified point in the color series. - - - GetColor - Color - - point - number - false - - - false - false - false - Gets the color at the specified point in the color series. - - - GetOffset - number - - point - number - false - - - false - false - false - Gets the offset at the specified point in the color series. - - - Lerp - Color - - t - number - false - - - false - false - false - Interpolates between colors in the series based on the parameter t. - - false - false - false - Color series is a data type that represents a collection of color and points, also known as gradient. - diff --git a/xml/types/ColorValue.xml b/xml/types/ColorValue.xml deleted file mode 100644 index 59dadbe..0000000 --- a/xml/types/ColorValue.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - ColorValue - ValueBase - - Value - Color - true - false - false - The value of this object. - - false - false - true - ColorValue is an object that holds a Color value. - diff --git a/xml/types/CoreUIService.xml b/xml/types/CoreUIService.xml deleted file mode 100644 index a668f55..0000000 --- a/xml/types/CoreUIService.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - CoreUIService - Instance - - UseUserCard - boolean - true - false - false - Determines whether or not the user card (in the upper right hand corner above the leaderboard) is visible. - - - UseChat - boolean - true - false - false - Determines whether or not the chat box is visible. - - - UseHealthBar - boolean - true - false - false - Determines whether or not the player's health bar is visible. - - - UseLeaderboard - boolean - true - false - false - Determines whether or not the player list/leaderboard is visible. - - - UseHotbar - boolean - true - false - false - Determines whether or not the hot bar is visible. - - - UseMenuButton - boolean - true - false - false - Determines whether or not the menu button is visible. - - - UseEmoteWheel - boolean - true - false - false - Determines whether or not the emote wheel is visible. - - - CanRespawn - boolean - true - false - false - Determines whether or not the player can respawn. - - true - false - false - CoreUI is a static class that allows for the toggling of certain core GUI. - diff --git a/xml/types/CreatorContextService.xml b/xml/types/CreatorContextService.xml deleted file mode 100644 index cf0f8e0..0000000 --- a/xml/types/CreatorContextService.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - CreatorContextService - Instance - true - false - false - CreatorContextService is a service that manage per game specific tools, such as Selections and History. This class is only available in the creator. - diff --git a/xml/types/CreatorGUI.xml b/xml/types/CreatorGUI.xml deleted file mode 100644 index 31c1847..0000000 --- a/xml/types/CreatorGUI.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - CreatorGUI - PlayerGUI - false - false - false - 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. - diff --git a/xml/types/CreatorHistory.xml b/xml/types/CreatorHistory.xml deleted file mode 100644 index ec1d1e0..0000000 --- a/xml/types/CreatorHistory.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - CreatorHistory - Instance - - NewAction - nil - - title - string - false - - - false - false - false - Missing Documentation - - - AddDoCallback - nil - - callback - function - false - - - false - false - false - Missing Documentation - - - AddUndoCallback - nil - - callback - function - false - - - false - false - false - Missing Documentation - - - CommitAction - nil - false - false - false - Missing Documentation - - false - false - false - CreatorHistory is a class that manages history (undo-redo) of this game instance. This class is only available in the creator. - diff --git a/xml/types/CreatorInterface.xml b/xml/types/CreatorInterface.xml deleted file mode 100644 index f3e50aa..0000000 --- a/xml/types/CreatorInterface.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - CreatorInterface - - - ToolMode - ToolModeEnum - true - true - false - Missing Documentation - - - TargetPartColor - Color - true - true - false - Missing Documentation - - - TargetPartMaterial - PartMaterialEnum - true - true - false - Missing Documentation - - - MoveSnapEnabled - boolean - true - true - false - Missing Documentation - - - MoveSnapping - number - true - true - false - Missing Documentation - - - UserMoveSnapping - number - true - true - false - Missing Documentation - - - RotateSnapEnabled - boolean - true - true - false - Missing Documentation - - - RotateSnapping - number - true - true - false - Missing Documentation - - - UserRotateSnapping - number - true - true - false - Missing Documentation - - false - false - false - CreatorInterface represent the user interface of the creator. This class is only available in the creator. - diff --git a/xml/types/CreatorSelections.xml b/xml/types/CreatorSelections.xml deleted file mode 100644 index 6fe701d..0000000 --- a/xml/types/CreatorSelections.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - CreatorSelections - Instance - - Select - nil - - instance - Instance - false - - - false - false - false - Missing Documentation - - - SelectChild - nil - - instance - Instance - false - - - false - false - false - Missing Documentation - - - Deselect - nil - - instance - Instance - false - - - false - false - false - Missing Documentation - - - SelectOnly - nil - - instance - Instance - false - - - false - false - false - Missing Documentation - - - DeselectAll - nil - false - false - false - Missing Documentation - - - GroupInstances - Dynamic - - instances - table - false - - - - asPhysical - boolean - true - False - - false - false - false - Missing Documentation - - - UngroupModel - table - - model - Instance - false - - - false - false - false - Missing Documentation - - - UngroupModels - table - - models - table - false - - - false - false - false - Missing Documentation - - - DuplicateInstances - table - - instances - table - false - - - false - false - false - Missing Documentation - - - GroupSelected - nil - - asPhysical - boolean - true - False - - false - false - false - Missing Documentation - - - UngroupSelected - nil - false - false - false - Missing Documentation - - - DeleteSelected - nil - false - false - false - Missing Documentation - - - DuplicateSelected - nil - false - false - false - Missing Documentation - - - HasSelected - boolean - - instance - Instance - false - - - false - false - false - Missing Documentation - - false - false - false - CreatorSelections is an object that manages selections in the game instance. This class is only available in the creator. - diff --git a/xml/types/CreatorService.xml b/xml/types/CreatorService.xml deleted file mode 100644 index f2224f6..0000000 --- a/xml/types/CreatorService.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - CreatorService - - - Interface - CreatorInterface - true - true - false - Missing Documentation - - - Clipboard - CreatorClipboard - true - true - false - Missing Documentation - - - CurrentGame - Game - true - true - false - Missing Documentation - - - LocalTestActive - boolean - true - true - false - Missing Documentation - - - LocalTestStarted - - Fires when local testing starts - - - LocalTestStopped - - Fires when local testing ends - - true - false - false - CreatorService is the class that manages the creator. This class is only available in the creator. - diff --git a/xml/types/Datastore.xml b/xml/types/Datastore.xml deleted file mode 100644 index a1d1538..0000000 --- a/xml/types/Datastore.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - Datastore - - - Key - string - true - true - false - The key identifying this Datastore connection. - - - GetAsync - any - - key - string - false - - - false - false - false - Retrieves a value from the datastore asynchronously using the specified key. - - - SetAsync - nil - - key - string - false - - - - value - any - false - - - false - false - false - Stores a value in the datastore asynchronously using the specified key. - - - RemoveAsync - nil - - key - string - false - - - false - false - false - Removes a value from the datastore asynchronously using the specified key. - - - Loaded - - Fires when this datastore has been loaded - - false - false - false - Datastore is an object that represent datastore connection. - diff --git a/xml/types/DatastoreService.xml b/xml/types/DatastoreService.xml deleted file mode 100644 index c105102..0000000 --- a/xml/types/DatastoreService.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - DatastoreService - Instance - - GetDatastore - Datastore - - key - string - false - - - false - false - false - Attempts to get a Datastore object from the Datastore service. - - true - false - false - Datastore (not to be confused with the Datastore data type) is a service used for storing data between place sessions. - diff --git a/xml/types/Decal.xml b/xml/types/Decal.xml deleted file mode 100644 index 5d3a1cf..0000000 --- a/xml/types/Decal.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - Decal - Dynamic - - Image - ImageAsset - true - false - false - The image texture applied to the decal. - - - Energy - number - true - false - false - Missing Documentation - - - Color - Color - true - false - false - The color tint applied to the decal. - - false - false - true - Decals are objects that can have an image texture and are wrapped around other objects. - diff --git a/xml/types/Dynamic.xml b/xml/types/Dynamic.xml deleted file mode 100644 index a0d898e..0000000 --- a/xml/types/Dynamic.xml +++ /dev/null @@ -1,305 +0,0 @@ - - - Dynamic - Instance - - Position - Vector3 - true - false - false - The position of the object. - - - Rotation - Vector3 - true - false - false - The rotation of the object. - - - Size - Vector3 - true - false - false - The size of the object. - - - LocalPosition - Vector3 - true - false - false - The position of the object relative to its parent. - - - LocalRotation - Vector3 - true - false - false - The rotation of the object relative to its parent. - - - LocalSize - Vector3 - true - false - false - The size of the object relative to its parent. - - - Quaternion - Quaternion - true - false - false - The rotation of the object represented as a quaternion. - - - Locked - boolean - true - false - false - Determines whether the object can be selected in the Creator. - - - Forward - Vector3 - true - true - false - The forward direction vector of the object. - - - Right - Vector3 - true - true - false - The right direction vector of the object. - - - Up - Vector3 - true - true - false - The up direction vector of the object. - - - LookAt - nil - - target - any - false - - - false - false - false - Orients the object to look at a target. - - - LookAt - nil - - target - any - false - - - - up - Vector3 - false - - - false - false - false - Orients the object to look at a target with a specified up vector. - - - MovePosition - nil - - position - Vector3 - false - - - false - false - false - Missing Documentation - - - MoveRotation - nil - - rotation - Vector3 - false - - - false - false - false - Missing Documentation - - - Translate - nil - - translation - Vector3 - false - - - false - false - false - Moves the transform in the direction and distance of translation. - - - RotateAround - nil - - point - Vector3 - false - - - - axis - Vector3 - false - - - - angle - number - false - - - false - false - false - Rotates the object around a point by the specified Euler angles. - - - Rotate - nil - - eulerAngles - Vector3 - false - - - false - false - false - Rotates the object by the specified Euler angles. - - - InverseTransformPoint - Vector3 - - point - Vector3 - false - - - false - false - false - Transforms a point from world space to local space. - - - TransformPoint - Vector3 - - point - Vector3 - false - - - false - false - false - Transforms a point from local space to world space. - - - InverseTransformDirection - Vector3 - - direction - Vector3 - false - - - false - false - false - Transforms a direction from world space to local space. - - - TransformDirection - Vector3 - - direction - Vector3 - false - - - false - false - false - Transforms a direction from local space to world space. - - - InverseTransformVector - Vector3 - - vector - Vector3 - false - - - false - false - false - Transforms a vector from world space to local space. - - - InverseTransformPosition - Vector3 - - position - Vector3 - false - - - false - false - false - Transforms a position from world space to local space. - - - GetBounds - Bounds - false - false - false - Gets the bounding box of the object. - - false - false - true - Dynamic is the base class where all objects with a position, rotation and scale derive from. - diff --git a/xml/types/Entity.xml b/xml/types/Entity.xml deleted file mode 100644 index 9af1176..0000000 --- a/xml/types/Entity.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - Entity - Physical - - Color - Color - true - false - false - The color of the entity. - - - CastShadows - boolean - true - false - false - Determines whether the entity casts shadows. - - - IsSpawn - boolean - true - false - false - Determines whether the part can be used as a spawn location or not. - - - UseGravity - boolean - true - false - false - Determines whether the entity is affected by gravity. - - - Mass - number - true - false - false - Determines the mass of the entity. - - - Friction - number - true - false - false - Determines the friction of the entity. - - - Drag - number - true - false - false - Determines the drag (air resistance) of the entity. - - - AngularDrag - number - true - false - false - Determines the angular drag of the entity. - - - Bounciness - number - true - false - false - Determines the bounciness of the entity. - - - AddForce - nil - - force - Vector3 - false - - - - mode - ForceModeEnum - true - Force - - false - false - false - Applies a force to the entity. - - - AddTorque - nil - - force - Vector3 - false - - - - mode - ForceModeEnum - true - Force - - false - false - false - Applies a rotational force to the entity. - - - AddForceAtPosition - nil - - force - Vector3 - false - - - - position - Vector3 - false - - - - mode - ForceModeEnum - true - Force - - false - false - false - Applies a force to the entity from a specific position. - - - AddRelativeForce - nil - - force - Vector3 - false - - - - mode - ForceModeEnum - true - Force - - false - false - false - Adds a force to the part relative to its own rotation. - - - AddRelativeTorque - nil - - torque - Vector3 - false - - - - mode - ForceModeEnum - true - Force - - false - false - false - Adds a rotational force to the part relative to its own rotation. - - false - true - false - Entity represents a physics object that's related to building blocks (inherited by Part and Mesh) - diff --git a/xml/types/Environment.xml b/xml/types/Environment.xml deleted file mode 100644 index 499e5e7..0000000 --- a/xml/types/Environment.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - Environment - Instance - - CurrentCamera - Camera - true - false - false - Determines the current camera which player is using to view - - - Gravity - Vector3 - true - false - false - The direction and strength of gravity in the world. - - - PartDestroyHeight - number - true - false - false - The height at which unanchored parts are destroyed when they fall below it. - - - AutoGenerateNavMesh - boolean - true - false - false - 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. - - - Raycast - RayResult - - origin - Vector3 - false - - - - direction - Vector3 - false - - - - maxDistance - number - true - 10000 - - - ignoreList - table - true - - - false - false - false - Casts a ray from origin with a specified direction and returns a RayResult for the first hit object. - - - RaycastAll - table - - origin - Vector3 - false - - - - direction - Vector3 - false - - - - maxDistance - number - true - 1000 - - - ignoreList - table - true - - - false - false - false - Casts a ray from origin with a specified direction and returns a RayResult array for all hit objects. - - - OverlapSphere - table - - origin - Vector3 - false - - - - radius - number - false - - - - ignoreList - table - true - - - false - false - false - Returns a list of instances intersecting with the sphere in the given position and radius. - - - OverlapBox - table - - pos - Vector3 - false - - - - size - Vector3 - false - - - - rot - Vector3 - false - - - - ignoreList - table - true - - - false - false - false - Returns a list of instances intersecting with the box in the given position, size and rotation. - - - RebuildNavMesh - nil - false - false - false - Rebuilds the navigation mesh which determines the empty space where NPCs can pathfind in. - - - GetPointOnNavMesh - Vector3 - - toPoint - Vector3 - false - - - false - false - false - Returns a point on the navigation mesh at the given position. - - true - false - false - Environment is the primary object intended for storing active objects in the place. - diff --git a/xml/types/Explosion.xml b/xml/types/Explosion.xml deleted file mode 100644 index e463980..0000000 --- a/xml/types/Explosion.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - Explosion - Dynamic - - Radius - number - true - false - false - Determines the radius of this explosion - - - Force - number - true - false - false - Determines the force of this explosion that will be applied to affected hits - - - AffectAnchored - boolean - true - false - false - Determines if this explosion should affect anchored parts or not - - - Damage - number - true - false - false - Damage that is affected to player - - - AffectPredicate - function - true - false - false - A predicate function deciding whenever this part should be accepted or not - -Example usage: -```lua -explosion.AffectPredicate = function(hit) - -- always explode - return true -end -``` - - - Hitted - - hit - Instance - - Fires when this explosion affects a hit - - false - false - true - Explosion is a deadly explosion killing players and applying force to parts at the given position. - diff --git a/xml/types/FileLinkAsset.xml b/xml/types/FileLinkAsset.xml deleted file mode 100644 index 78ff50c..0000000 --- a/xml/types/FileLinkAsset.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - FileLinkAsset - BaseAsset - - LinkedID - string - false - false - false - The ID of the file - - false - false - true - Represents a link to a file path in the file system - diff --git a/xml/types/FilterService.xml b/xml/types/FilterService.xml deleted file mode 100644 index d3b1f9b..0000000 --- a/xml/types/FilterService.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - FilterService - Instance - - Filter - string - - input - string - false - - - false - false - true - Filter a string - - true - false - false - FilterService is a service which processes and filter user inputs - diff --git a/xml/types/Folder.xml b/xml/types/Folder.xml deleted file mode 100644 index 941dcfe..0000000 --- a/xml/types/Folder.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - Folder - Instance - false - false - true - Folder is similar to a model, used for storing objects in the place. - diff --git a/xml/types/FontAsset.xml b/xml/types/FontAsset.xml deleted file mode 100644 index 9170f8d..0000000 --- a/xml/types/FontAsset.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - FontAsset - ResourceAsset - false - true - false - Base class for font assets - diff --git a/xml/types/GUI.xml b/xml/types/GUI.xml deleted file mode 100644 index 443f431..0000000 --- a/xml/types/GUI.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - GUI - UIField - false - false - true - GUI is a class that is used to create a GUI. - diff --git a/xml/types/GUI3D.xml b/xml/types/GUI3D.xml deleted file mode 100644 index 38dc187..0000000 --- a/xml/types/GUI3D.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - GUI3D - Dynamic - - CanvasSize - Vector2 - true - false - false - Determines the canvas size for this GUI - - - Shaded - boolean - true - false - false - Determines if this GUI3D should be affected by lighting - - - FaceCamera - boolean - true - false - false - Determines if this GUI3D always face the camera? - - - Transparent - boolean - true - false - false - Determines if the background should be transparent. Recommended to be set to false if transparent background is not needed. - - false - false - true - GUI3D is a class that allows GUI to be displayed in a 3D space. - diff --git a/xml/types/Game.xml b/xml/types/Game.xml deleted file mode 100644 index a31db2d..0000000 --- a/xml/types/Game.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - Game - Instance - - IsLocalTest - boolean - true - true - false - Missing Documentation - - - GameID - number - true - true - false - The ID of the current Polytoria place. - - - ServerID - number - true - true - false - The server ID of the current instance. - - - UpTime - number - true - true - false - The uptime of this game in seconds. - - - InstanceCount - number - true - true - false - The total number of instances currently loaded. - - - Ready - - Fires when the game is ready - - - Rendered - - delta - number - - Fires every frame after the place has been rendered. The `delta` parameter is the time between the last frame and the current. - - true - false - false - Game is the root object in the Polytoria instance tree. It is the object from which everything is descended. - diff --git a/xml/types/Grabbable.xml b/xml/types/Grabbable.xml deleted file mode 100644 index 1716572..0000000 --- a/xml/types/Grabbable.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - Grabbable - Instance - - Force - number - true - false - false - Determines the force used to drag this object. - - - MaxRange - number - true - false - false - Determines the max range that this object can be dragged. - - - PermissionMode - GrabbablePermissionModeEnum - true - false - false - Determines the permission mode for this grabber - - - Dragger - Player - true - true - false - Returns the current dragger - - - PermissionPredicate - function - true - false - false - A predicate function deciding whenever this player can grab this object. `PermissionMode` must be set to `GrabbablePermissionMode.Scripted` - -Example usage: -```lua -grabbable.PermissionMode = Enums.GrabbablePermissionMode.Scripted -grabbable.PermissionPredicate = function(player) - return player.Name == "Player1" -end -``` - - - Grabbed - - grabber - Player - - Fires when this object has been grabbed - - - Released - - Fires when this object has been released - - false - false - true - Grabbable represents a object that can be dragged by user. It can be parented to Physical to give user ability to drag that object. - diff --git a/xml/types/GradientSky.xml b/xml/types/GradientSky.xml deleted file mode 100644 index 7a775f2..0000000 --- a/xml/types/GradientSky.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - GradientSky - Sky - - SunDiscColor - Color - true - false - false - Determines the color emitting off the sun. - - - SunDiscMultiplier - number - true - false - false - Determines the multiplier of the sun. - - - SunDiscExponent - number - true - false - false - Determines the exponent of the sun. - - - SunHaloColor - Color - true - false - false - Determines the color of the sun halo. - - - SunHaloExponent - number - true - false - false - Determines the exponent of the sun halo. - - - SunHaloContribution - number - true - false - false - Determines the contribution of the sun halo. - - - HorizonLineColor - Color - true - false - false - Determines the horizon line's color. - - - HorizonLineExponent - number - true - false - false - Determines the horizon line's exponent. - - - HorizonLineContribution - number - true - false - false - Determines how much the horizon line contributes. - - - SkyGradientTop - Color - true - false - false - Determines the top color of the gradient. - - - SkyGradientBottom - Color - true - false - false - Determines the bottom color of the gradient. - - - SkyGradientExponent - number - true - false - false - Determines the gradient's exponent. - - false - false - true - GradientSky is a class that is used to set a gradient skybox in the world. - diff --git a/xml/types/Hidden.xml b/xml/types/Hidden.xml deleted file mode 100644 index 9c54598..0000000 --- a/xml/types/Hidden.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - Hidden - Instance - false - false - false - Hidden is a object used for hiding instances. - diff --git a/xml/types/HttpRequestData.xml b/xml/types/HttpRequestData.xml deleted file mode 100644 index a35b6b8..0000000 --- a/xml/types/HttpRequestData.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - HttpRequestData - - - URL - string - true - false - false - The target endpoint of the HTTP request. - - - Method - HttpRequestMethodEnum - true - false - false - The HTTP method used for the request. - - - Body - string - true - false - false - The payload sent with the request. - - - Headers - table - true - false - false - A table of HTTP headers to include with the request, represented as key-value pairs. - - - New - HttpRequestData - false - false - true - Creates and returns a new instance of `HttpRequestData` - - false - false - false - HttpRequestData represents the data required to construct an HTTP request - diff --git a/xml/types/HttpResponseData.xml b/xml/types/HttpResponseData.xml deleted file mode 100644 index dd76fbb..0000000 --- a/xml/types/HttpResponseData.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - HttpResponseData - - - Success - boolean - true - true - false - Indicates whether the HTTP request completed successfully. - - - StatusCode - number - true - true - false - The HTTP status code returned by the server. - - - Headers - table - true - true - false - A table containing the HTTP response headers returned by the server, represented as key-value pairs. - - - Body - string - true - true - false - The response payload returned by the server as a string buffer. - - false - false - false - HttpResponseData represents the result of an HTTP request. - diff --git a/xml/types/HttpService.xml b/xml/types/HttpService.xml deleted file mode 100644 index d2744f5..0000000 --- a/xml/types/HttpService.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - HttpService - Instance - - RequestAsync - HttpResponseData - - data - HttpRequestData - false - - - true - false - false - Send a request using the `HttpRequestData` - - - GetAsync - string - - url - string - false - - - - headers - table - true - - - true - false - false - Sends a GET request to the specified URL. - - - PostAsync - string - - url - string - false - - - - body - string - false - - - - headers - table - true - - - true - false - false - Sends a POST request to the specified URL. - - - PutAsync - string - - url - string - false - - - - body - string - false - - - - headers - table - true - - - true - false - false - Sends a PUT request to the specified URL. - - - DeleteAsync - string - - url - string - false - - - - body - string - false - - - - headers - table - true - - - true - false - false - Sends a DELETE request to the specified url. - - - PatchAsync - string - - url - string - false - - - - body - string - false - - - - headers - table - true - - - true - false - false - Sends a PATCH request to the specified url. - - true - false - false - Http is a service used for HTTP communications and requests. - diff --git a/xml/types/IOService.xml b/xml/types/IOService.xml deleted file mode 100644 index 215be07..0000000 --- a/xml/types/IOService.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - IOService - Instance - - ReadBytesFromPath - string - - path - string - false - - - false - false - false - Read the file data from path - - - WriteBytesToPath - nil - - path - string - false - - - - bytes - string - false - - - true - false - false - Write data to file in the project - - - ListProjectFiles - table - false - false - false - List all files in the project - - - ReadBytesFromID - string - - id - string - false - - - false - false - false - Read the file data from linked ID - - - GetPathFromID - string - - indexID - string - false - - - false - false - false - Get the file path from linked ID - - true - false - false - Class for interacting with IO in project, only usable with scripts with the respective permission. - diff --git a/xml/types/Image3D.xml b/xml/types/Image3D.xml deleted file mode 100644 index 17c4204..0000000 --- a/xml/types/Image3D.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - Image3D - Dynamic - - Image - ImageAsset - true - false - false - Specifies the image of the decal. - - - TextureScale - Vector2 - true - false - false - The scale of the texture on the decal. - - - TextureOffset - Vector2 - true - false - false - The offset of the texture on the decal. - - - Color - Color - true - false - false - Determines the color of the decal. - - - CastShadows - boolean - true - false - false - Determines whether or not the decal should cast shadows. - - - Shaded - boolean - true - false - false - Determines whether or not the decal should be affected by lighting. - - - FaceCamera - boolean - true - false - false - Determines whether or not the decal should always face the camera. - - false - false - true - Decals are objects that can have an image texture and are placed in the world. - diff --git a/xml/types/ImageAsset.xml b/xml/types/ImageAsset.xml deleted file mode 100644 index 91d06dc..0000000 --- a/xml/types/ImageAsset.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - ImageAsset - ResourceAsset - false - true - false - Base class for image assets - diff --git a/xml/types/InputAction.xml b/xml/types/InputAction.xml deleted file mode 100644 index acc155c..0000000 --- a/xml/types/InputAction.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - InputAction - - false - false - false - Base class for input action - diff --git a/xml/types/InputActionAxis.xml b/xml/types/InputActionAxis.xml deleted file mode 100644 index e9ed077..0000000 --- a/xml/types/InputActionAxis.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - InputActionAxis - InputAction - - Negative - InputButtonCollection - true - false - false - Missing Documentation - - - Positive - InputButtonCollection - true - false - false - Missing Documentation - - - Value - number - true - true - false - Missing Documentation - - false - false - false - InputActionAxis is a class that represents input action of axis type. - diff --git a/xml/types/InputActionButton.xml b/xml/types/InputActionButton.xml deleted file mode 100644 index fde6f07..0000000 --- a/xml/types/InputActionButton.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - InputActionButton - InputAction - - Buttons - InputButtonCollection - true - true - false - Missing Documentation - - - IsPressed - boolean - true - false - false - Missing Documentation - - - Weight - number - true - false - false - Missing Documentation - - - Pressed - - Fires when this button has been pressed - - - Released - - Fires when this button has been released - - false - false - false - InputActionButton is a class that represents input action of button type. - diff --git a/xml/types/InputActionVector2.xml b/xml/types/InputActionVector2.xml deleted file mode 100644 index 8c37a8f..0000000 --- a/xml/types/InputActionVector2.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - InputActionVector2 - InputAction - - Up - InputButtonCollection - true - false - false - Missing Documentation - - - Down - InputButtonCollection - true - false - false - Missing Documentation - - - Left - InputButtonCollection - true - false - false - Missing Documentation - - - Right - InputButtonCollection - true - false - false - Missing Documentation - - - Value - Vector2 - true - true - false - Missing Documentation - - false - false - false - InputActionVector2 is a class that represents input action of Vector2 type. - diff --git a/xml/types/InputButton.xml b/xml/types/InputButton.xml deleted file mode 100644 index 474bee0..0000000 --- a/xml/types/InputButton.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - InputButton - - - KeyCode - KeyCodeEnum - true - false - false - Missing Documentation - - - New - InputButton - false - false - true - Missing Documentation - - - New - InputButton - - key - KeyCodeEnum - false - - - false - false - true - Missing Documentation - - false - false - false - InputButton is a class that represents a button KeyCode - diff --git a/xml/types/InputButtonCollection.xml b/xml/types/InputButtonCollection.xml deleted file mode 100644 index a4e9aa2..0000000 --- a/xml/types/InputButtonCollection.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - InputButtonCollection - - - AddButton - nil - - btn - InputButton - false - - - false - false - false - Missing Documentation - - - RemoveButton - nil - - btn - InputButton - false - - - false - false - false - Missing Documentation - - false - false - false - A collection of Input Buttons - diff --git a/xml/types/InputService.xml b/xml/types/InputService.xml deleted file mode 100644 index 066a0da..0000000 --- a/xml/types/InputService.xml +++ /dev/null @@ -1,243 +0,0 @@ - - - InputService - Instance - - IsWindowFocused - boolean - true - true - false - Indicates whether the game window is currently focused. - - - IsTouchscreen - boolean - true - true - false - Indicates whether the input device is a touchscreen. - - - IsGameFocused - boolean - true - true - false - Indicates whether the game is currently focused. - - - IsInputFocused - boolean - true - true - false - Indicates whether an input is currently focused. - - - IsGamepadConnected - boolean - true - true - false - Indicates whether a gamepad is currently connected. - - - IsMenuOpened - boolean - true - true - false - Indicates whether the game menu is currently opened. - - - CursorLocked - boolean - true - false - false - Determines whether the cursor is currently locked. - - - CursorVisible - boolean - true - false - false - Determines whether the cursor is currently visible. - - - MousePosition - Vector2 - true - true - false - Indicates the current position of the mouse cursor. - - - ScreenWidth - number - true - true - false - Indicates the width of the screen. - - - ScreenHeight - number - true - true - false - Indicates the height of the screen. - - - GetMouseWorldPosition - Vector3 - - ignoreList - table - true - - - false - false - false - Returns the 3D world-space position corresponding to the current mouse cursor location. - - - GetVector2 - InputActionVector2 - - actionName - string - false - - - false - false - false - Missing Documentation - - - GetButton - InputActionButton - - actionName - string - false - - - false - false - false - Returns true if the specified button is being held down. - - - GetAxis - InputActionAxis - - actionName - string - false - - - false - false - false - Returns the value of the specified axis. - - - BindButton - InputActionButton - - name - string - false - - - false - false - false - Missing Documentation - - - BindAxis - InputActionAxis - - name - string - false - - - false - false - false - Missing Documentation - - - BindVector2 - InputActionVector2 - - name - string - false - - - false - false - false - Missing Documentation - - - GameFocused - - Fires when the game has been focused - - - GameUnfocused - - Fires when the game has been unfocused - - - GamepadConnected - - Fires when gamepad is connected - - - GamepadDisconnected - - Fires when gamepad has been disconnected - - - KeyDown - - keycode - KeyCodeEnum - - Fires when key has been pressed - - - KeyUp - - keycode - KeyCodeEnum - - Fires when key has been released - - - AxisValueChanged - - keycode - KeyCodeEnum - - - value - float - - Fires when analog input has been changed - - true - false - false - InputService is a class used for retrieving user input data, such as the mouse and keyboard. - diff --git a/xml/types/InsertService.xml b/xml/types/InsertService.xml deleted file mode 100644 index 381cb1d..0000000 --- a/xml/types/InsertService.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - InsertService - Instance - - ModelAsync - Instance - - id - number - false - - - true - false - false - Inserts a model with the specified ID. - - - AccessoryAsync - Accessory - - id - number - false - - - true - false - false - Inserts an accessory with the specified ID. - - - ToolAsync - Tool - - id - number - false - - - true - false - false - Missing Documentation - - true - false - false - Insert is a class used for inserting user-generated models into your game via scripts. - diff --git a/xml/types/Instance.xml b/xml/types/Instance.xml deleted file mode 100644 index 0692e4b..0000000 --- a/xml/types/Instance.xml +++ /dev/null @@ -1,303 +0,0 @@ - - - Instance - NetworkedObject - - Parent - Instance - true - false - false - Defines the parent of this instance in the hierarchy. - - - EditableChildren - boolean - false - false - false - Missing Documentation - - - Tags - table - true - false - false - Tags associated with this instance. - - - GetDescendants - table - false - false - false - Gets all descendants of this instance. - - - FindChild - Instance - - name - string - false - - - false - false - false - Finds a child of this instance by name. - - - WaitChild - Instance - - name - string - false - - - - timeoutSec - number - true - - - true - false - false - Missing Documentation - - - FindChildByClass - Instance - - className - string - false - - - false - false - false - Finds a child of this instance by class name. - - - MoveChild - nil - - child - Instance - false - - - - index - number - false - - - false - false - false - Missing Documentation - - - GetChildren - table - false - false - false - Gets all children of this instance. - - - GetChildrenOfClass - table - - className - string - false - - - false - false - false - Gets all children of this instance that are of the specified class. - - - IsAncestorOf - boolean - - instance - Instance - false - - - false - false - false - Determines if this instance is an ancestor of the given instance. - - - IsDescendantOf - boolean - - instance - Instance - false - - - false - false - false - Determines if this instance is a descendant of the given instance. - - - IsDescendantOfClass - boolean - - className - string - false - - - false - false - false - Determines if this instance is a descendant of the given class. - - - New - Instance - - className - string - false - - - - parent - Instance - true - - - false - false - true - Creates a new instance of the specified class. - - - AddTag - nil - - tag - string - false - - - false - false - false - Adds a tag to this instance. - - - RemoveTag - nil - - tag - string - false - - - false - false - false - Removes a tag from this instance. - - - HasTag - boolean - - tag - string - false - - - false - false - false - Checks if this instance has the specified tag. - - - Reparent - nil - - to - Instance - false - - - false - false - false - Missing Documentation - - - GetParent - Instance - false - false - false - Gets the parent of this instance. - - - SetParent - nil - - newParent - Instance - false - - - false - false - false - Sets the parent of this instance. - - - ChildAdded - - child - Instance - - Fires when child has been added to this instance - - - ChildRemoved - - child - Instance - - Fires when child has been removed from this instance (either via reparent or delete) - - - ChildDeleting - - child - Instance - - Fires when child is being deleted from this instance - - - ChildDeleted - - child - Instance - - Fires when child has been deleted from this instance - - false - true - false - Instance is the base class of all classes. Every class derives from it and has all properties, events and functions Instance has. - diff --git a/xml/types/InstanceValue.xml b/xml/types/InstanceValue.xml deleted file mode 100644 index 0b121a4..0000000 --- a/xml/types/InstanceValue.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - InstanceValue - ValueBase - - Value - Instance - true - false - false - The value of this object. - - false - false - true - InstanceValue is an object that holds an Instance value. - diff --git a/xml/types/IntValue.xml b/xml/types/IntValue.xml deleted file mode 100644 index 0a26971..0000000 --- a/xml/types/IntValue.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - IntValue - ValueBase - - Value - number - true - false - false - The value of this object. - - false - false - true - IntValue is an object that holds an integer value. - diff --git a/xml/types/InteractionPrompt.xml b/xml/types/InteractionPrompt.xml deleted file mode 100644 index baa90ff..0000000 --- a/xml/types/InteractionPrompt.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - InteractionPrompt - Dynamic - - Title - string - true - false - false - Missing Documentation - - - SubTitle - string - true - false - false - Missing Documentation - - - HoldDuration - number - true - false - false - Missing Documentation - - - Key - KeyCodeEnum - true - false - false - Missing Documentation - - - UseDefaultUI - boolean - true - false - false - Missing Documentation - - - Triggered - - Missing Documentation - - - TriggerStarted - - Missing Documentation - - - TriggerReleased - - Missing Documentation - - false - false - true - WIP class, not functional yet - diff --git a/xml/types/Inventory.xml b/xml/types/Inventory.xml deleted file mode 100644 index 96f0bef..0000000 --- a/xml/types/Inventory.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - Inventory - Hidden - true - false - false - Missing Documentation - diff --git a/xml/types/Light.xml b/xml/types/Light.xml deleted file mode 100644 index 68e1160..0000000 --- a/xml/types/Light.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - Light - Dynamic - - Color - Color - true - false - false - Sets the color of the light. - - - Brightness - number - true - false - false - Sets the brightness of the light. - - - Specular - number - true - false - false - Sets the specular intensity of the light. - - - Shadows - boolean - true - false - false - Enables or disables shadows cast by the light. - - false - true - false - Light is an abstract base class for all light objects in the world. - diff --git a/xml/types/Lighting.xml b/xml/types/Lighting.xml deleted file mode 100644 index 2bf7487..0000000 --- a/xml/types/Lighting.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - Lighting - Instance - - Skybox - SkyboxEnum - true - false - false - Sets the skybox to one of the preset skyboxes. - - - AmbientSource - AmbientSourceEnum - true - false - false - Determines the source of ambient lighting in the place. - - - AmbientColor - Color - true - false - false - Sets the ambient color of the lighting in the place. - - - FogEnabled - boolean - true - false - false - Enables or disables fog in the place. - - - FogColor - Color - true - false - false - Sets the color of the fog in the place. - - - FogStartDistance - number - true - false - false - Sets the distance from the camera at which fog begins to appear. - - - FogEndDistance - number - true - false - false - Sets the distance from the camera at which fog stops appearing. - - true - false - false - 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. - diff --git a/xml/types/LightingModifier.xml b/xml/types/LightingModifier.xml deleted file mode 100644 index b3c36a6..0000000 --- a/xml/types/LightingModifier.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - LightingModifier - Instance - false - true - false - Base class for lighting modifiers - diff --git a/xml/types/Marker3D.xml b/xml/types/Marker3D.xml deleted file mode 100644 index d115c19..0000000 --- a/xml/types/Marker3D.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - Marker3D - Dynamic - - Length - number - true - false - false - Missing Documentation - - - AppearOnTop - boolean - true - false - false - Missing Documentation - - false - false - true - Marker3D is a object that allows marking a specific point in world. This will hint an axis gizmo in local test and creator. - diff --git a/xml/types/Mesh.xml b/xml/types/Mesh.xml deleted file mode 100644 index 3d8b534..0000000 --- a/xml/types/Mesh.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - Mesh - Entity - - Asset - MeshAsset - true - false - false - The mesh asset used by this Mesh. - - - IncludeOffset - boolean - true - false - false - Whether to keep the offset of the mesh or recenter it. - - - CollisionType - CollisionTypeEnum - true - false - false - The type of collision shape to apply to the mesh. - - - PlayAnimationOnStart - boolean - true - false - false - Whether to play the mesh's animation automatically when the mesh is loaded. - - - UsePartColor - boolean - true - false - false - Whether to use the color of the part this mesh is attached to. - - - Color - Color - true - false - false - The color of the mesh. - - - CastShadows - boolean - true - false - false - Whether the mesh casts shadows. - - - CurrentAnimation - string - true - true - false - Indicates the name of the current animation playing on the mesh. - - - IsAnimationPlaying - boolean - true - true - false - Indicates whether an animation is currently playing on the mesh. - - - PlayAnimation - nil - - animationName - string - false - - - - speed - number - true - 1 - - - loop - boolean - true - True - - false - false - false - Plays the specified animation on the mesh. - - - StopAnimation - nil - - animationName - string - true - - - false - false - false - Stops the specified animation on the mesh. - - - GetAnimations - table - false - false - false - Gets a list of all animations available on the mesh. - - false - false - true - 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. - diff --git a/xml/types/MeshAsset.xml b/xml/types/MeshAsset.xml deleted file mode 100644 index b4d988f..0000000 --- a/xml/types/MeshAsset.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - MeshAsset - ResourceAsset - false - true - false - Base class for mesh assets - diff --git a/xml/types/Model.xml b/xml/types/Model.xml deleted file mode 100644 index 25fadc4..0000000 --- a/xml/types/Model.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - Model - Dynamic - false - false - true - Model is an instance that can hold other instances, and which transform affects its children. - diff --git a/xml/types/ModuleScript.xml b/xml/types/ModuleScript.xml deleted file mode 100644 index b41d4bb..0000000 --- a/xml/types/ModuleScript.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - ModuleScript - Script - false - false - true - 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 and the client will run the ModuleScript once and store the result for other scripts to retrieve with require(). - diff --git a/xml/types/NPC.xml b/xml/types/NPC.xml deleted file mode 100644 index 1e35049..0000000 --- a/xml/types/NPC.xml +++ /dev/null @@ -1,322 +0,0 @@ - - - NPC - Physical - - SeatOffset - Vector3 - true - false - false - The offset to the seat at which the NPC is positioned when sitting. - - - Health - number - true - false - false - The current health of the NPC. - - - MaxHealth - number - true - false - false - The maximum health of the NPC. - - - JumpPower - number - true - false - false - Determines the jump power of the NPC. - - - WalkSpeed - number - true - false - false - Determines the walking speed of the NPC. - - - UseNametag - boolean - true - false - false - Determines whether the NPC uses a nametag. - - - NametagOffset - Vector3 - true - false - false - Determines the offset position of the NPC's nametag. - - - DisplayName - string - true - false - false - Determines the display name of the NPC. - - - JumpSound - Sound - true - false - false - Determines the sound played when the NPC jumps. - - - IsSitting - boolean - true - true - false - Indicates whether the NPC is currently sitting. - - - IsDead - boolean - true - true - false - Indicates whether the NPC is currently dead. - - - HoldingTool - Tool - true - true - false - Indicates the tool currently held by the NPC. - - - SittingIn - Seat - true - true - false - Indicates the seat in which the NPC is currently sitting. - - - Character - CharacterModel - true - true - false - The character model associated with the NPC. - - - MoveTarget - Dynamic - true - false - false - Determines the instance the NPC should walk towards. - - - OnGround - boolean - true - true - false - Indicates whether the NPC is currently on the ground. - - - OnCeiling - boolean - true - true - false - Indicates whether the NPC is currently on the ceiling. - - - NavDestinationDistance - number - true - true - false - Indicates the distance to the navigation destination. - - - NavDestinationReached - boolean - true - true - false - Indicates whether the NPC has reached its navigation destination. - - - NavDestinationValid - boolean - true - true - false - Indicates whether the navigation destination is valid. - - - Kill - nil - false - false - false - Kills the NPC. - - - Jump - nil - false - false - false - Makes the NPC jump. - - - Sit - nil - - seat - Seat - false - - - false - false - false - Makes the NPC sit on a specified seat. - - - Unsit - nil - - addForce - boolean - true - True - - false - false - false - Unsits the NPC from the current seat. - - - EquipTool - nil - - tool - Tool - false - - - false - false - false - Equips the NPC with a specified tool. - - - DropTool - nil - false - false - false - Unequips the currently equipped tool from the NPC. - - - LoadAppearance - nil - - userID - number - false - - - false - false - false - Loads the appearance of the NPC based on a user ID. - - - ClearAppearance - nil - false - false - false - Clears the NPC's current appearance. - - - SetNavDestination - nil - - pos - Vector3 - false - - - false - false - false - Determines the position the NPC should walk towards. - - - Respawn - nil - false - false - false - Respawns the NPC. - - - TakeDamage - nil - - dmg - number - false - - - false - false - false - Applies damage to the NPC. - - - Heal - nil - - amount - number - false - - - false - false - false - Heals the NPC by a specified amount. - - - Died - - Triggered when the NPC dies. - - - Landed - - Triggered when the NPC lands on the ground after a jump or fall. - - - NavFinished - - Triggered when the NPC finishes navigating to a destination. - - false - false - true - 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. - diff --git a/xml/types/NetMessage.xml b/xml/types/NetMessage.xml deleted file mode 100644 index ec938d5..0000000 --- a/xml/types/NetMessage.xml +++ /dev/null @@ -1,289 +0,0 @@ - - - NetMessage - - - AddString - nil - - key - string - false - - - - value - string - false - - - false - false - false - Adds a string value to the message with the specified key. - - - AddInt - nil - - key - string - false - - - - value - number - false - - - false - false - false - Adds an integer value to the message with the specified key. - - - AddBool - nil - - key - string - false - - - - value - boolean - false - - - false - false - false - Adds a boolean value to the message with the specified key. - - - AddNumber - nil - - key - string - false - - - - value - number - false - - - false - false - false - Adds a number value to the message with the specified key. - - - AddVector2 - nil - - key - string - false - - - - value - Vector2 - false - - - false - false - false - Adds a Vector2 value to the message with the specified key. - - - AddVector3 - nil - - key - string - false - - - - value - Vector3 - false - - - false - false - false - Adds a Vector3 value to the message with the specified key. - - - AddColor - nil - - key - string - false - - - - value - Color - false - - - false - false - false - Adds a Color value to the message with the specified key. - - - AddInstance - nil - - key - string - false - - - - value - Instance - false - - - false - false - false - Adds an Instance value to the message with the specified key. - - - GetString - string - - key - string - false - - - false - false - false - Gets a string value from the message with the specified key. - - - GetInt - number - - key - string - false - - - false - false - false - Gets an integer value from the message with the specified key. - - - GetNumber - number - - key - string - false - - - false - false - false - Gets a number value from the message with the specified key. - - - GetBool - boolean - - key - string - false - - - false - false - false - Gets a boolean value from the message with the specified key. - - - GetVector2 - Vector2 - - key - string - false - - - false - false - false - Gets a Vector2 value from the message with the specified key. - - - GetVector3 - Vector3 - - key - string - false - - - false - false - false - Gets a Vector3 value from the message with the specified key. - - - GetColor - Color - - key - string - false - - - false - false - false - Gets a Color value from the message with the specified key. - - - GetInstance - Instance - - key - string - false - - - false - false - false - Gets an Instance value from the message with the specified key. - - - New - NetMessage - false - false - true - Creates a new NetMessage instance. - - false - false - false - Represents a network message used for communication between clients and servers. - diff --git a/xml/types/NetworkEvent.xml b/xml/types/NetworkEvent.xml deleted file mode 100644 index e9c37d1..0000000 --- a/xml/types/NetworkEvent.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - NetworkEvent - Instance - - Reliable - boolean - true - false - false - Missing Documentation - - - InvokeServer - nil - - msg - NetMessage - false - - - - _ - any - true - - - false - false - false - Sends a message to the server. - - - InvokeClient - nil - - msg - NetMessage - false - - - - player - Player - false - - - false - false - false - Sends a message to a specific client. - - - InvokeClients - nil - - msg - NetMessage - false - - - false - false - false - Sends a message to all connected clients. - - - InvokedServer - - sender - Player - - - msg - NetMessage - - Fires when server receives message from client - - - InvokedClient - - sender - nil - - - msg - NetMessage - - Fires when client receives message from server - - false - false - true - Missing Documentation - diff --git a/xml/types/NetworkService.xml b/xml/types/NetworkService.xml deleted file mode 100644 index 9549144..0000000 --- a/xml/types/NetworkService.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - NetworkService - Instance - false - false - false - Missing Documentation - diff --git a/xml/types/NetworkedObject.xml b/xml/types/NetworkedObject.xml deleted file mode 100644 index e1b1026..0000000 --- a/xml/types/NetworkedObject.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - NetworkedObject - - - Name - string - true - false - false - Missing Documentation - - - ClassName - string - true - true - false - Missing Documentation - - - Shared - ScriptSharedTable - true - true - false - Missing Documentation - - - NetworkedObjectID - string - true - true - false - Missing Documentation - - - ObjectID - string - true - true - false - Missing Documentation - - - ExistInNetwork - boolean - true - true - false - Missing Documentation - - - IsA - boolean - - className - string - false - - - false - false - false - Missing Documentation - - - Clone - NetworkedObject - - parent - NetworkedObject - true - - - false - false - false - Missing Documentation - - - Destroy - nil - - time - number - true - 0 - - false - false - false - Missing Documentation - - - Delete - nil - - time - number - true - 0 - - false - false - false - Missing Documentation - - - PropertyChanged - - propertyName - string - - Missing Documentation - - - Renamed - - Missing Documentation - - - TreeEntered - - Missing Documentation - - - TreeExited - - Missing Documentation - - false - true - false - Missing Documentation - diff --git a/xml/types/NewServerRequestData.xml b/xml/types/NewServerRequestData.xml deleted file mode 100644 index f1d0dd1..0000000 --- a/xml/types/NewServerRequestData.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - NewServerRequestData - - - PlacePath - string - true - false - false - Missing Documentation - - - MaxPlayers - number - true - false - false - Missing Documentation - - - New - NewServerRequestData - false - false - true - Missing Documentation - - false - false - false - NewServerRequestData represents the request data for a new server instance, to be used with PlacesService. - diff --git a/xml/types/NumberRange.xml b/xml/types/NumberRange.xml deleted file mode 100644 index e620f97..0000000 --- a/xml/types/NumberRange.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - NumberRange - ValueType - - Min - number - true - false - false - Determines the minimum value of the range. - - - Max - number - true - false - false - Determines the maximum value of the range. - - - New - NumberRange - - from - number - false - - - - to - number - false - - - false - false - true - Creates a new NumberRange object with the specified minimum and maximum values. - - - Lerp - number - - t - number - false - - - false - false - false - Linearly interpolates between the minimum and maximum values of the range based on the parameter t, which is typically between 0 and 1. - - false - false - false - NumberRange is a data type that represents a range between two numbers, defined by a minimum and maximum value. - diff --git a/xml/types/NumberValue.xml b/xml/types/NumberValue.xml deleted file mode 100644 index 8c5b687..0000000 --- a/xml/types/NumberValue.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - NumberValue - ValueBase - - Value - number - true - false - false - The value of this object. - - false - false - true - NumberValue is an object that holds a number value. - diff --git a/xml/types/PTAudioAsset.xml b/xml/types/PTAudioAsset.xml deleted file mode 100644 index d397e26..0000000 --- a/xml/types/PTAudioAsset.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - PTAudioAsset - AudioAsset - - AudioID - number - false - false - false - Missing Documentation - - false - false - true - Audio asset which is loaded from Polytoria - diff --git a/xml/types/PTCallback.xml b/xml/types/PTCallback.xml deleted file mode 100644 index d136e5b..0000000 --- a/xml/types/PTCallback.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - PTCallback - - false - false - false - A function that doesn't expect a return value. This will sometimes be referred as `function` - diff --git a/xml/types/PTFunction.xml b/xml/types/PTFunction.xml deleted file mode 100644 index 65fba26..0000000 --- a/xml/types/PTFunction.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - PTFunction - - false - false - false - A function that expects a return value. This will sometimes be referred as `function` - diff --git a/xml/types/PTImageAsset.xml b/xml/types/PTImageAsset.xml deleted file mode 100644 index c1a0f0a..0000000 --- a/xml/types/PTImageAsset.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - PTImageAsset - ImageAsset - - ImageID - number - true - false - false - Asset ID of this image - - - ImageType - ImageTypeEnum - true - false - false - Image type of this image - - false - false - true - An image asset that's loaded from Polytoria. - diff --git a/xml/types/PTMeshAsset.xml b/xml/types/PTMeshAsset.xml deleted file mode 100644 index b8ea428..0000000 --- a/xml/types/PTMeshAsset.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - PTMeshAsset - MeshAsset - - AssetID - number - false - false - false - Asset ID of this mesh - - false - false - true - A mesh asset that's loaded from Polytoria. - diff --git a/xml/types/PTSignal.xml b/xml/types/PTSignal.xml deleted file mode 100644 index ad7c168..0000000 --- a/xml/types/PTSignal.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - PTSignal - - - Connect - nil - - action - function - false - - - false - false - false - Connect a function to this signal - - - Disconnect - nil - - action - function - false - - - false - false - false - Disconnect a function from this signal - - - Wait - any - true - false - false - Wait until this signal's emitted - - - Once - nil - - action - function - false - - - false - false - false - Listen to this signal only once - - false - false - false - A signal which scripts can subscribe to - diff --git a/xml/types/Part.xml b/xml/types/Part.xml deleted file mode 100644 index 198d610..0000000 --- a/xml/types/Part.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - Part - Entity - - Shape - ShapeEnum - true - false - false - Determines the shape of the part. - - - Material - PartMaterialEnum - true - false - false - Determines the material of the part. - - - Color - Color - true - false - false - Determines the color of the part. - - - CastShadows - boolean - true - false - false - Determines whether the part casts shadows. - - false - false - true - Parts represent the basic building blocks of the world. - diff --git a/xml/types/Particles.xml b/xml/types/Particles.xml deleted file mode 100644 index 1f51152..0000000 --- a/xml/types/Particles.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - Particles - Dynamic - - Image - ImageAsset - false - false - false - The image used for the particles. - - - Color - ColorSeries - true - false - false - The color gradient used for the particles. - - - Lifetime - NumberRange - true - false - false - Determines the lifetime of a particle. - - - Amount - number - true - false - false - Determines the number of particles emitted. - - - Gravity - number - true - false - false - Determines the gravity effect applied to the particles. - - - Shaded - boolean - true - false - false - Determines whether the particles are shaded. - - - Autoplay - boolean - true - false - false - Determines whether the particle system plays automatically. - - - Play - nil - false - false - false - Starts playing the particle system. - - - Stop - nil - false - false - false - Stops playing the particle system. - - - Emit - nil - - count - number - false - - - false - false - false - Emits a specified number of particles immediately. - - false - false - true - Particles represents a particle system that can be used to create various visual effects. - diff --git a/xml/types/Physical.xml b/xml/types/Physical.xml deleted file mode 100644 index 605e352..0000000 --- a/xml/types/Physical.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - Physical - Dynamic - - Anchored - boolean - true - false - false - Determines whether this object is affected by physics. - - - CanCollide - boolean - true - false - false - Determines whether this object can collide with other objects. - - - Velocity - Vector3 - true - false - false - Determines the linear velocity of this object. - - - AngularVelocity - Vector3 - true - false - false - Determines the angular velocity of this object. - - - SetNetworkAuthority - nil - - plr - Player - false - - - false - false - false - Sets the network authority of this object to the specified player. - - - Touched - - hit - Physical - - Fires when this object has collide with other object - - - TouchEnded - - hit - Physical - - Fires when this object has stopped colliding with other object - - - MouseEnter - - Fires when cursor is hovered on this object. Only fired locally - - - MouseExit - - Fires when cursor leaves this object. Only fired locally - - - Clicked - - player - Player - - Fires when this object has been clicked by a player - - false - true - false - Physical represents an object affected by physics in the world. - diff --git a/xml/types/PhysicalModel.xml b/xml/types/PhysicalModel.xml deleted file mode 100644 index 282917d..0000000 --- a/xml/types/PhysicalModel.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - PhysicalModel - Physical - false - false - true - PhysicalModel is a object that represent a group of objects, that's affected by physics. - diff --git a/xml/types/PlacesService.xml b/xml/types/PlacesService.xml deleted file mode 100644 index c43ccb1..0000000 --- a/xml/types/PlacesService.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - PlacesService - Instance - - NewServerAsync - string - - placePath - string - false - - - true - false - false - Request a new server with data - - - NewServerAsync - string - - data - NewServerRequestData - false - - - true - false - false - Request a new server with data - - - JoinPlaceAsync - nil - - plr - Player - false - - - - to - string - false - - - true - false - false - Join a player to a public server of the specified place - - - JoinPlacePartyAsync - nil - - plrs - table - false - - - - to - string - false - - - true - false - false - Join a party of player to a public server of the specified place - - - JoinPrivateAsync - nil - - plr - Player - false - - - - accessID - string - false - - - true - false - false - Join a player to a private server of the specified place - - - JoinPrivatePartyAsync - nil - - players - table - false - - - - accessID - string - false - - - true - false - false - Join a party of player to a private server of the specified place - - true - false - false - PlacesService is a service that is used to join players to other places - diff --git a/xml/types/Player.xml b/xml/types/Player.xml deleted file mode 100644 index ca2d938..0000000 --- a/xml/types/Player.xml +++ /dev/null @@ -1,236 +0,0 @@ - - - Player - NPC - - UserID - number - true - true - false - The unique ID of the player. - - - CanMove - boolean - true - false - false - Determines whether the player can move. - - - SprintSpeed - number - true - false - false - Determines the sprinting speed of the player. - - - Stamina - number - true - false - false - Determines the current stamina of the player. - - - MaxStamina - number - true - false - false - Determines the maximum stamina of the player. - - - UseStamina - boolean - true - false - false - Determines whether the player uses stamina. - - - StaminaRegen - number - true - false - false - Determines the rate at which the player's stamina regenerates. - - - StaminaBurn - number - true - false - false - Determines the rate at which the player's stamina depletes while sprinting. - - - RespawnTime - number - true - false - false - Determines the time the player has to wait before respawning. - - - UseHeadTurning - boolean - true - false - false - Determines whether the player uses head turning. - - - UseBubbleChat - boolean - true - false - false - Determines whether the player uses bubble chat. - - - AutoLoadAppearance - boolean - true - false - false - Determines whether the player's appearance is automatically loaded. - - - NetworkPing - number - true - true - false - The amount of network latency (ping) the player is experiencing. - - - IsAdmin - boolean - true - true - false - Determines whether the player is an administrator. - - - IsCreator - boolean - true - true - false - Determines whether the player is the creator of the game. - - - ChatColor - Color - true - false - false - Determines the chat color of the player. - - - IsLocal - boolean - true - true - false - Determines whether the player is the local player. - - - IsClimbing - boolean - true - true - false - Determines whether the player is currently climbing. - - - ClimbingTruss - Truss - true - true - false - Determines the truss the player is currently climbing. - - - UserPlatform - ClientPlatformEnum - true - true - false - Determines the platform the player is using. - - - Inventory - Inventory - true - true - false - The inventory of the player. - - - Jump - nil - false - false - false - Makes the player jump. - - - Kick - nil - - reason - string - false - - - false - false - false - Kicks the player from the game with the specified reason. - - - UnequipTool - nil - false - false - false - Unequips the currently equipped tool of the player. - - - Respawn - nil - false - false - false - Respawns the player. - - - ResetAppearance - nil - false - false - false - Resets the player's appearance to the default. - - - Chatted - - message - string - - Fires when this player chats - - - Respawned - - Fires when this player has respawned - - false - false - false - Player represents a user playing the game. - diff --git a/xml/types/PlayerDefaults.xml b/xml/types/PlayerDefaults.xml deleted file mode 100644 index bebe0f5..0000000 --- a/xml/types/PlayerDefaults.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - PlayerDefaults - Hidden - - MaxHealth - number - true - false - false - The default maximum health of the player. - - - WalkSpeed - number - true - false - false - The default walking speed of the player. - - - SprintSpeed - number - true - false - false - The default sprinting speed of the player. - - - JumpPower - number - true - false - false - The default jump power of the player. - - - RespawnTime - number - true - false - false - The default time the player has to wait before respawning. - - - ChatColor - Color - true - false - false - The default chat color of the player. - - - CanMove - boolean - true - false - false - Determines whether the player can move by default. - - - StaminaBurn - number - true - false - false - The rate at which the player's stamina depletes while sprinting. - - - UseStamina - boolean - true - false - false - Determines whether the player uses stamina. - - - Stamina - number - true - false - false - Determines the default stamina of players. - - - MaxStamina - number - true - false - false - Determines the default maximum stamina of players. - - - StaminaRegen - number - true - false - false - Determines the rate at which the player's stamina regenerates. - - - UseHeadTurning - boolean - true - false - false - Determines whether the player uses head turning by default. - - - UseBubbleChat - boolean - true - false - false - Determines whether the player uses bubble chat by default. - - - AutoLoadAppearance - boolean - true - false - false - Determines whether the player's appearance is automatically loaded by default. - - - LoadDefaults - nil - false - false - false - Resets the specified player back to their default values. - - true - false - false - PlayerDefaults is a service used for storing the default values of the Player when created. - diff --git a/xml/types/PlayerGUI.xml b/xml/types/PlayerGUI.xml deleted file mode 100644 index 4b2e25c..0000000 --- a/xml/types/PlayerGUI.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - PlayerGUI - Instance - true - false - false - PlayerGUI is a class that contains all custom GUIs. - diff --git a/xml/types/Players.xml b/xml/types/Players.xml deleted file mode 100644 index 02a3272..0000000 --- a/xml/types/Players.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - Players - Instance - - LocalPlayer - Player - true - true - false - The player who is currently playing the game. - - - PlayerCollisionEnabled - boolean - true - false - false - Determines whether or not collisions between players are enabled. - - - PlayersCount - number - true - true - false - The number of players currently in the game. - - - GetPlayers - table - false - false - false - Returns a table containing all the players currently in the game. - - - GetPlayer - Player - - username - string - false - - - false - false - false - Returns the player with the specified username. - - - GetPlayerByID - Player - - userID - number - false - - - false - false - false - Returns the player with the specified user ID. - - - PlayerAdded - - player - Player - - Fires when player has connected - - - PlayerRemoved - - player - Player - - Fires when player has disconnected - - true - false - false - Players is the container class for all Player instances. - diff --git a/xml/types/PointLight.xml b/xml/types/PointLight.xml deleted file mode 100644 index 9dab092..0000000 --- a/xml/types/PointLight.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - PointLight - Light - - Range - number - true - false - false - The range of the point light's illumination. - - false - false - true - PointLight is a type of light that emits light in all directions from a single point. - diff --git a/xml/types/PolytorianModel.xml b/xml/types/PolytorianModel.xml deleted file mode 100644 index 5460a48..0000000 --- a/xml/types/PolytorianModel.xml +++ /dev/null @@ -1,241 +0,0 @@ - - - PolytorianModel - CharacterModel - - HeadColor - Color - true - false - false - Missing Documentation - - - TorsoColor - Color - true - false - false - Missing Documentation - - - LeftArmColor - Color - true - false - false - Missing Documentation - - - RightArmColor - Color - true - false - false - Missing Documentation - - - LeftLegColor - Color - true - false - false - Missing Documentation - - - RightLegColor - Color - true - false - false - Missing Documentation - - - FaceImage - ImageAsset - true - false - false - Missing Documentation - - - ShirtImage - ImageAsset - true - false - false - Missing Documentation - - - PantsImage - ImageAsset - true - false - false - Missing Documentation - - - TorsoMesh - MeshAsset - true - false - false - Missing Documentation - - - Ragdolling - boolean - true - true - false - Missing Documentation - - - RagdollPosition - Vector3 - true - true - false - Missing Documentation - - - RagdollRotation - Vector3 - true - true - false - Missing Documentation - - - StartRagdoll - nil - - force - Vector3 - true - - - false - false - false - Missing Documentation - - - StopRagdoll - nil - false - false - false - Missing Documentation - - - GetAttachment - Dynamic - - attachmentEnum - CharacterAttachmentEnum - false - - - false - false - false - Missing Documentation - - - LoadAppearance - nil - - userID - number - false - - - false - false - false - Missing Documentation - - - ClearAppearance - nil - false - false - false - Missing Documentation - - - SetAttachmentTransformOverride - nil - - attachment - CharacterAttachmentEnum - false - - - - overrideThis - boolean - false - - - false - false - false - Missing Documentation - - - SetAttachmentPositionOverride - nil - - attachment - CharacterAttachmentEnum - false - - - - pos - Vector3 - false - - - false - false - false - Missing Documentation - - - SetAttachmentRotationOverride - nil - - attachment - CharacterAttachmentEnum - false - - - - rot - Vector3 - false - - - false - false - false - Missing Documentation - - - RagdollStarted - - Fires when ragdoll has been started - - - RagdollStopped - - Fires when ragdoll has been stopped - - false - false - true - Missing Documentation - diff --git a/xml/types/PreferencesService.xml b/xml/types/PreferencesService.xml deleted file mode 100644 index e87123d..0000000 --- a/xml/types/PreferencesService.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - PreferencesService - Instance - - UsePhotoMode - boolean - true - true - false - Determines whether the player has photo mode enabled. - - - UsePostProcessing - boolean - true - true - false - Determines whether the player has post-processing effects enabled. - - - SettingChanged - - settingName - string - - - setTo - any - - Fired when a user preference setting is changed. - - true - false - false - PreferencesService is a service that allows scripts to access some of the user preferences - diff --git a/xml/types/PresenceService.xml b/xml/types/PresenceService.xml deleted file mode 100644 index 84bdfac..0000000 --- a/xml/types/PresenceService.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - PresenceService - Instance - - State - string - true - false - false - Missing Documentation - - - CoverImage - PTImageAsset - true - false - false - Missing Documentation - - - ResetTimer - nil - false - false - false - Missing Documentation - - true - false - false - PresenceService is a service that allows scripts to set the active status of the player. Which will be used to display in supported integrations. - diff --git a/xml/types/ProceduralSky.xml b/xml/types/ProceduralSky.xml deleted file mode 100644 index 0e73ce6..0000000 --- a/xml/types/ProceduralSky.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - ProceduralSky - Sky - - SunSize - number - true - false - false - The size of the sun in the sky. - - - SkyTint - Color - true - false - false - The tint color of the sky. - - - HorizonColor - Color - true - false - false - The color of the horizon in the sky. - - - GroundColor - Color - true - false - false - The color of the ground in the sky. - - - Exposure - number - true - false - false - The exposure level of the sky. - - false - false - true - ProceduralSky is a type of sky that generates its appearance procedurally based on the position of the sun and its properties. - diff --git a/xml/types/PurchasesService.xml b/xml/types/PurchasesService.xml deleted file mode 100644 index 5ded059..0000000 --- a/xml/types/PurchasesService.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - PurchasesService - Instance - - Prompt - nil - - player - Player - false - - - - assetID - number - false - - - false - false - false - Prompts the specified player to purchase the asset with the given asset ID. - - - OwnsItemAsync - boolean - - player - Player - false - - - - assetID - number - false - - - true - false - false - Checks asynchronously if the specified player owns the asset with the given asset ID. - - true - false - false - Service responsible for handling in-game purchases and ownership verification. - diff --git a/xml/types/Quaternion.xml b/xml/types/Quaternion.xml deleted file mode 100644 index ea83c3b..0000000 --- a/xml/types/Quaternion.xml +++ /dev/null @@ -1,415 +0,0 @@ - - - Quaternion - - - X - number - true - false - false - The X component of the quaternion. - - - Y - number - true - false - false - The Y component of the quaternion. - - - Z - number - true - false - false - The Z component of the quaternion. - - - W - number - true - false - false - The W component of the quaternion. - - - Identity - Quaternion - true - true - false - The identity rotation. - - - New - Quaternion - false - false - true - Creates a new Quaternion object. - - - New - Quaternion - - x - number - false - - - - y - number - false - - - - z - number - false - - - - w - number - false - - - false - false - true - Creates a new Quaternion object with the specified components. - - - Angle - Quaternion - - a - Quaternion - false - - - - b - Quaternion - false - - - false - false - true - Calculates the angle between two quaternions. - - - AngleAxis - Quaternion - - angle - number - false - - - - axis - Vector3 - false - - - false - false - true - Creates a rotation which rotates angle degrees around axis. - - - Dot - Quaternion - - a - Quaternion - false - - - - b - Quaternion - false - - - false - false - true - Calculates the dot product of two quaternions. - - - Euler - Quaternion - - x - number - false - - - - y - number - false - - - - z - number - false - - - false - false - true - Creates a quaternion from Euler angles specified by x, y, and z. - - - Euler - Quaternion - - euler - Vector3 - false - - - false - false - true - Creates a quaternion from Euler angles specified by a Vector3. - - - ToEuler - Vector3 - - euler - Quaternion - false - - - false - false - true - Converts a quaternion to Euler angles represented as a Vector3. - - - FromToRotation - Quaternion - - fromDirection - Vector3 - false - - - - toDirection - Vector3 - false - - - false - false - true - Creates a rotation which rotates angle degrees around axis. - - - Inverse - Quaternion - - rotation - Quaternion - false - - - false - false - true - Calculates the inverse of a quaternion. - - - Lerp - Quaternion - - a - Quaternion - false - - - - b - Quaternion - false - - - - t - number - false - - - false - false - true - Linearly interpolates between two quaternions. - - - LerpUnclamped - Quaternion - - a - Quaternion - false - - - - b - Quaternion - false - - - - t - number - false - - - false - false - true - Linearly interpolates between two quaternions without clamping the interpolant. - - - LookRotation - Quaternion - - forward - Vector3 - false - - - false - false - true - Creates a rotation with the specified forward direction. - - - LookRotation - Quaternion - - forward - Vector3 - false - - - - upwards - Vector3 - false - - - false - false - true - Creates a rotation with the specified forward and upwards directions. - - - Normalize - Quaternion - - quaternion - Quaternion - false - - - false - false - true - Normalizes the given quaternion. - - - RotateTowards - Quaternion - - from - Quaternion - false - - - - to - Quaternion - false - - - - maxDegreesDelta - number - false - - - false - false - true - Rotates a rotation from towards to by maxDegreesDelta. - - - Slerp - Quaternion - - a - Quaternion - false - - - - b - Quaternion - false - - - - t - number - false - - - false - false - true - Spherically interpolates between two quaternions. - - - SlerpUnclamped - Quaternion - - a - Quaternion - false - - - - b - Quaternion - false - - - - t - number - false - - - false - false - true - Spherically interpolates between two quaternions without clamping the interpolant. - - false - false - false - Represents a quaternion used for rotations. - diff --git a/xml/types/RayResult.xml b/xml/types/RayResult.xml deleted file mode 100644 index da516e1..0000000 --- a/xml/types/RayResult.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - RayResult - ValueType - - Origin - Vector3 - true - false - false - The origin point of the ray. - - - Direction - Vector3 - true - false - false - The direction vector of the ray. - - - Position - Vector3 - true - false - false - The position where the ray hit an object. - - - Normal - Vector3 - true - false - false - The surface normal at the point where the ray hit. - - - Distance - number - true - false - false - The distance from the ray's origin to the hit point. - - - Instance - Instance - true - false - false - The instance that was hit by the ray. - - false - false - false - RayResult is a data type that contains data about a raycast result. - diff --git a/xml/types/ResourceAsset.xml b/xml/types/ResourceAsset.xml deleted file mode 100644 index b62e702..0000000 --- a/xml/types/ResourceAsset.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - ResourceAsset - BaseAsset - false - true - false - Base class for resource based assets - diff --git a/xml/types/Script.xml b/xml/types/Script.xml deleted file mode 100644 index c3eb0b6..0000000 --- a/xml/types/Script.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - Script - Instance - - Source - string - false - false - false - The source code of the script as a string. - - - LinkedScript - FileLinkAsset - false - false - false - A linked script asset associated with this script. - - - Compatibility - boolean - false - false - false - Indicates whether the script is running in compatibility mode. - - - Call - nil - - funcName - string - false - - - - args - any - false - - - false - false - false - Calls a function in the script with the given arguments. - - - CallAsync - nil - - funcName - string - false - - - - args - any - false - - - false - false - false - Calls a function in the script asynchronously with the given arguments. - - false - true - false - Scripts are abstract base classes representing Lua code that can be executed in the game. - diff --git a/xml/types/ScriptService.xml b/xml/types/ScriptService.xml deleted file mode 100644 index 31b1b9d..0000000 --- a/xml/types/ScriptService.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - ScriptService - Instance - true - false - false - ScriptService is a service used for storing scripts and local scripts. It is also responsible for managing their execution within the game. - diff --git a/xml/types/ScriptSharedTable.xml b/xml/types/ScriptSharedTable.xml deleted file mode 100644 index ba19e0e..0000000 --- a/xml/types/ScriptSharedTable.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - ScriptSharedTable - - false - false - false - Shared table of object. This class provides a table which any scripts can modify. - diff --git a/xml/types/Seat.xml b/xml/types/Seat.xml deleted file mode 100644 index 729a0b0..0000000 --- a/xml/types/Seat.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - Seat - Part - - Occupant - NPC - true - false - false - Indicates who is currently occupying the seat. - - - CanNPCSit - boolean - true - false - false - Determines whether NPCs are allowed to sit on this seat or only players. - - - Sat - - occupant - NPC - - Fires when an occupant sits on the seat. - - - Vacated - - occupant - NPC - - Fires when an occupant leaves the seat. - - false - false - true - Seats are parts the player can sit on. - diff --git a/xml/types/ServerHidden.xml b/xml/types/ServerHidden.xml deleted file mode 100644 index 8df5046..0000000 --- a/xml/types/ServerHidden.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - ServerHidden - Hidden - true - false - false - ServerHidden, similar to Hidden, is a container for objects that are meant to be hidden. Unlike Hidden, ServerHidden won't replicate its contents to clients and can only be accessed by the server. - diff --git a/xml/types/ServerScript.xml b/xml/types/ServerScript.xml deleted file mode 100644 index 526e906..0000000 --- a/xml/types/ServerScript.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - ServerScript - Script - false - false - true - ServerScript is a script that runs on the server. - diff --git a/xml/types/Sky.xml b/xml/types/Sky.xml deleted file mode 100644 index 15d0387..0000000 --- a/xml/types/Sky.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - Sky - Instance - false - true - false - Sky is an abstract base class representing the sky in the game world. - diff --git a/xml/types/Sound.xml b/xml/types/Sound.xml deleted file mode 100644 index bc00234..0000000 --- a/xml/types/Sound.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - Sound - Dynamic - - Audio - AudioAsset - true - false - false - The audio asset to be played by the sound. - - - Volume - number - true - false - false - The volume level of the sound. - - - Pitch - number - true - false - false - The pitch level of the sound. - - - Autoplay - boolean - true - false - false - Determines whether the sound should start playing automatically when loaded. - - - Loop - boolean - true - false - false - Determines whether the sound should loop when it reaches the end. - - - PlayInWorld - boolean - true - false - false - Determines whether the sound should be played in the 3D world space. - - - MaxDistance - number - true - false - false - The maximum distance at which the sound can be heard. - - - Time - number - true - false - false - Indicates the current playback position of the sound in seconds. - - - Playing - boolean - true - true - false - Indicates whether the sound is currently playing. - - - Loading - boolean - true - true - false - Indicates whether the sound is currently loading. - - - Length - number - true - true - false - The total length of the sound in seconds. - - - Play - nil - false - false - false - Starts playing the sound. - - - PlayOneShot - nil - - volume - number - true - 1 - - false - false - false - Plays the sound once at the specified volume without affecting the current playback. - - - Stop - nil - false - false - false - Stops the sound if it is currently playing. - - - Loaded - - Fires when this sound has loaded - - false - false - true - Sounds are objects that can be placed in the world and play audio. - diff --git a/xml/types/SpotLight.xml b/xml/types/SpotLight.xml deleted file mode 100644 index de7764e..0000000 --- a/xml/types/SpotLight.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - SpotLight - Light - - Range - number - true - false - false - The maximum distance the light can reach. - - - Angle - number - true - false - false - The angle of the spotlight's cone. - - false - false - true - SpotLight is a source of light emitting in a specific direction and angle that can be placed in the world. - diff --git a/xml/types/StringValue.xml b/xml/types/StringValue.xml deleted file mode 100644 index 72d7181..0000000 --- a/xml/types/StringValue.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - StringValue - ValueBase - - Value - string - true - false - false - The value of this object. - - false - false - true - StringValue is an object that holds a string value. - diff --git a/xml/types/SunLight.xml b/xml/types/SunLight.xml deleted file mode 100644 index e80f6ba..0000000 --- a/xml/types/SunLight.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - SunLight - Light - true - false - false - SunLight is the main directional light source representing the sun in the game world. - diff --git a/xml/types/Temporary.xml b/xml/types/Temporary.xml deleted file mode 100644 index c480e04..0000000 --- a/xml/types/Temporary.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - Temporary - Hidden - true - false - false - A temporary container. All class that were instantiated from `Instance.New` will have this class as their first parent. - diff --git a/xml/types/Text3D.xml b/xml/types/Text3D.xml deleted file mode 100644 index c0eb982..0000000 --- a/xml/types/Text3D.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - Text3D - Dynamic - - Text - string - true - false - false - The text content displayed. - - - FontSize - number - true - false - false - The size of the font used for the text. - - - Color - Color - true - false - false - The color of the text. - - - OutlineWidth - number - true - false - false - The width of the text outline. - - - OutlineColor - Color - true - false - false - The color of the text outline. - - - FaceCamera - boolean - true - false - false - Determines whether the text should always be facing the camera. - - - HorizontalAlignment - TextHorizontalAlignmentEnum - true - false - false - Determines the horizontal alignment of the text. - - - VerticalAlignment - TextVerticalAlignmentEnum - true - false - false - Determines the vertical alignment of the text. - - - FontAsset - FontAsset - true - false - false - The font asset used for the text. - - - UseRichText - boolean - true - false - false - Determines whether the text should be parsed as rich text. - - false - false - true - Text3D is a class that represents 3D text in the game world. - diff --git a/xml/types/Tool.xml b/xml/types/Tool.xml deleted file mode 100644 index a1eab9b..0000000 --- a/xml/types/Tool.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - Tool - PhysicalModel - - Droppable - boolean - true - false - false - Determines whether the tool can be dropped by the player. - - - Holder - NPC - true - false - false - Determines who is currently holding this tool. - - - Activate - nil - false - false - false - Activates the tool, similarly to pressing the mouse button. - - - Deactivate - nil - false - false - false - Deactivates the tool, similarly to releasing the mouse button. - - - PlayAnimation - nil - - animationName - string - false - - - false - false - false - Plays the specified animation on the holder of the tool. - - - Equipped - - Fires when this tool has been equipped - - - Unequipped - - Fires when this tool has been unequipped - - - Activated - - Fires when this tool has been activated (via mouse press or `Tool:Activate`) - - - Deactivated - - Fires when this tool has been deactivated (via mouse release or `Tool:Deactivate`) - - false - false - true - Tools are objects that can be held by the player. - diff --git a/xml/types/Truss.xml b/xml/types/Truss.xml deleted file mode 100644 index c948719..0000000 --- a/xml/types/Truss.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - Truss - Part - - ClimbSpeed - number - true - false - false - The speed at which the player can climb the truss. - - false - false - true - Trusses are parts that can be climbed by the player. - diff --git a/xml/types/TweenObject.xml b/xml/types/TweenObject.xml deleted file mode 100644 index 024ad86..0000000 --- a/xml/types/TweenObject.xml +++ /dev/null @@ -1,353 +0,0 @@ - - - TweenObject - - - Looped - boolean - true - false - false - Determines if this tween is looped - - - Parallel - boolean - true - false - false - Determines if this tween will run all the tweens in parallel - - - SpeedScale - number - true - false - false - Determines the speed scale of this tween - - - IsRunning - boolean - true - true - false - Returns whether or not this tween is running - - - ElapsedTime - number - true - true - false - Returns the elapsed time of this tween - - - SetDirection - TweenObject - - dir - TweenDirectionEnum - false - - - false - false - false - Set the direction of this tween. This function returns a `TweenObject` which means you can stack it with other functions. - - - SetTrans - TweenObject - - trans - TweenTransitionEnum - false - - - false - false - false - Set the transition of this tween. This function returns a `TweenObject` which means you can stack it with other functions. - - - TweenPosition - nil - - target - Dynamic - false - - - - destination - Vector3 - false - - - - time - number - false - - - false - false - false - Tweens the position of a Dynamic. - - - TweenRotation - nil - - target - Dynamic - false - - - - destination - Vector3 - false - - - - time - number - false - - - false - false - false - Tweens the rotation of a Dynamic. - - - TweenSize - nil - - target - Dynamic - false - - - - destination - Vector3 - false - - - - time - number - false - - - false - false - false - Tweens the size of a Dynamic. - - - TweenColor - nil - - from - Color - false - - - - to - Color - false - - - - time - number - false - - - - callback - function - false - - - false - false - false - Tweens a color between two specified values. - - - TweenNumber - nil - - from - number - false - - - - to - number - false - - - - time - number - false - - - - callback - function - false - - - false - false - false - Tweens a number between two specified values. - - - TweenVector2 - nil - - from - Vector2 - false - - - - to - Vector2 - false - - - - time - number - false - - - - callback - function - false - - - false - false - false - Tweens a Vector2 between two specified values. - - - TweenVector3 - nil - - from - Vector3 - false - - - - to - Vector3 - false - - - - time - number - false - - - - callback - function - false - - - false - false - false - Tweens a Vector3 between two specified values. - - - Play - nil - false - false - false - Play this tween - - - Pause - nil - false - false - false - Pause this tween - - - Stop - nil - false - false - false - Stop this tween - - - Interval - nil - - sec - number - false - - - false - false - false - Creates a delay in the tween. - - - Chain - TweenObject - false - false - false - Chain a tween if parallel is set to true - - - Cancel - nil - - callFinsihed - boolean - true - False - - false - false - false - Cancel this tween - - - Finished - - Fires when this tween has finished - - - Canceled - - Fires when this tween has been canceled - - false - false - false - An object that represents tween - diff --git a/xml/types/TweenService.xml b/xml/types/TweenService.xml deleted file mode 100644 index dae79f9..0000000 --- a/xml/types/TweenService.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - TweenService - Instance - - NewTween - TweenObject - false - false - false - Creates a new tween object - - Note: Tween will run automatically after one frame, you must use it's function right after creating it. - - true - false - false - TweenService is a service for managing tweens - diff --git a/xml/types/UIButton.xml b/xml/types/UIButton.xml deleted file mode 100644 index f3e7f64..0000000 --- a/xml/types/UIButton.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - UIButton - UILabel - - Clicked - - Fires when user click on this button - - false - false - true - UIButton is a class that represents a clickable button UI element. - diff --git a/xml/types/UIField.xml b/xml/types/UIField.xml deleted file mode 100644 index da12b4b..0000000 --- a/xml/types/UIField.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - UIField - Instance - - PositionOffset - Vector2 - true - false - false - The offset of the UI element in pixels. - - - PositionRelative - Vector2 - true - false - false - The position of the UI element relative to its parent. - - - Rotation - number - true - false - false - The rotation of the UI element in degrees. - - - SizeOffset - Vector2 - true - false - false - The size offset of the UI element in pixels. - - - SizeRelative - Vector2 - true - false - false - The size of the UI element relative to its parent. - - - ClipDescendants - boolean - true - false - false - Determines whether the UI element clips its descendants. - - - PivotPoint - Vector2 - true - false - false - The pivot point of the UI element. - - - Scale - Vector2 - true - false - false - The scale of the UI element. - - - Visible - boolean - true - false - false - Determines whether the UI element is visible. - - - MaskMode - MaskModeEnum - true - false - false - Determines the mask mode of the UI element. - - - AbsoluteSize - Vector2 - true - true - false - The absolute size of the UI element in pixels. - - - IsVisibleInTree - boolean - true - true - false - Indicates whether the UI element is visible in the UI hierarchy. - - - MouseEnter - - Fires when user's cursor hovers on this UI - - - MouseExit - - Fires when user's cursor leaves this UI - - - MouseDown - - Fires when user hold down mouse on this UI - - - MouseUp - - Fires when user release mouse on this UI - - - TransformChanged - - Fires when this UI transform has been changed - - - VisibilityChanged - - Fires when this UI visibility has been changed - - false - false - true - UIField is the abstract base class of all UI classes. - diff --git a/xml/types/UIHVLayout.xml b/xml/types/UIHVLayout.xml deleted file mode 100644 index b6e85a7..0000000 --- a/xml/types/UIHVLayout.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - UIHVLayout - UIField - - Spacing - number - true - false - false - The spacing between child elements in the layout. - - - ChildAlignment - UILayoutAlignmentEnum - true - false - false - Determines the alignment of child elements within the layout. - - false - true - false - UIHVLayout is an abstract class that provides horizontal and vertical layout functionality for UI elements. - diff --git a/xml/types/UIHorizontalLayout.xml b/xml/types/UIHorizontalLayout.xml deleted file mode 100644 index 9101472..0000000 --- a/xml/types/UIHorizontalLayout.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - UIHorizontalLayout - UIHVLayout - false - false - true - UIHorizontalLayout is a class that aligns all of its children horizontally. - diff --git a/xml/types/UIImage.xml b/xml/types/UIImage.xml deleted file mode 100644 index 371bc21..0000000 --- a/xml/types/UIImage.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - UIImage - UIField - - Image - ImageAsset - true - false - false - The image asset used for the image. - - - Color - Color - true - false - false - The color applied to the image. - - - StretchMode - ImageStretchModeEnum - true - false - false - Determines how the image is stretched within the view. - - - Loading - boolean - true - true - false - Indicates whether the image is currently loading. - - false - false - true - UIImage is a class that can be used to display images. - diff --git a/xml/types/UILabel.xml b/xml/types/UILabel.xml deleted file mode 100644 index 040b675..0000000 --- a/xml/types/UILabel.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - UILabel - UIView - - Text - string - true - false - false - The text of the label. - - - TextColor - Color - true - false - false - The color of the text. - - - OutlineWidth - number - true - false - false - The width of the text outline. - - - OutlineColor - Color - true - false - false - The color of the text outline. - - - HorizontalAlignment - TextHorizontalAlignmentEnum - true - false - false - Determines the horizontal alignment of the text. - - - VerticalAlignment - TextVerticalAlignmentEnum - true - false - false - Determines the vertical alignment of the text. - - - FontSize - number - true - false - false - The font size of the text. - - - UseRichText - boolean - true - false - false - Determines whether the text uses rich text formatting. - - - FontAsset - FontAsset - true - false - false - The font asset used for the text. - - false - false - true - UILabel is a class that can be used to display text. - diff --git a/xml/types/UIScrollView.xml b/xml/types/UIScrollView.xml deleted file mode 100644 index 38ade13..0000000 --- a/xml/types/UIScrollView.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - UIScrollView - UIField - - HorizontalScrollMode - ScrollModeEnum - true - false - false - Determines the horizontal scroll mode of the scroll view. - - - VerticalScrollMode - ScrollModeEnum - true - false - false - Determines the vertical scroll mode of the scroll view. - - false - false - true - UIScrollView is a class that allows the user to scroll content within a view. - diff --git a/xml/types/UITextInput.xml b/xml/types/UITextInput.xml deleted file mode 100644 index 46ce3f4..0000000 --- a/xml/types/UITextInput.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - UITextInput - UIView - - Text - string - true - false - false - The text of the label. - - - TextColor - Color - true - false - false - The color of the text. - - - JustifyText - TextHorizontalAlignmentEnum - true - false - false - Determines how text is justified. - - - FontSize - number - true - false - false - The font size of the label. - - - IsMultiline - boolean - true - false - false - Determines whether the text input supports multiple lines. - - - Placeholder - string - true - false - false - The placeholder text displayed when the input is empty. - - - PlaceholderColor - Color - true - false - false - The color of the placeholder text. - - - ReadonlyColor - Color - true - false - false - The color of the text when the input is read-only. - - - IsReadOnly - boolean - true - false - false - Determines whether the text input is read-only. - - - FontAsset - FontAsset - true - false - false - The font asset used for the text. - - - Focus - nil - false - false - false - Forces the local player to focus on the text input. - - - Submitted - - text - string - - Fires when user submitted the text - - - Changed - - text - string - - Fires when user changed the text - - false - false - true - UITextInput is a class that allows the user to enter text. - diff --git a/xml/types/UIVerticalLayout.xml b/xml/types/UIVerticalLayout.xml deleted file mode 100644 index ffe33f0..0000000 --- a/xml/types/UIVerticalLayout.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - UIVerticalLayout - UIHVLayout - false - false - true - UIVerticalLayout is a class that aligns all of its children vertically. - diff --git a/xml/types/UIView.xml b/xml/types/UIView.xml deleted file mode 100644 index b1eaabc..0000000 --- a/xml/types/UIView.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - UIView - UIField - - BorderColor - Color - true - false - false - Determines the border color of the UI. - - - Color - Color - true - false - false - Determines the color of the UI. - - - BorderWidth - number - true - false - false - Determines the width of the border of the UI. - - - CornerRadius - number - true - false - false - Determines the corner radius of the UI. - - false - false - true - UIView is a class that displays a rectangle in your place's UI. - diff --git a/xml/types/UIViewport.xml b/xml/types/UIViewport.xml deleted file mode 100644 index 9f00aac..0000000 --- a/xml/types/UIViewport.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - UIViewport - UIField - false - false - true - Missing Documentation - diff --git a/xml/types/ValueBase.xml b/xml/types/ValueBase.xml deleted file mode 100644 index 75f7cce..0000000 --- a/xml/types/ValueBase.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - ValueBase - Instance - - Changed - - Fires when value has been changed - - false - true - false - ValueBase is an abstract base class for objects that hold a value. - diff --git a/xml/types/Vector2.xml b/xml/types/Vector2.xml deleted file mode 100644 index 4f11b43..0000000 --- a/xml/types/Vector2.xml +++ /dev/null @@ -1,391 +0,0 @@ - - - Vector2 - - - X - number - true - false - false - The X component of the vector. - - - Y - number - true - false - false - The Y component of the vector. - - - Down - Vector2 - true - true - false - Shorthand for Vector2.New(0, -1). - - - Left - Vector2 - true - true - false - Shorthand for Vector2.New(-1, 0). - - - One - Vector2 - true - true - false - Shorthand for Vector2.New(1, 1). - - - Zero - Vector2 - true - true - false - Shorthand for Vector2.New(0, 0). - - - Right - Vector2 - true - true - false - Shorthand for Vector2.New(1, 0). - - - Up - Vector2 - true - true - false - Shorthand for Vector2.New(0, 1). - - - Magnitude - number - true - true - false - The length of the vector. - - - Normalized - Vector2 - true - true - false - The normalized version of the vector. - - - SqrMagnitude - number - true - true - false - The squared length of the vector. - - - New - Vector2 - false - false - true - Returns a new Vector2. - - - New - Vector2 - - d - number - false - - - false - false - true - Returns a new Vector2 with all components set to the given number. - - - New - Vector2 - - x - number - false - - - - y - number - false - - - false - false - true - Returns a new Vector2 with the given x and y components. - - - Angle - number - - from - Vector2 - false - - - - to - Vector2 - false - - - false - false - true - Returns the angle in degrees between from and to. - - - Cross - Vector2 - - lhs - Vector2 - false - - - - rhs - Vector2 - false - - - false - false - true - Returns the cross product of lhs and rhs. - - - Distance - number - - a - Vector2 - false - - - - b - Vector2 - false - - - false - false - true - Returns the distance between a and b. - - - Dot - number - - lhs - Vector2 - false - - - - rhs - Vector2 - false - - - false - false - true - Returns the dot product of lhs and rhs. - - - Lerp - Vector2 - - a - Vector2 - false - - - - b - Vector2 - false - - - - t - number - false - - - false - false - true - Returns a new vector that is the linear interpolation between a and b by t. - - - Max - Vector2 - - lhs - Vector2 - false - - - - rhs - Vector2 - false - - - false - false - true - Returns a vector that is made from the largest components of two vectors. - - - Min - Vector2 - - lhs - Vector2 - false - - - - rhs - Vector2 - false - - - false - false - true - Returns a vector that is made from the smallest components of two vectors. - - - MoveTowards - Vector2 - - current - Vector2 - false - - - - target - Vector2 - false - - - - maxDistanceDelta - number - false - - - false - false - true - Calculate a position between the points specified by current and target, moving no farther than the distance specified by maxDistanceDelta. - - - Normalize - Vector2 - - value - Vector2 - false - - - false - false - true - Returns a new Vector2 that is the normalized version of the given vector. - - - Project - Vector2 - - vector - Vector2 - false - - - - onNormal - Vector2 - false - - - false - false - true - Returns the projection of a vector onto another vector. - - - Reflect - Vector2 - - inDirection - Vector2 - false - - - - inNormal - Vector2 - false - - - false - false - true - Returns the reflection of a vector off the plane defined by a normal. - - - Slerp - Vector2 - - a - Vector2 - false - - - - b - Vector2 - false - - - - t - number - false - - - false - false - true - Spherically interpolates between two vectors. - - false - false - false - Vector2 is a 2D vector with an x and y component. - diff --git a/xml/types/Vector2Value.xml b/xml/types/Vector2Value.xml deleted file mode 100644 index a117fb3..0000000 --- a/xml/types/Vector2Value.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - Vector2Value - ValueBase - - Value - Vector2 - true - false - false - The value of this object. - - false - false - true - Vector2Value is an object that holds a Vector2 value. - diff --git a/xml/types/Vector3.xml b/xml/types/Vector3.xml deleted file mode 100644 index 39405e3..0000000 --- a/xml/types/Vector3.xml +++ /dev/null @@ -1,481 +0,0 @@ - - - Vector3 - - - X - number - true - false - false - The X component of the vector. - - - Y - number - true - false - false - The Y component of the vector. - - - Z - number - true - false - false - The Z component of the vector. - - - Forward - Vector3 - true - true - false - Shorthand for Vector3.New(0, 0, -1). - - - Back - Vector3 - true - true - false - Shorthand for Vector3.New(0, 0, 1). - - - Down - Vector3 - true - true - false - Shorthand for Vector3.New(0, -1, 0). - - - Left - Vector3 - true - true - false - Shorthand for Vector3.New(-1, 0, 0). - - - One - Vector3 - true - true - false - Shorthand for Vector3.New(1, 1, 1). - - - Zero - Vector3 - true - true - false - Shorthand for Vector3.New(0, 0, 0). - - - Right - Vector3 - true - true - false - Shorthand for Vector3.New(1, 0, 0). - - - Up - Vector3 - true - true - false - Shorthand for Vector3.New(0, 1, 0). - - - Magnitude - number - true - true - false - The length of the vector. - - - Normalized - Vector3 - true - true - false - The normalized version of the vector. - - - SqrMagnitude - number - true - true - false - The squared length of the vector. - - - New - Vector3 - false - false - true - Returns a new Vector3. - - - New - Vector3 - - d - number - false - - - false - false - true - Returns a new Vector3 with all components set to the given number. - - - New - Vector3 - - x - number - false - - - - y - number - false - - - false - false - true - Returns a new Vector3 with the given x and y components and a z component of 0. - - - New - Vector3 - - x - number - false - - - - y - number - false - - - - z - number - false - - - false - false - true - Returns a new Vector3 with the given x, y, and z components. - - - New - Vector3 - - v - Vector2 - false - - - false - false - true - Returns a new Vector3 with the given Vector2 components and a z component of 0. - - - Angle - number - - from - Vector3 - false - - - - to - Vector3 - false - - - false - false - true - Returns the angle in degrees between from and to. - - - Cross - Vector3 - - lhs - Vector3 - false - - - - rhs - Vector3 - false - - - false - false - true - Returns the cross product of lhs and rhs. - - - Distance - number - - a - Vector3 - false - - - - b - Vector3 - false - - - false - false - true - Returns the distance between a and b. - - - Dot - number - - lhs - Vector3 - false - - - - rhs - Vector3 - false - - - false - false - true - Returns the dot product of lhs and rhs. - - - Lerp - Vector3 - - a - Vector3 - false - - - - b - Vector3 - false - - - - t - number - false - - - false - false - true - Returns a new Vector3 that is the linear interpolation between a and b by t. - - - Max - Vector3 - - lhs - Vector3 - false - - - - rhs - Vector3 - false - - - false - false - true - Returns a vector that is made from the largest components of two vectors. - - - Min - Vector3 - - lhs - Vector3 - false - - - - rhs - Vector3 - false - - - false - false - true - Returns a vector that is made from the smallest components of two vectors. - - - MoveTowards - Vector3 - - current - Vector3 - false - - - - target - Vector3 - false - - - - maxDistanceDelta - number - false - - - false - false - true - Calculate a position between the points specified by current and target, moving no farther than the distance specified by maxDistanceDelta. - - - Normalize - Vector3 - - value - Vector3 - false - - - false - false - true - Returns a new Vector3 that is the normalized version of the given vector. - - - Project - Vector3 - - vector - Vector3 - false - - - - onNormal - Vector3 - false - - - false - false - true - Returns the projection of a vector onto another vector. - - - Reflect - Vector3 - - inDirection - Vector3 - false - - - - inNormal - Vector3 - false - - - false - false - true - Returns the reflection of a vector off the plane defined by a normal. - - - SignedAngle - number - - from - Vector3 - false - - - - to - Vector3 - false - - - - axis - Vector3 - false - - - false - false - true - Returns the signed angle in degrees between from and to. - - - Slerp - Vector3 - - a - Vector3 - false - - - - b - Vector3 - false - - - - t - number - false - - - false - false - true - Spherically interpolates between two vectors. - - false - false - false - Vector3 is a 3D vector with an x, y and z component. - diff --git a/xml/types/Vector3Value.xml b/xml/types/Vector3Value.xml deleted file mode 100644 index da9c1d9..0000000 --- a/xml/types/Vector3Value.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - Vector3Value - ValueBase - - Value - Vector3 - true - false - false - The value of this object. - - false - false - true - Vector3Value is an object that holds a Vector3 value. - diff --git a/xml/types/Vehicle.xml b/xml/types/Vehicle.xml deleted file mode 100644 index 9f20a3b..0000000 --- a/xml/types/Vehicle.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - Vehicle - PhysicalModel - - MaxSpeed - number - true - false - false - Determines the forward force limit in kg/s. - - - SteerLimit - number - true - false - false - Determines the steering limit in degrees. - - - Force - number - true - false - false - Determines the forward force in kg/s. - - - Brake - number - true - false - false - Determines the break amount in kg/s. - - - Steering - number - true - false - false - Determines the steering angle in degrees - - - Driver - Player - true - false - false - Determines the current driver of this vehicle. - - false - false - true - Vehicle class represents a vehicle that can be driven by a player - diff --git a/xml/types/VehicleSeat.xml b/xml/types/VehicleSeat.xml deleted file mode 100644 index 8c66cbf..0000000 --- a/xml/types/VehicleSeat.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - VehicleSeat - Seat - false - false - true - A seat for Vehicle - diff --git a/xml/types/VehicleWheel.xml b/xml/types/VehicleWheel.xml deleted file mode 100644 index 40a631e..0000000 --- a/xml/types/VehicleWheel.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - VehicleWheel - Dynamic - - UseForTraction - boolean - true - false - false - Determines if this wheel should be used for traction. - - - UseForSteering - boolean - true - false - false - Determines if this wheel should be used for steering. - - - Radius - number - true - false - false - Determines the radius for this wheel. - - false - false - true - A wheel for the vehicle - diff --git a/yaml/enums/AmbientSource.yaml b/yaml/enums/AmbientSource.yaml new file mode 100644 index 0000000..ad63ed2 --- /dev/null +++ b/yaml/enums/AmbientSource.yaml @@ -0,0 +1,8 @@ +Name: AmbientSource +InternalName: AmbientSourceEnum +Options: + - Name: Skybox + Description: "" + - Name: Color + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/BuiltInAudioPreset.yaml b/yaml/enums/BuiltInAudioPreset.yaml new file mode 100644 index 0000000..dbb790d --- /dev/null +++ b/yaml/enums/BuiltInAudioPreset.yaml @@ -0,0 +1,8 @@ +Name: BuiltInAudioPreset +InternalName: BuiltInAudioPresetEnum +Options: + - Name: Jump + Description: "" + - Name: Explosion + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/CameraMode.yaml b/yaml/enums/CameraMode.yaml new file mode 100644 index 0000000..486c223 --- /dev/null +++ b/yaml/enums/CameraMode.yaml @@ -0,0 +1,10 @@ +Name: CameraMode +InternalName: CameraModeEnum +Options: + - Name: Follow + Description: "" + - Name: Free + Description: "" + - Name: Scripted + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/CharacterAttachment.yaml b/yaml/enums/CharacterAttachment.yaml new file mode 100644 index 0000000..96d18d3 --- /dev/null +++ b/yaml/enums/CharacterAttachment.yaml @@ -0,0 +1,26 @@ +Name: CharacterAttachment +InternalName: CharacterAttachmentEnum +Options: + - Name: Head + Description: "" + - Name: Torso + Description: "" + - Name: ShoulderRight + Description: "" + - Name: ShoulderLeft + Description: "" + - Name: Waist + Description: "" + - Name: LegLeft + Description: "" + - Name: LegRight + Description: "" + - Name: FootLeft + Description: "" + - Name: FootRight + Description: "" + - Name: HandLeft + Description: "" + - Name: HandRight + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/ClientPlatform.yaml b/yaml/enums/ClientPlatform.yaml new file mode 100644 index 0000000..e24367c --- /dev/null +++ b/yaml/enums/ClientPlatform.yaml @@ -0,0 +1,10 @@ +Name: ClientPlatform +InternalName: ClientPlatformEnum +Options: + - Name: Desktop + Description: "" + - Name: Mobile + Description: "" + - Name: VR + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/CreatorToolMode.yaml b/yaml/enums/CreatorToolMode.yaml new file mode 100644 index 0000000..fa2c96d --- /dev/null +++ b/yaml/enums/CreatorToolMode.yaml @@ -0,0 +1,16 @@ +Name: CreatorToolMode +InternalName: ToolModeEnum +Options: + - Name: Select + Description: "" + - Name: Move + Description: "" + - Name: Rotate + Description: "" + - Name: Scale + Description: "" + - Name: Paint + Description: "" + - Name: Brush + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/ForceMode.yaml b/yaml/enums/ForceMode.yaml new file mode 100644 index 0000000..d3d96ae --- /dev/null +++ b/yaml/enums/ForceMode.yaml @@ -0,0 +1,12 @@ +Name: ForceMode +InternalName: ForceModeEnum +Options: + - Name: Force + Description: "" + - Name: Acceleration + Description: "" + - Name: Impulse + Description: "" + - Name: VelocityChange + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/GrabbablePermissionMode.yaml b/yaml/enums/GrabbablePermissionMode.yaml new file mode 100644 index 0000000..03828cf --- /dev/null +++ b/yaml/enums/GrabbablePermissionMode.yaml @@ -0,0 +1,10 @@ +Name: GrabbablePermissionMode +InternalName: GrabbablePermissionModeEnum +Options: + - Name: None + Description: "" + - Name: Everyone + Description: "" + - Name: Scripted + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/HorizontalAlignment.yaml b/yaml/enums/HorizontalAlignment.yaml new file mode 100644 index 0000000..f696b36 --- /dev/null +++ b/yaml/enums/HorizontalAlignment.yaml @@ -0,0 +1,10 @@ +Name: HorizontalAlignment +InternalName: TextHorizontalAlignmentEnum +Options: + - Name: Left + Description: "" + - Name: Center + Description: "" + - Name: Right + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/HttpRequestMethod.yaml b/yaml/enums/HttpRequestMethod.yaml new file mode 100644 index 0000000..816f9e0 --- /dev/null +++ b/yaml/enums/HttpRequestMethod.yaml @@ -0,0 +1,14 @@ +Name: HttpRequestMethod +InternalName: HttpRequestMethodEnum +Options: + - Name: Get + Description: "" + - Name: Post + Description: "" + - Name: Put + Description: "" + - Name: Delete + Description: "" + - Name: Patch + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/ImageStretchMode.yaml b/yaml/enums/ImageStretchMode.yaml new file mode 100644 index 0000000..118647b --- /dev/null +++ b/yaml/enums/ImageStretchMode.yaml @@ -0,0 +1,10 @@ +Name: ImageStretchMode +InternalName: ImageStretchModeEnum +Options: + - Name: Stretch + Description: "" + - Name: Centered + Description: "" + - Name: Covered + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/ImageType.yaml b/yaml/enums/ImageType.yaml new file mode 100644 index 0000000..e87c1c9 --- /dev/null +++ b/yaml/enums/ImageType.yaml @@ -0,0 +1,20 @@ +Name: ImageType +InternalName: ImageTypeEnum +Options: + - Name: Asset + Description: "" + - Name: AssetThumbnail + Description: "" + - Name: PlaceThumbnail + Description: "" + - Name: UserAvatar + Description: "" + - Name: UserAvatarHeadshot + Description: "" + - Name: GuildIcon + Description: "" + - Name: GuildBanner + Description: "" + - Name: PlaceIcon + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/KeyCode.yaml b/yaml/enums/KeyCode.yaml new file mode 100644 index 0000000..5bccb09 --- /dev/null +++ b/yaml/enums/KeyCode.yaml @@ -0,0 +1,322 @@ +Name: KeyCode +InternalName: KeyCodeEnum +Options: + - Name: None + Description: "" + - Name: Space + Description: "" + - Name: Exclam + Description: "" + - Name: QuotedBl + Description: "" + - Name: Numbersign + Description: "" + - Name: Dollar + Description: "" + - Name: Percent + Description: "" + - Name: Ampersand + Description: "" + - Name: Apostrophe + Description: "" + - Name: ParenLeft + Description: "" + - Name: Parenright + Description: "" + - Name: Asterisk + Description: "" + - Name: Plus + Description: "" + - Name: Comma + Description: "" + - Name: Minus + Description: "" + - Name: Period + Description: "" + - Name: Slash + Description: "" + - Name: Key0 + Description: "" + - Name: Key1 + Description: "" + - Name: Key2 + Description: "" + - Name: Key3 + Description: "" + - Name: Key4 + Description: "" + - Name: Key5 + Description: "" + - Name: Key6 + Description: "" + - Name: Key7 + Description: "" + - Name: Key8 + Description: "" + - Name: Key9 + Description: "" + - Name: Colon + Description: "" + - Name: Semicolon + Description: "" + - Name: Less + Description: "" + - Name: Equal + Description: "" + - Name: Greater + Description: "" + - Name: Question + Description: "" + - Name: At + Description: "" + - Name: A + Description: "" + - Name: B + Description: "" + - Name: C + Description: "" + - Name: D + Description: "" + - Name: E + Description: "" + - Name: F + Description: "" + - Name: G + Description: "" + - Name: H + Description: "" + - Name: I + Description: "" + - Name: J + Description: "" + - Name: K + Description: "" + - Name: L + Description: "" + - Name: M + Description: "" + - Name: N + Description: "" + - Name: O + Description: "" + - Name: P + Description: "" + - Name: Q + Description: "" + - Name: R + Description: "" + - Name: S + Description: "" + - Name: T + Description: "" + - Name: U + Description: "" + - Name: V + Description: "" + - Name: W + Description: "" + - Name: X + Description: "" + - Name: Y + Description: "" + - Name: Z + Description: "" + - Name: BracketLeft + Description: "" + - Name: Backslash + Description: "" + - Name: BracketRight + Description: "" + - Name: Asciicircum + Description: "" + - Name: Underscore + Description: "" + - Name: QuoteLeft + Description: "" + - Name: BraceLeft + Description: "" + - Name: Bar + Description: "" + - Name: BraceRight + Description: "" + - Name: Asciitilde + Description: "" + - Name: Yen + Description: "" + - Name: Section + Description: "" + - Name: GamepadA + Description: "" + - Name: GamepadB + Description: "" + - Name: GamepadX + Description: "" + - Name: GamepadY + Description: "" + - Name: GamepadBack + Description: "" + - Name: GamepadGuide + Description: "" + - Name: GamepadStart + Description: "" + - Name: GamepadLeftStick + Description: "" + - Name: GamepadRightStick + Description: "" + - Name: GamepadLeftShoulder + Description: "" + - Name: GamepadRightShoulder + Description: "" + - Name: GamepadDpadUp + Description: "" + - Name: GamepadDpadDown + Description: "" + - Name: GamepadDpadLeft + Description: "" + - Name: GamepadDpadRight + Description: "" + - Name: GamepadPaddle1 + Description: "" + - Name: GamepadPaddle2 + Description: "" + - Name: GamepadPaddle3 + Description: "" + - Name: GamepadPaddle4 + Description: "" + - Name: GamepadTouchpad + Description: "" + - Name: MouseLeft + Description: "" + - Name: MouseRight + Description: "" + - Name: MouseMiddle + Description: "" + - Name: MouseWheelUp + Description: "" + - Name: MouseWheelDown + Description: "" + - Name: MouseWheelLeft + Description: "" + - Name: MouseWheelRight + Description: "" + - Name: MouseXbutton1 + Description: "" + - Name: MouseXbutton2 + Description: "" + - Name: GamepadAxisLeftX + Description: "" + - Name: GamepadAxisLeftY + Description: "" + - Name: GamepadAxisRightX + Description: "" + - Name: GamepadAxisRightY + Description: "" + - Name: GamepadAxisTriggerLeft + Description: "" + - Name: GamepadAxisTriggerRight + Description: "" + - Name: Special + Description: "" + - Name: Escape + Description: "" + - Name: Tab + Description: "" + - Name: Backtab + Description: "" + - Name: Backspace + Description: "" + - Name: Enter + Description: "" + - Name: KpEnter + Description: "" + - Name: Insert + Description: "" + - Name: Delete + Description: "" + - Name: Left + Description: "" + - Name: Up + Description: "" + - Name: Right + Description: "" + - Name: Down + Description: "" + - Name: PageUp + Description: "" + - Name: PageDown + Description: "" + - Name: Shift + Description: "" + - Name: Ctrl + Description: "" + - Name: Meta + Description: "" + - Name: Alt + Description: "" + - Name: CapsLock + Description: "" + - Name: NumLock + Description: "" + - Name: ScrollLock + Description: "" + - Name: F1 + Description: "" + - Name: F2 + Description: "" + - Name: F3 + Description: "" + - Name: F4 + Description: "" + - Name: F5 + Description: "" + - Name: F6 + Description: "" + - Name: F7 + Description: "" + - Name: F8 + Description: "" + - Name: F9 + Description: "" + - Name: F10 + Description: "" + - Name: F11 + Description: "" + - Name: F12 + Description: "" + - Name: Menu + Description: "" + - Name: Hyper + Description: "" + - Name: KpMultiply + Description: "" + - Name: KpDivide + Description: "" + - Name: KpSubtract + Description: "" + - Name: KpPeriod + Description: "" + - Name: KpAdd + Description: "" + - Name: Kp0 + Description: "" + - Name: Kp1 + Description: "" + - Name: Kp2 + Description: "" + - Name: Kp3 + Description: "" + - Name: Kp4 + Description: "" + - Name: Kp5 + Description: "" + - Name: Kp6 + Description: "" + - Name: Kp7 + Description: "" + - Name: Kp8 + Description: "" + - Name: Kp9 + Description: "" + - Name: Unknown + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/MeshCollisionType.yaml b/yaml/enums/MeshCollisionType.yaml new file mode 100644 index 0000000..7698169 --- /dev/null +++ b/yaml/enums/MeshCollisionType.yaml @@ -0,0 +1,10 @@ +Name: MeshCollisionType +InternalName: CollisionTypeEnum +Options: + - Name: Bounds + Description: "" + - Name: Convex + Description: "" + - Name: Exact + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/PartMaterial.yaml b/yaml/enums/PartMaterial.yaml new file mode 100644 index 0000000..33a39a3 --- /dev/null +++ b/yaml/enums/PartMaterial.yaml @@ -0,0 +1,46 @@ +Name: PartMaterial +InternalName: PartMaterialEnum +Options: + - Name: SmoothPlastic + Description: "" + - Name: Brick + Description: "" + - Name: Concrete + Description: "" + - Name: Dirt + Description: "" + - Name: Fabric + Description: "" + - Name: Grass + Description: "" + - Name: Ice + Description: "" + - Name: Marble + Description: "" + - Name: Metal + Description: "" + - Name: MetalGrid + Description: "" + - Name: MetalPlate + Description: "" + - Name: Neon + Description: "" + - Name: Planks + Description: "" + - Name: Plastic + Description: "" + - Name: Plywood + Description: "" + - Name: RustyIron + Description: "" + - Name: Sand + Description: "" + - Name: Sandstone + Description: "" + - Name: Snow + Description: "" + - Name: Stone + Description: "" + - Name: Wood + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/PartShape.yaml b/yaml/enums/PartShape.yaml new file mode 100644 index 0000000..6ccf8aa --- /dev/null +++ b/yaml/enums/PartShape.yaml @@ -0,0 +1,24 @@ +Name: PartShape +InternalName: ShapeEnum +Options: + - Name: Brick + Description: "" + - Name: Sphere + Description: "" + - Name: Cylinder + Description: "" + - Name: Cone + Description: "" + - Name: Wedge + Description: "" + - Name: Corner + Description: "" + - Name: Bevel + Description: "" + - Name: Concave + Description: "" + - Name: Truss + Description: "" + - Name: Frame + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/SkyboxPreset.yaml b/yaml/enums/SkyboxPreset.yaml new file mode 100644 index 0000000..28acff1 --- /dev/null +++ b/yaml/enums/SkyboxPreset.yaml @@ -0,0 +1,46 @@ +Name: SkyboxPreset +InternalName: SkyboxEnum +Options: + - Name: Day1 + Description: "" + - Name: Day2 + Description: "" + - Name: Day3 + Description: "" + - Name: Day4 + Description: "" + - Name: Day5 + Description: "" + - Name: Day6 + Description: "" + - Name: Day7 + Description: "" + - Name: Morning1 + Description: "" + - Name: Morning2 + Description: "" + - Name: Morning3 + Description: "" + - Name: Morning4 + Description: "" + - Name: Night1 + Description: "" + - Name: Night2 + Description: "" + - Name: Night3 + Description: "" + - Name: Night4 + Description: "" + - Name: Night5 + Description: "" + - Name: Sunset1 + Description: "" + - Name: Sunset2 + Description: "" + - Name: Sunset3 + Description: "" + - Name: Sunset4 + Description: "" + - Name: Sunset5 + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/TextFontPreset.yaml b/yaml/enums/TextFontPreset.yaml new file mode 100644 index 0000000..d0dcc97 --- /dev/null +++ b/yaml/enums/TextFontPreset.yaml @@ -0,0 +1,28 @@ +Name: TextFontPreset +InternalName: BuiltInTextFontPresetEnum +Options: + - Name: SourceSans + Description: "" + - Name: PressStart2P + Description: "" + - Name: Montserrat + Description: "" + - Name: RobotoMono + Description: "" + - Name: Rubik + Description: "" + - Name: Poppins + Description: "" + - Name: Domine + Description: "" + - Name: Fredoka + Description: "" + - Name: ComicNeue + Description: "" + - Name: Orbitron + Description: "" + - Name: Papyrus + Description: "" + - Name: ComicSansMS + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/TweenDirection.yaml b/yaml/enums/TweenDirection.yaml new file mode 100644 index 0000000..294afa1 --- /dev/null +++ b/yaml/enums/TweenDirection.yaml @@ -0,0 +1,12 @@ +Name: TweenDirection +InternalName: TweenDirectionEnum +Options: + - Name: In + Description: "" + - Name: Out + Description: "" + - Name: InOut + Description: "" + - Name: OutIn + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/TweenTransition.yaml b/yaml/enums/TweenTransition.yaml new file mode 100644 index 0000000..d80fac9 --- /dev/null +++ b/yaml/enums/TweenTransition.yaml @@ -0,0 +1,28 @@ +Name: TweenTransition +InternalName: TweenTransitionEnum +Options: + - Name: Linear + Description: "" + - Name: Sine + Description: "" + - Name: Quint + Description: "" + - Name: Quart + Description: "" + - Name: Quad + Description: "" + - Name: Expo + Description: "" + - Name: Elastic + Description: "" + - Name: Cubic + Description: "" + - Name: Circ + Description: "" + - Name: Bounce + Description: "" + - Name: Back + Description: "" + - Name: Spring + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/UILayoutAlignment.yaml b/yaml/enums/UILayoutAlignment.yaml new file mode 100644 index 0000000..4249fe8 --- /dev/null +++ b/yaml/enums/UILayoutAlignment.yaml @@ -0,0 +1,10 @@ +Name: UILayoutAlignment +InternalName: UILayoutAlignmentEnum +Options: + - Name: Left + Description: "" + - Name: Center + Description: "" + - Name: Right + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/UIMaskMode.yaml b/yaml/enums/UIMaskMode.yaml new file mode 100644 index 0000000..61dafc3 --- /dev/null +++ b/yaml/enums/UIMaskMode.yaml @@ -0,0 +1,10 @@ +Name: UIMaskMode +InternalName: MaskModeEnum +Options: + - Name: Disabled + Description: "" + - Name: ClipOnly + Description: "" + - Name: ClipAndDraw + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/UIScrollMode.yaml b/yaml/enums/UIScrollMode.yaml new file mode 100644 index 0000000..6b98299 --- /dev/null +++ b/yaml/enums/UIScrollMode.yaml @@ -0,0 +1,12 @@ +Name: UIScrollMode +InternalName: ScrollModeEnum +Options: + - Name: Disabled + Description: "" + - Name: Auto + Description: "" + - Name: AlwaysShow + Description: "" + - Name: NeverShow + Description: "" +Description: Missing Documentation diff --git a/yaml/enums/VerticalAlignment.yaml b/yaml/enums/VerticalAlignment.yaml new file mode 100644 index 0000000..4c1308a --- /dev/null +++ b/yaml/enums/VerticalAlignment.yaml @@ -0,0 +1,10 @@ +Name: VerticalAlignment +InternalName: TextVerticalAlignmentEnum +Options: + - Name: Top + Description: "" + - Name: Middle + Description: "" + - Name: Bottom + Description: "" +Description: Missing Documentation diff --git a/yaml/types/Accessory.yaml b/yaml/types/Accessory.yaml new file mode 100644 index 0000000..1bcb1a2 --- /dev/null +++ b/yaml/types/Accessory.yaml @@ -0,0 +1,16 @@ +Name: Accessory +BaseType: Dynamic +Properties: + - Name: TargetAttachment + Type: CharacterAttachmentEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Specifies the character attachment point +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Accessory represents a attachable object that can be equipped by a + CharacterModel. diff --git a/yaml/types/AchievementsService.yaml b/yaml/types/AchievementsService.yaml new file mode 100644 index 0000000..3f16077 --- /dev/null +++ b/yaml/types/AchievementsService.yaml @@ -0,0 +1,96 @@ +Name: AchievementsService +BaseType: Instance +Properties: + - Name: UseAchievementSound + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determine if achievement sound effect should play when user + receives an achievement + - Name: NotifyAchievements + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: 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: + - Name: userID + Type: number + IsOptional: false + DefaultValue: "" + - Name: achievementID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: true + 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: + - Name: userID + Type: number + IsOptional: false + DefaultValue: "" + - Name: achievementID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Check if player of ID has the achievement, asynchronously. +Events: + - Name: GotAchievement + Arguments: + Name: achievementID + Type: number + Description: Fires when the local player got an achievement +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Service for managing achievements diff --git a/yaml/types/Animation.yaml b/yaml/types/Animation.yaml new file mode 100644 index 0000000..eb95d12 --- /dev/null +++ b/yaml/types/Animation.yaml @@ -0,0 +1,9 @@ +Name: Animation +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Missing Documentation diff --git a/yaml/types/Animator.yaml b/yaml/types/Animator.yaml new file mode 100644 index 0000000..951a3b7 --- /dev/null +++ b/yaml/types/Animator.yaml @@ -0,0 +1,45 @@ +Name: Animator +BaseType: Instance +Properties: [] +Methods: + - Name: PlayAnimation + ReturnType: nil + Parameters: + - Name: animationKey + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: PlayOneshotAnimation + ReturnType: nil + Parameters: + - Name: animationKey + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: StopAnimation + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: StopOneshotAnimation + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Missing Documentation diff --git a/yaml/types/AssetService.yaml b/yaml/types/AssetService.yaml new file mode 100644 index 0000000..69b3ebd --- /dev/null +++ b/yaml/types/AssetService.yaml @@ -0,0 +1,53 @@ +Name: AssetService +BaseType: Instance +Properties: [] +Methods: + - Name: NewAsset + ReturnType: BaseAsset + Parameters: + - Name: assetClassName + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Create new asset with the class name + - Name: NewPTImage + ReturnType: PTImageAsset + Parameters: + - Name: imgID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Create new image from Polytoria with the target ID + - Name: NewPTAudio + ReturnType: PTAudioAsset + Parameters: + - Name: audioID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Create new audio from Polytoria with the target ID + - Name: NewPTMesh + ReturnType: PTMeshAsset + Parameters: + - Name: assetID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Create new mesh from Polytoria with the target ID +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Service for managing assets diff --git a/yaml/types/AudioAsset.yaml b/yaml/types/AudioAsset.yaml new file mode 100644 index 0000000..411a1e2 --- /dev/null +++ b/yaml/types/AudioAsset.yaml @@ -0,0 +1,9 @@ +Name: AudioAsset +BaseType: ResourceAsset +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Abstract class for audio diff --git a/yaml/types/BaseAsset.yaml b/yaml/types/BaseAsset.yaml new file mode 100644 index 0000000..f8475e9 --- /dev/null +++ b/yaml/types/BaseAsset.yaml @@ -0,0 +1,9 @@ +Name: BaseAsset +BaseType: NetworkedObject +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Base class for all assets diff --git a/yaml/types/BindableEvent.yaml b/yaml/types/BindableEvent.yaml new file mode 100644 index 0000000..8ab5cfb --- /dev/null +++ b/yaml/types/BindableEvent.yaml @@ -0,0 +1,26 @@ +Name: BindableEvent +BaseType: Instance +Properties: [] +Methods: + - Name: Invoke + ReturnType: nil + Parameters: + - Name: par + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Invoke this event with parameters +Events: + - Name: Invoked + Arguments: + Name: ... + Type: any + Description: Fires when this event has been invoked +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: BindableEvent are events that can be called to communicate between + scripts in the same boundary. diff --git a/yaml/types/BodyPosition.yaml b/yaml/types/BodyPosition.yaml new file mode 100644 index 0000000..c57fe8d --- /dev/null +++ b/yaml/types/BodyPosition.yaml @@ -0,0 +1,29 @@ +Name: BodyPosition +BaseType: Instance +Properties: + - Name: TargetPosition + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the target position that the body applies forces to get to. + - Name: Force + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines how much force the body applies. + - Name: AcceptanceDistance + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines how close the body has to be to the target position to + stop applying forces to it. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: BodyPosition are objects that apply a force to their parent until + it moves toward the target position. diff --git a/yaml/types/BoolValue.yaml b/yaml/types/BoolValue.yaml new file mode 100644 index 0000000..b56c38d --- /dev/null +++ b/yaml/types/BoolValue.yaml @@ -0,0 +1,15 @@ +Name: BoolValue +BaseType: ValueBase +Properties: + - Name: Value + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The value of this object. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: BoolValue is a ValueBase that stores a boolean. diff --git a/yaml/types/Bounds.yaml b/yaml/types/Bounds.yaml new file mode 100644 index 0000000..e2559b6 --- /dev/null +++ b/yaml/types/Bounds.yaml @@ -0,0 +1,191 @@ +Name: Bounds +BaseType: null +Properties: + - Name: Center + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the center point of the bounds. + - Name: Size + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the size of the bounds. + - Name: Extents + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the extents of the bounds. + - Name: Start + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: End + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Volume + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the volume of the bounds. +Methods: + - Name: New + ReturnType: Bounds + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Bounds object with the specified position and size. + - Name: New + ReturnType: Bounds + Parameters: + - Name: position + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: size + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Bounds object with the specified position and size. + - Name: ClosestPoint + ReturnType: Vector3 + Parameters: + - Name: bounds + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: point + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Calculates the closest point on the bounds to the specified point. + - Name: Contains + ReturnType: boolean + Parameters: + - Name: bounds + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: point + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns whether the bounds contain the specified point. + - Name: Encapsulate + ReturnType: Bounds + Parameters: + - Name: bounds + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: point + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Expands the bounds by the specified amount. + - Name: Expand + ReturnType: Bounds + Parameters: + - Name: bounds + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: amount + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Expands the bounds by the specified amount. + - Name: Intersects + ReturnType: boolean + Parameters: + - Name: bounds + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: other + Type: Bounds + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Determines whether the bounds intersect with another bounds. + - Name: SetMinMax + ReturnType: Bounds + Parameters: + - Name: bounds + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: min + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: max + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Sets the minimum and maximum points of the bounds. + - Name: Distance + ReturnType: number + Parameters: + - Name: bounds + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: point + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Calculates the distance from the bounds to the specified point. + - Name: SqrDistance + ReturnType: number + Parameters: + - Name: bounds + Type: Bounds + IsOptional: false + DefaultValue: "" + - Name: point + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Calculates the squared distance from the bounds to the specified point. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Represents a bounding box in 3D space. diff --git a/yaml/types/BuiltInAudioAsset.yaml b/yaml/types/BuiltInAudioAsset.yaml new file mode 100644 index 0000000..89e9da1 --- /dev/null +++ b/yaml/types/BuiltInAudioAsset.yaml @@ -0,0 +1,15 @@ +Name: BuiltInAudioAsset +BaseType: AudioAsset +Properties: + - Name: AudioPreset + Type: BuiltInAudioPresetEnum + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: The target audio to use +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Audio asset that's built-in with the client diff --git a/yaml/types/BuiltInFontAsset.yaml b/yaml/types/BuiltInFontAsset.yaml new file mode 100644 index 0000000..c0f768b --- /dev/null +++ b/yaml/types/BuiltInFontAsset.yaml @@ -0,0 +1,15 @@ +Name: BuiltInFontAsset +BaseType: FontAsset +Properties: + - Name: FontPreset + Type: BuiltInTextFontPresetEnum + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: Target font to use +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Font asset that's built-in with the client diff --git a/yaml/types/Camera.yaml b/yaml/types/Camera.yaml new file mode 100644 index 0000000..e971e11 --- /dev/null +++ b/yaml/types/Camera.yaml @@ -0,0 +1,261 @@ +Name: Camera +BaseType: Dynamic +Properties: + - Name: Mode + Type: CameraModeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines or returns the camera's current mode. + - Name: FOV + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines or returns the camera's field of view. + - Name: ClipThroughWalls + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the camera should clip through walls. + - Name: MinDistance + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The camera's minimum distance from the player in Follow mode. + - Name: MaxDistance + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines camera's maximum distance from the player in Follow mode. + - Name: Distance + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the distance between the camera and the player when the + camera is in Follow mode. + - Name: ScrollSensitivity + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the scroll move speed of the camera. + - Name: Orthographic + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the camera should render in orthographic + (2D) mode or not (3D). + - Name: FollowLerp + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not to use lerping in Follow mode. + - Name: LerpSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the lerp speed of the camera when lerping is enabled. + - Name: OrthographicSize + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the half-size of the camera when in orthographic mode. + - Name: PositionOffset + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the camera's offset from its position. + - Name: RotationOffset + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the camera's offset from its rotation. + - Name: IsFirstPerson + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Returns whether or not the camera is in first person. + - Name: CanLock + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determine if camera can be ctrl locked. + - Name: SensitivityMultiplier + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Multipler for camera sensitivity + - Name: Sensitivity + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Current sensitivity of the camera + - Name: HorizontalSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the horizontal movement speed of the camera in Follow mode. + - Name: VerticalSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the vertical move speed of the camera. + - Name: ScrollLerpSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the lerp amount when scrolling + - Name: CtrlLocked + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determine if camera is in Ctrl lock mode + - Name: AlwaysLocked + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determine if camera should always be in locked mode + - Name: Target + Type: Dynamic + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The target of Follow mode +Methods: + - Name: ViewportPointToRay + ReturnType: RayResult + Parameters: + - Name: pos + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: ignoreList + Type: table + IsOptional: true + DefaultValue: null + - Name: maxDistance + Type: number + IsOptional: true + DefaultValue: "10000" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Cast a ray from the camera at the specified ViewportPoint (Vector3 + with components with values in range of 0 - 1 describing how far a point + is to to right and to the top of the screen) into the game world + - Name: ScreenPointToRay + ReturnType: RayResult + Parameters: + - Name: pos + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: ignoreList + Type: table + IsOptional: true + DefaultValue: null + - Name: maxDistance + Type: number + IsOptional: true + DefaultValue: "10000" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Cast a ray from the camera at screen point into the game world + - Name: ViewportToScreenPoint + ReturnType: Vector2 + Parameters: + - Name: pos + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Transforms `pos` from viewport space into screen space. + - Name: ViewportToWorldPoint + ReturnType: Vector3 + Parameters: + - Name: pos + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Transforms `pos` from viewport space into world space. + - Name: WorldToViewportPoint + ReturnType: Vector2 + Parameters: + - Name: pos + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Transforms `pos` from world space into viewport space. + - Name: WorldToScreenPoint + ReturnType: Vector2 + Parameters: + - Name: pos + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Transforms `pos` from world space into screen space. + - Name: ScreenToViewportPoint + ReturnType: Vector2 + Parameters: + - Name: pos + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Transforms `pos` from screen space into viewport space. + - Name: ScreenToWorldPoint + ReturnType: Vector3 + Parameters: + - Name: pos + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Transforms `pos` from screen space into world space. +Events: + - Name: FirstPersonEntered + Arguments: "" + Description: Fires when camera has entered first person + - Name: FirstPersonExited + Arguments: "" + Description: Fires when camera has exited first person +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Camera is a class that represents the local player's camera. diff --git a/yaml/types/CaptureService.yaml b/yaml/types/CaptureService.yaml new file mode 100644 index 0000000..c96db2e --- /dev/null +++ b/yaml/types/CaptureService.yaml @@ -0,0 +1,77 @@ +Name: CaptureService +BaseType: Instance +Properties: + - Name: OnCooldown + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Returns whenever the capture is on cooldown. + - Name: CanCapture + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if user/scripts can take a picture. + - Name: DefaultCaptureOverlay + Type: UIField + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Default capture overlay for all captures + - Name: SpectatorAttach + Type: Dynamic + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Attaches a spectator camera at dynamic for use with spectator mode. +Methods: + - Name: TakePhotoAtDynamic + ReturnType: nil + Parameters: + - Name: dyn + Type: Dynamic + IsOptional: false + DefaultValue: "" + - Name: photoSize + Type: Vector2 + IsOptional: true + DefaultValue: null + - Name: overlay + Type: UIField + IsOptional: true + DefaultValue: null + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Take a photo at dynamic + - Name: TakePhotoAt + ReturnType: nil + Parameters: + - Name: pos + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: rot + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: photoSize + Type: Vector2 + IsOptional: true + DefaultValue: null + - Name: overlay + Type: UIField + IsOptional: true + DefaultValue: null + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Take photo at `pos` for position and `rot` for rotation, optional + `photoSize` defines the size, and optional UI `overlay` can be passed to + include it in the result photo. +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Service for capturing photos diff --git a/yaml/types/CharacterModel.yaml b/yaml/types/CharacterModel.yaml new file mode 100644 index 0000000..9813a84 --- /dev/null +++ b/yaml/types/CharacterModel.yaml @@ -0,0 +1,26 @@ +Name: CharacterModel +BaseType: Dynamic +Properties: + - Name: Animator + Type: Animator + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The animator for this character +Methods: + - Name: GetAttachment + ReturnType: Dynamic + Parameters: + - Name: attachmentEnum + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Get attachment dynamic from this character +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Base class for Character Models diff --git a/yaml/types/ChatService.yaml b/yaml/types/ChatService.yaml new file mode 100644 index 0000000..b590bf7 --- /dev/null +++ b/yaml/types/ChatService.yaml @@ -0,0 +1,48 @@ +Name: ChatService +BaseType: Instance +Properties: [] +Methods: + - Name: BroadcastMessage + ReturnType: nil + Parameters: + - Name: msg + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sends a chat message to all players. + - Name: UnicastMessage + ReturnType: nil + Parameters: + - Name: msg + Type: string + IsOptional: false + DefaultValue: "" + - Name: plr + Type: Player + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sends a chat message to a specific player. +Events: + - Name: NewChatMessage + Arguments: + - Name: sender + Type: Player + - Name: message + Type: string + Description: Fires when new chat message has been received from player + - Name: MessageReceived + Arguments: + Name: message + Type: string + Description: Fires when new message has been received from either + `BroadcastMessage` or `UnicastMessage` +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Chat is a static class used for various actions regarding the chat. diff --git a/yaml/types/ClientScript.yaml b/yaml/types/ClientScript.yaml new file mode 100644 index 0000000..a0af770 --- /dev/null +++ b/yaml/types/ClientScript.yaml @@ -0,0 +1,10 @@ +Name: ClientScript +BaseType: Script +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: ClientScript is a script that runs locally for each player. It can + only see what the player can see. diff --git a/yaml/types/Color.yaml b/yaml/types/Color.yaml new file mode 100644 index 0000000..4698118 --- /dev/null +++ b/yaml/types/Color.yaml @@ -0,0 +1,133 @@ +Name: Color +BaseType: null +Properties: + - Name: R + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Red color component + - Name: G + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Green color component + - Name: B + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Blue color component + - Name: A + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Alpha (opacity) color component +Methods: + - Name: New + ReturnType: Color + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Color with the set R, G, B and A values + - Name: New + ReturnType: Color + Parameters: + - Name: d + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Color with the set R, G, B and A values + - Name: New + ReturnType: Color + Parameters: + - Name: r + Type: number + IsOptional: false + DefaultValue: "" + - Name: g + Type: number + IsOptional: false + DefaultValue: "" + - Name: b + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Color with the set R, G, B and A values + - Name: New + ReturnType: Color + Parameters: + - Name: r + Type: number + IsOptional: false + DefaultValue: "" + - Name: g + Type: number + IsOptional: false + DefaultValue: "" + - Name: b + Type: number + IsOptional: false + DefaultValue: "" + - Name: a + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Color with the set R, G, B and A values + - Name: Random + ReturnType: Color + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a random color with an alpha value of 1. + - Name: FromHex + ReturnType: Color + Parameters: + - Name: hex + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Color from the specified hex value. + - Name: Lerp + ReturnType: Color + Parameters: + - Name: a + Type: Color + IsOptional: false + DefaultValue: "" + - Name: b + Type: Color + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Linearly interpolates colors a and b by t. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: >- + Color is a data type that represents a color. + + The alpha property is between 0 and 1. 0 is fully transparent and 1 is fully visible. diff --git a/yaml/types/ColorAdjustModifier.yaml b/yaml/types/ColorAdjustModifier.yaml new file mode 100644 index 0000000..111e4b8 --- /dev/null +++ b/yaml/types/ColorAdjustModifier.yaml @@ -0,0 +1,34 @@ +Name: ColorAdjustModifier +BaseType: LightingModifier +Properties: + - Name: Brightness + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determine the brightness adjustment + - Name: Contrast + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determine the contrast adjustment + - Name: Saturation + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determine the saturation adjustment + - Name: TintColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determine the tint color +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: ColorAdjustModifier is a LightingModifier that allows the + adjustment of lighting diff --git a/yaml/types/ColorSeries.yaml b/yaml/types/ColorSeries.yaml new file mode 100644 index 0000000..fa6ab64 --- /dev/null +++ b/yaml/types/ColorSeries.yaml @@ -0,0 +1,112 @@ +Name: ColorSeries +BaseType: ValueType +Properties: + - Name: PointCount + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Returns the point count of this color series +Methods: + - Name: New + ReturnType: ColorSeries + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Create color series by this color range + - Name: New + ReturnType: ColorSeries + Parameters: + - Name: min + Type: Color + IsOptional: false + DefaultValue: "" + - Name: max + Type: Color + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Create color series by this color range + - Name: SetColor + ReturnType: nil + Parameters: + - Name: point + Type: number + IsOptional: false + DefaultValue: "" + - Name: color + Type: Color + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sets the color at the specified point in the color series. + - Name: RemovePoint + ReturnType: nil + Parameters: + - Name: point + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Removes the point at the specified index from the color series. + - Name: SetOffset + ReturnType: nil + Parameters: + - Name: point + Type: number + IsOptional: false + DefaultValue: "" + - Name: offset + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sets the offset at the specified point in the color series. + - Name: GetColor + ReturnType: Color + Parameters: + - Name: point + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets the color at the specified point in the color series. + - Name: GetOffset + ReturnType: number + Parameters: + - Name: point + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets the offset at the specified point in the color series. + - Name: Lerp + ReturnType: Color + Parameters: + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Interpolates between colors in the series based on the parameter t. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Color series is a data type that represents a collection of color + and points, also known as gradient. diff --git a/yaml/types/ColorValue.yaml b/yaml/types/ColorValue.yaml new file mode 100644 index 0000000..dab02e0 --- /dev/null +++ b/yaml/types/ColorValue.yaml @@ -0,0 +1,15 @@ +Name: ColorValue +BaseType: ValueBase +Properties: + - Name: Value + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The value of this object. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: ColorValue is an object that holds a Color value. diff --git a/yaml/types/CoreUIService.yaml b/yaml/types/CoreUIService.yaml new file mode 100644 index 0000000..9e982ad --- /dev/null +++ b/yaml/types/CoreUIService.yaml @@ -0,0 +1,58 @@ +Name: CoreUIService +BaseType: Instance +Properties: + - Name: UseUserCard + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the user card (in the upper right hand + corner above the leaderboard) is visible. + - Name: UseChat + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the chat box is visible. + - Name: UseHealthBar + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the player's health bar is visible. + - Name: UseLeaderboard + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the player list/leaderboard is visible. + - Name: UseHotbar + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the hot bar is visible. + - Name: UseMenuButton + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the menu button is visible. + - Name: UseEmoteWheel + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the emote wheel is visible. + - Name: CanRespawn + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the player can respawn. +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: CoreUI is a static class that allows for the toggling of certain core GUI. diff --git a/yaml/types/CreatorContextService.yaml b/yaml/types/CreatorContextService.yaml new file mode 100644 index 0000000..f558df0 --- /dev/null +++ b/yaml/types/CreatorContextService.yaml @@ -0,0 +1,11 @@ +Name: CreatorContextService +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: CreatorContextService is a service that manage per game specific + tools, such as Selections and History. This class is only available in the + creator. diff --git a/yaml/types/CreatorGUI.yaml b/yaml/types/CreatorGUI.yaml new file mode 100644 index 0000000..027f969 --- /dev/null +++ b/yaml/types/CreatorGUI.yaml @@ -0,0 +1,10 @@ +Name: CreatorGUI +BaseType: PlayerGUI +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +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. diff --git a/yaml/types/CreatorHistory.yaml b/yaml/types/CreatorHistory.yaml new file mode 100644 index 0000000..5f3c047 --- /dev/null +++ b/yaml/types/CreatorHistory.yaml @@ -0,0 +1,50 @@ +Name: CreatorHistory +BaseType: Instance +Properties: [] +Methods: + - Name: NewAction + ReturnType: nil + Parameters: + - Name: title + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: AddDoCallback + ReturnType: nil + Parameters: + - Name: callback + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: AddUndoCallback + ReturnType: nil + Parameters: + - Name: callback + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: CommitAction + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: CreatorHistory is a class that manages history (undo-redo) of this + game instance. This class is only available in the creator. diff --git a/yaml/types/CreatorInterface.yaml b/yaml/types/CreatorInterface.yaml new file mode 100644 index 0000000..44523bb --- /dev/null +++ b/yaml/types/CreatorInterface.yaml @@ -0,0 +1,64 @@ +Name: CreatorInterface +BaseType: null +Properties: + - Name: ToolMode + Type: ToolModeEnum + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: TargetPartColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: TargetPartMaterial + Type: PartMaterialEnum + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: MoveSnapEnabled + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: MoveSnapping + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: UserMoveSnapping + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: RotateSnapEnabled + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: RotateSnapping + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: UserRotateSnapping + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: CreatorInterface represent the user interface of the creator. This + class is only available in the creator. diff --git a/yaml/types/CreatorSelections.yaml b/yaml/types/CreatorSelections.yaml new file mode 100644 index 0000000..91dc7a9 --- /dev/null +++ b/yaml/types/CreatorSelections.yaml @@ -0,0 +1,152 @@ +Name: CreatorSelections +BaseType: Instance +Properties: [] +Methods: + - Name: Select + ReturnType: nil + Parameters: + - Name: instance + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: SelectChild + ReturnType: nil + Parameters: + - Name: instance + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Deselect + ReturnType: nil + Parameters: + - Name: instance + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: SelectOnly + ReturnType: nil + Parameters: + - Name: instance + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: DeselectAll + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: GroupInstances + ReturnType: Dynamic + Parameters: + - Name: instances + Type: table + IsOptional: false + DefaultValue: "" + - Name: asPhysical + Type: boolean + IsOptional: true + DefaultValue: "False" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: UngroupModel + ReturnType: table + Parameters: + - Name: model + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: UngroupModels + ReturnType: table + Parameters: + - Name: models + Type: table + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: DuplicateInstances + ReturnType: table + Parameters: + - Name: instances + Type: table + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: GroupSelected + ReturnType: nil + Parameters: + - Name: asPhysical + Type: boolean + IsOptional: true + DefaultValue: "False" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: UngroupSelected + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: DeleteSelected + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: DuplicateSelected + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: HasSelected + ReturnType: boolean + Parameters: + - Name: instance + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: CreatorSelections is an object that manages selections in the game + instance. This class is only available in the creator. diff --git a/yaml/types/CreatorService.yaml b/yaml/types/CreatorService.yaml new file mode 100644 index 0000000..ff7fccd --- /dev/null +++ b/yaml/types/CreatorService.yaml @@ -0,0 +1,40 @@ +Name: CreatorService +BaseType: null +Properties: + - Name: Interface + Type: CreatorInterface + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: Clipboard + Type: CreatorClipboard + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: CurrentGame + Type: Game + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: LocalTestActive + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation +Methods: [] +Events: + - Name: LocalTestStarted + Arguments: "" + Description: Fires when local testing starts + - Name: LocalTestStopped + Arguments: "" + Description: Fires when local testing ends +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: CreatorService is the class that manages the creator. This class is + only available in the creator. diff --git a/yaml/types/Datastore.yaml b/yaml/types/Datastore.yaml new file mode 100644 index 0000000..7e1e720 --- /dev/null +++ b/yaml/types/Datastore.yaml @@ -0,0 +1,56 @@ +Name: Datastore +BaseType: null +Properties: + - Name: Key + Type: string + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The key identifying this Datastore connection. +Methods: + - Name: GetAsync + ReturnType: any + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Retrieves a value from the datastore asynchronously using the + specified key. + - Name: SetAsync + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Stores a value in the datastore asynchronously using the specified key. + - Name: RemoveAsync + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + 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 +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Datastore is an object that represent datastore connection. diff --git a/yaml/types/DatastoreService.yaml b/yaml/types/DatastoreService.yaml new file mode 100644 index 0000000..c0b89b4 --- /dev/null +++ b/yaml/types/DatastoreService.yaml @@ -0,0 +1,21 @@ +Name: DatastoreService +BaseType: Instance +Properties: [] +Methods: + - Name: GetDatastore + ReturnType: Datastore + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Attempts to get a Datastore object from the Datastore service. +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Datastore (not to be confused with the Datastore data type) is a + service used for storing data between place sessions. diff --git a/yaml/types/Decal.yaml b/yaml/types/Decal.yaml new file mode 100644 index 0000000..c21c816 --- /dev/null +++ b/yaml/types/Decal.yaml @@ -0,0 +1,28 @@ +Name: Decal +BaseType: Dynamic +Properties: + - Name: Image + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The image texture applied to the decal. + - Name: Energy + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color tint applied to the decal. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Decals are objects that can have an image texture and are wrapped + around other objects. diff --git a/yaml/types/Dynamic.yaml b/yaml/types/Dynamic.yaml new file mode 100644 index 0000000..b57fc3c --- /dev/null +++ b/yaml/types/Dynamic.yaml @@ -0,0 +1,238 @@ +Name: Dynamic +BaseType: Instance +Properties: + - Name: Position + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The position of the object. + - Name: Rotation + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The rotation of the object. + - Name: Size + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The size of the object. + - Name: LocalPosition + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The position of the object relative to its parent. + - Name: LocalRotation + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The rotation of the object relative to its parent. + - Name: LocalSize + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The size of the object relative to its parent. + - Name: Quaternion + Type: Quaternion + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The rotation of the object represented as a quaternion. + - Name: Locked + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the object can be selected in the Creator. + - Name: Forward + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The forward direction vector of the object. + - Name: Right + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The right direction vector of the object. + - Name: Up + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The up direction vector of the object. +Methods: + - Name: LookAt + ReturnType: nil + Parameters: + - Name: target + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Orients the object to look at a target with a specified up vector. + - Name: LookAt + ReturnType: nil + Parameters: + - Name: target + Type: any + IsOptional: false + DefaultValue: "" + - Name: up + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Orients the object to look at a target with a specified up vector. + - Name: MovePosition + ReturnType: nil + Parameters: + - Name: position + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: MoveRotation + ReturnType: nil + Parameters: + - Name: rotation + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Translate + ReturnType: nil + Parameters: + - Name: translation + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Moves the transform in the direction and distance of translation. + - Name: RotateAround + ReturnType: nil + Parameters: + - Name: point + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: axis + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: angle + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Rotates the object around a point by the specified Euler angles. + - Name: Rotate + ReturnType: nil + Parameters: + - Name: eulerAngles + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + 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: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets the bounding box of the object. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Dynamic is the base class where all objects with a position, + rotation and scale derive from. diff --git a/yaml/types/Entity.yaml b/yaml/types/Entity.yaml new file mode 100644 index 0000000..f11c41c --- /dev/null +++ b/yaml/types/Entity.yaml @@ -0,0 +1,143 @@ +Name: Entity +BaseType: Physical +Properties: + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the entity. + - Name: CastShadows + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the entity casts shadows. + - Name: IsSpawn + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: 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 + Description: Determines whether the entity is affected by gravity. + - Name: Mass + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the mass of the entity. + - Name: Friction + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the friction of the entity. + - Name: Drag + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the drag (air resistance) of the entity. + - Name: AngularDrag + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the angular drag of the entity. + - Name: Bounciness + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the bounciness of the entity. +Methods: + - Name: AddForce + ReturnType: nil + Parameters: + - Name: force + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: mode + Type: ForceModeEnum + IsOptional: true + DefaultValue: Force + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Applies a force to the entity. + - Name: AddTorque + ReturnType: nil + Parameters: + - Name: force + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: mode + Type: ForceModeEnum + IsOptional: true + DefaultValue: Force + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Applies a rotational force to the entity. + - Name: AddForceAtPosition + ReturnType: nil + Parameters: + - Name: force + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: position + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: mode + Type: ForceModeEnum + IsOptional: true + DefaultValue: Force + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Applies a force to the entity from a specific position. + - Name: AddRelativeForce + ReturnType: nil + Parameters: + - Name: force + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: mode + Type: ForceModeEnum + IsOptional: true + DefaultValue: Force + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a force to the part relative to its own rotation. + - Name: AddRelativeTorque + ReturnType: nil + Parameters: + - Name: torque + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: mode + Type: ForceModeEnum + IsOptional: true + DefaultValue: Force + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a rotational force to the part relative to its own rotation. +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Entity represents a physics object that's related to building + blocks (inherited by Part and Mesh) diff --git a/yaml/types/Environment.yaml b/yaml/types/Environment.yaml new file mode 100644 index 0000000..e59bb8c --- /dev/null +++ b/yaml/types/Environment.yaml @@ -0,0 +1,147 @@ +Name: Environment +BaseType: Instance +Properties: + - Name: CurrentCamera + Type: Camera + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the current camera which player is using to view + - Name: Gravity + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The direction and strength of gravity in the world. + - Name: PartDestroyHeight + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: 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 + 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. +Methods: + - Name: Raycast + ReturnType: RayResult + Parameters: + - Name: origin + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: direction + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: maxDistance + Type: number + IsOptional: true + DefaultValue: "10000" + - Name: ignoreList + Type: table + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Casts a ray from origin with a specified direction and returns a + RayResult for the first hit object. + - Name: RaycastAll + ReturnType: table + Parameters: + - Name: origin + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: direction + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: maxDistance + Type: number + IsOptional: true + DefaultValue: "1000" + - Name: ignoreList + Type: table + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Casts a ray from origin with a specified direction and returns a + RayResult array for all hit objects. + - Name: OverlapSphere + ReturnType: table + Parameters: + - Name: origin + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: radius + Type: number + IsOptional: false + DefaultValue: "" + - Name: ignoreList + Type: table + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns a list of instances intersecting with the sphere in the + given position and radius. + - Name: OverlapBox + ReturnType: table + Parameters: + - Name: pos + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: size + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: rot + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: ignoreList + Type: table + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns a list of instances intersecting with the box in the given + position, size and rotation. + - Name: RebuildNavMesh + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Rebuilds the navigation mesh which determines the empty space where + NPCs can pathfind in. + - Name: GetPointOnNavMesh + ReturnType: Vector3 + Parameters: + - Name: toPoint + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns a point on the navigation mesh at the given position. +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Environment is the primary object intended for storing active + objects in the place. diff --git a/yaml/types/Explosion.yaml b/yaml/types/Explosion.yaml new file mode 100644 index 0000000..35a15c6 --- /dev/null +++ b/yaml/types/Explosion.yaml @@ -0,0 +1,55 @@ +Name: Explosion +BaseType: Dynamic +Properties: + - Name: Radius + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the radius of this explosion + - Name: Force + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the force of this explosion that will be applied to + affected hits + - Name: AffectAnchored + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if this explosion should affect anchored parts or not + - Name: Damage + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Damage that is affected to player + - Name: AffectPredicate + Type: function + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: |- + A predicate function deciding whenever this part should be accepted or not + + Example usage: + ```lua + explosion.AffectPredicate = function(hit) + -- always explode + return true + end + ``` +Methods: [] +Events: + - Name: Hitted + Arguments: + Name: hit + Type: Instance + Description: Fires when this explosion affects a hit +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Explosion is a deadly explosion killing players and applying force + to parts at the given position. diff --git a/yaml/types/FileLinkAsset.yaml b/yaml/types/FileLinkAsset.yaml new file mode 100644 index 0000000..ca7d2dd --- /dev/null +++ b/yaml/types/FileLinkAsset.yaml @@ -0,0 +1,15 @@ +Name: FileLinkAsset +BaseType: BaseAsset +Properties: + - Name: LinkedID + Type: string + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: The ID of the file +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Represents a link to a file path in the file system diff --git a/yaml/types/FilterService.yaml b/yaml/types/FilterService.yaml new file mode 100644 index 0000000..1402efa --- /dev/null +++ b/yaml/types/FilterService.yaml @@ -0,0 +1,20 @@ +Name: FilterService +BaseType: Instance +Properties: [] +Methods: + - Name: Filter + ReturnType: string + Parameters: + - Name: input + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Filter a string +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: FilterService is a service which processes and filter user inputs diff --git a/yaml/types/Folder.yaml b/yaml/types/Folder.yaml new file mode 100644 index 0000000..e361493 --- /dev/null +++ b/yaml/types/Folder.yaml @@ -0,0 +1,9 @@ +Name: Folder +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Folder is similar to a model, used for storing objects in the place. diff --git a/yaml/types/FontAsset.yaml b/yaml/types/FontAsset.yaml new file mode 100644 index 0000000..410fd48 --- /dev/null +++ b/yaml/types/FontAsset.yaml @@ -0,0 +1,9 @@ +Name: FontAsset +BaseType: ResourceAsset +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Base class for font assets diff --git a/yaml/types/GUI.yaml b/yaml/types/GUI.yaml new file mode 100644 index 0000000..918d736 --- /dev/null +++ b/yaml/types/GUI.yaml @@ -0,0 +1,9 @@ +Name: GUI +BaseType: UIField +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: GUI is a class that is used to create a GUI. diff --git a/yaml/types/GUI3D.yaml b/yaml/types/GUI3D.yaml new file mode 100644 index 0000000..33ddf38 --- /dev/null +++ b/yaml/types/GUI3D.yaml @@ -0,0 +1,34 @@ +Name: GUI3D +BaseType: Dynamic +Properties: + - Name: CanvasSize + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the canvas size for this GUI + - Name: Shaded + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if this GUI3D should be affected by lighting + - Name: FaceCamera + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if this GUI3D always face the camera? + - Name: Transparent + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if the background should be transparent. Recommended to + be set to false if transparent background is not needed. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: GUI3D is a class that allows GUI to be displayed in a 3D space. diff --git a/yaml/types/Game.yaml b/yaml/types/Game.yaml new file mode 100644 index 0000000..5004379 --- /dev/null +++ b/yaml/types/Game.yaml @@ -0,0 +1,49 @@ +Name: Game +BaseType: Instance +Properties: + - Name: IsLocalTest + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: GameID + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The ID of the current Polytoria place. + - Name: ServerID + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The server ID of the current instance. + - Name: UpTime + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The uptime of this game in seconds. + - Name: InstanceCount + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The total number of instances currently loaded. +Methods: [] +Events: + - Name: Ready + Arguments: "" + Description: Fires when the game is ready + - Name: Rendered + Arguments: + Name: delta + Type: number + Description: Fires every frame after the place has been rendered. The `delta` + parameter is the time between the last frame and the current. +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Game is the root object in the Polytoria instance tree. It is the + object from which everything is descended. diff --git a/yaml/types/Grabbable.yaml b/yaml/types/Grabbable.yaml new file mode 100644 index 0000000..c4f36ee --- /dev/null +++ b/yaml/types/Grabbable.yaml @@ -0,0 +1,63 @@ +Name: Grabbable +BaseType: Instance +Properties: + - Name: Force + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the force used to drag this object. + - Name: MaxRange + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the max range that this object can be dragged. + - Name: PermissionMode + Type: GrabbablePermissionModeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the permission mode for this grabber + - Name: Dragger + Type: Player + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Returns the current dragger + - Name: PermissionPredicate + Type: function + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: >- + A predicate function deciding whenever this player can grab this object. + `PermissionMode` must be set to `GrabbablePermissionMode.Scripted` + + + Example usage: + + ```lua + + grabbable.PermissionMode = Enums.GrabbablePermissionMode.Scripted + + grabbable.PermissionPredicate = function(player) + return player.Name == "Player1" + end + + ``` +Methods: [] +Events: + - Name: Grabbed + Arguments: + Name: grabber + Type: Player + Description: Fires when this object has been grabbed + - Name: Released + Arguments: "" + Description: Fires when this object has been released +IsStatic: false +IsAbstract: false +IsInstantiatable: true +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. diff --git a/yaml/types/GradientSky.yaml b/yaml/types/GradientSky.yaml new file mode 100644 index 0000000..fa1a3a7 --- /dev/null +++ b/yaml/types/GradientSky.yaml @@ -0,0 +1,81 @@ +Name: GradientSky +BaseType: Sky +Properties: + - Name: SunDiscColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the color emitting off the sun. + - Name: SunDiscMultiplier + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the multiplier of the sun. + - Name: SunDiscExponent + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the exponent of the sun. + - Name: SunHaloColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the color of the sun halo. + - Name: SunHaloExponent + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the exponent of the sun halo. + - Name: SunHaloContribution + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the contribution of the sun halo. + - Name: HorizonLineColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the horizon line's color. + - Name: HorizonLineExponent + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the horizon line's exponent. + - Name: HorizonLineContribution + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines how much the horizon line contributes. + - Name: SkyGradientTop + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the top color of the gradient. + - Name: SkyGradientBottom + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the bottom color of the gradient. + - Name: SkyGradientExponent + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the gradient's exponent. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: GradientSky is a class that is used to set a gradient skybox in the world. diff --git a/yaml/types/Hidden.yaml b/yaml/types/Hidden.yaml new file mode 100644 index 0000000..9958c06 --- /dev/null +++ b/yaml/types/Hidden.yaml @@ -0,0 +1,9 @@ +Name: Hidden +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Hidden is a object used for hiding instances. diff --git a/yaml/types/HttpRequestData.yaml b/yaml/types/HttpRequestData.yaml new file mode 100644 index 0000000..57c5a72 --- /dev/null +++ b/yaml/types/HttpRequestData.yaml @@ -0,0 +1,41 @@ +Name: HttpRequestData +BaseType: null +Properties: + - Name: URL + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The target endpoint of the HTTP request. + - Name: Method + Type: HttpRequestMethodEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The HTTP method used for the request. + - Name: Body + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The payload sent with the request. + - Name: Headers + Type: table + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: A table of HTTP headers to include with the request, represented as + key-value pairs. +Methods: + - Name: New + ReturnType: HttpRequestData + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates and returns a new instance of `HttpRequestData` +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: HttpRequestData represents the data required to construct an HTTP request diff --git a/yaml/types/HttpResponseData.yaml b/yaml/types/HttpResponseData.yaml new file mode 100644 index 0000000..af4fe95 --- /dev/null +++ b/yaml/types/HttpResponseData.yaml @@ -0,0 +1,34 @@ +Name: HttpResponseData +BaseType: null +Properties: + - Name: Success + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the HTTP request completed successfully. + - Name: StatusCode + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The HTTP status code returned by the server. + - Name: Headers + Type: table + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: A table containing the HTTP response headers returned by the + server, represented as key-value pairs. + - Name: Body + Type: string + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The response payload returned by the server as a string buffer. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: HttpResponseData represents the result of an HTTP request. diff --git a/yaml/types/HttpService.yaml b/yaml/types/HttpService.yaml new file mode 100644 index 0000000..d789b6f --- /dev/null +++ b/yaml/types/HttpService.yaml @@ -0,0 +1,111 @@ +Name: HttpService +BaseType: Instance +Properties: [] +Methods: + - Name: RequestAsync + ReturnType: HttpResponseData + Parameters: + - Name: data + Type: HttpRequestData + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Send a request using the `HttpRequestData` + - Name: GetAsync + ReturnType: string + Parameters: + - Name: url + Type: string + IsOptional: false + DefaultValue: "" + - Name: headers + Type: table + IsOptional: true + DefaultValue: null + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Sends a GET request to the specified URL. + - Name: PostAsync + ReturnType: string + 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: Sends a POST request to the specified URL. + - Name: PutAsync + ReturnType: string + 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: Sends a PUT request to the specified URL. + - Name: DeleteAsync + ReturnType: string + 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: Sends a DELETE request to the specified url. + - Name: PatchAsync + ReturnType: string + 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: Sends a PATCH request to the specified url. +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Http is a service used for HTTP communications and requests. diff --git a/yaml/types/IOService.yaml b/yaml/types/IOService.yaml new file mode 100644 index 0000000..5317ca0 --- /dev/null +++ b/yaml/types/IOService.yaml @@ -0,0 +1,65 @@ +Name: IOService +BaseType: Instance +Properties: [] +Methods: + - Name: ReadBytesFromPath + ReturnType: string + Parameters: + - Name: path + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Read the file data from path + - Name: WriteBytesToPath + ReturnType: nil + Parameters: + - Name: path + Type: string + IsOptional: false + DefaultValue: "" + - Name: bytes + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Write data to file in the project + - Name: ListProjectFiles + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: List all files in the project + - Name: ReadBytesFromID + ReturnType: string + Parameters: + - Name: id + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Read the file data from linked ID + - Name: GetPathFromID + ReturnType: string + Parameters: + - Name: indexID + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Get the file path from linked ID +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Class for interacting with IO in project, only usable with scripts + with the respective permission. diff --git a/yaml/types/Image3D.yaml b/yaml/types/Image3D.yaml new file mode 100644 index 0000000..11a02cb --- /dev/null +++ b/yaml/types/Image3D.yaml @@ -0,0 +1,51 @@ +Name: Image3D +BaseType: Dynamic +Properties: + - Name: Image + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Specifies the image of the decal. + - Name: TextureScale + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The scale of the texture on the decal. + - Name: TextureOffset + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The offset of the texture on the decal. + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the color of the decal. + - Name: CastShadows + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the decal should cast shadows. + - Name: Shaded + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the decal should be affected by lighting. + - Name: FaceCamera + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not the decal should always face the camera. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Decals are objects that can have an image texture and are placed in the world. diff --git a/yaml/types/ImageAsset.yaml b/yaml/types/ImageAsset.yaml new file mode 100644 index 0000000..03a1367 --- /dev/null +++ b/yaml/types/ImageAsset.yaml @@ -0,0 +1,9 @@ +Name: ImageAsset +BaseType: ResourceAsset +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Base class for image assets diff --git a/yaml/types/InputAction.yaml b/yaml/types/InputAction.yaml new file mode 100644 index 0000000..18d9e0d --- /dev/null +++ b/yaml/types/InputAction.yaml @@ -0,0 +1,9 @@ +Name: InputAction +BaseType: null +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Base class for input action diff --git a/yaml/types/InputActionAxis.yaml b/yaml/types/InputActionAxis.yaml new file mode 100644 index 0000000..3a6d063 --- /dev/null +++ b/yaml/types/InputActionAxis.yaml @@ -0,0 +1,27 @@ +Name: InputActionAxis +BaseType: InputAction +Properties: + - Name: Negative + Type: InputButtonCollection + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Positive + Type: InputButtonCollection + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Value + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: InputActionAxis is a class that represents input action of axis type. diff --git a/yaml/types/InputActionButton.yaml b/yaml/types/InputActionButton.yaml new file mode 100644 index 0000000..d17f9ba --- /dev/null +++ b/yaml/types/InputActionButton.yaml @@ -0,0 +1,33 @@ +Name: InputActionButton +BaseType: InputAction +Properties: + - Name: Buttons + Type: InputButtonCollection + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: IsPressed + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Weight + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation +Methods: [] +Events: + - Name: Pressed + Arguments: "" + Description: Fires when this button has been pressed + - Name: Released + Arguments: "" + Description: Fires when this button has been released +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: InputActionButton is a class that represents input action of button type. diff --git a/yaml/types/InputActionVector2.yaml b/yaml/types/InputActionVector2.yaml new file mode 100644 index 0000000..512e73c --- /dev/null +++ b/yaml/types/InputActionVector2.yaml @@ -0,0 +1,39 @@ +Name: InputActionVector2 +BaseType: InputAction +Properties: + - Name: Up + Type: InputButtonCollection + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Down + Type: InputButtonCollection + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Left + Type: InputButtonCollection + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Right + Type: InputButtonCollection + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Value + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: InputActionVector2 is a class that represents input action of Vector2 type. diff --git a/yaml/types/InputButton.yaml b/yaml/types/InputButton.yaml new file mode 100644 index 0000000..c392ac9 --- /dev/null +++ b/yaml/types/InputButton.yaml @@ -0,0 +1,33 @@ +Name: InputButton +BaseType: null +Properties: + - Name: KeyCode + Type: KeyCodeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation +Methods: + - Name: New + ReturnType: InputButton + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation + - Name: New + ReturnType: InputButton + Parameters: + - Name: key + Type: KeyCodeEnum + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: InputButton is a class that represents a button KeyCode diff --git a/yaml/types/InputButtonCollection.yaml b/yaml/types/InputButtonCollection.yaml new file mode 100644 index 0000000..d736b71 --- /dev/null +++ b/yaml/types/InputButtonCollection.yaml @@ -0,0 +1,31 @@ +Name: InputButtonCollection +BaseType: null +Properties: [] +Methods: + - Name: AddButton + ReturnType: nil + Parameters: + - Name: btn + Type: InputButton + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: RemoveButton + ReturnType: nil + Parameters: + - Name: btn + Type: InputButton + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: A collection of Input Buttons diff --git a/yaml/types/InputService.yaml b/yaml/types/InputService.yaml new file mode 100644 index 0000000..e7278d0 --- /dev/null +++ b/yaml/types/InputService.yaml @@ -0,0 +1,183 @@ +Name: InputService +BaseType: Instance +Properties: + - Name: IsWindowFocused + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the game window is currently focused. + - Name: IsTouchscreen + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the input device is a touchscreen. + - Name: IsGameFocused + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the game is currently focused. + - Name: IsInputFocused + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether an input is currently focused. + - Name: IsGamepadConnected + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether a gamepad is currently connected. + - Name: IsMenuOpened + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the game menu is currently opened. + - Name: CursorLocked + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the cursor is currently locked. + - Name: CursorVisible + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the cursor is currently visible. + - Name: MousePosition + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the current position of the mouse cursor. + - Name: ScreenWidth + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the width of the screen. + - Name: ScreenHeight + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the height of the screen. +Methods: + - Name: GetMouseWorldPosition + ReturnType: Vector3 + Parameters: + - Name: ignoreList + Type: table + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns the 3D world-space position corresponding to the current + mouse cursor location. + - Name: GetVector2 + ReturnType: InputActionVector2 + Parameters: + - Name: actionName + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: GetButton + ReturnType: InputActionButton + Parameters: + - Name: actionName + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns true if the specified button is being held down. + - Name: GetAxis + ReturnType: InputActionAxis + Parameters: + - Name: actionName + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns the value of the specified axis. + - Name: BindButton + ReturnType: InputActionButton + Parameters: + - Name: name + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: BindAxis + ReturnType: InputActionAxis + Parameters: + - Name: name + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: BindVector2 + ReturnType: InputActionVector2 + Parameters: + - Name: name + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: + - Name: GameFocused + Arguments: "" + Description: Fires when the game has been focused + - Name: GameUnfocused + Arguments: "" + Description: Fires when the game has been unfocused + - Name: GamepadConnected + Arguments: "" + Description: Fires when gamepad is connected + - Name: GamepadDisconnected + Arguments: "" + Description: Fires when gamepad has been disconnected + - Name: KeyDown + Arguments: + Name: keycode + Type: KeyCodeEnum + Description: Fires when key has been pressed + - Name: KeyUp + Arguments: + Name: keycode + Type: KeyCodeEnum + Description: Fires when key has been released + - Name: AxisValueChanged + Arguments: + - Name: keycode + Type: KeyCodeEnum + - Name: value + Type: float + Description: Fires when analog input has been changed +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: InputService is a class used for retrieving user input data, such + as the mouse and keyboard. diff --git a/yaml/types/InsertService.yaml b/yaml/types/InsertService.yaml new file mode 100644 index 0000000..4e4f8a8 --- /dev/null +++ b/yaml/types/InsertService.yaml @@ -0,0 +1,43 @@ +Name: InsertService +BaseType: Instance +Properties: [] +Methods: + - Name: ModelAsync + ReturnType: Instance + Parameters: + - Name: id + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Inserts a model with the specified ID. + - Name: AccessoryAsync + ReturnType: Accessory + Parameters: + - Name: id + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Inserts an accessory with the specified ID. + - Name: ToolAsync + ReturnType: Tool + Parameters: + - Name: id + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Insert is a class used for inserting user-generated models into + your game via scripts. diff --git a/yaml/types/Instance.yaml b/yaml/types/Instance.yaml new file mode 100644 index 0000000..86a85fd --- /dev/null +++ b/yaml/types/Instance.yaml @@ -0,0 +1,236 @@ +Name: Instance +BaseType: NetworkedObject +Properties: + - Name: Parent + Type: Instance + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Defines the parent of this instance in the hierarchy. + - Name: EditableChildren + Type: boolean + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Tags + Type: table + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Tags associated with this instance. +Methods: + - Name: GetDescendants + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets all descendants of this instance. + - Name: FindChild + ReturnType: Instance + Parameters: + - Name: name + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Finds a child of this instance by name. + - Name: WaitChild + ReturnType: Instance + Parameters: + - Name: name + Type: string + IsOptional: false + DefaultValue: "" + - Name: timeoutSec + Type: number + IsOptional: true + DefaultValue: null + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: FindChildByClass + ReturnType: Instance + Parameters: + - Name: className + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Finds a child of this instance by class name. + - Name: MoveChild + ReturnType: nil + Parameters: + - Name: child + Type: Instance + IsOptional: false + DefaultValue: "" + - Name: index + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: GetChildren + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets all children of this instance. + - Name: GetChildrenOfClass + ReturnType: table + Parameters: + - Name: className + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets all children of this instance that are of the specified class. + - Name: IsAncestorOf + ReturnType: boolean + Parameters: + - Name: instance + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Determines if this instance is an ancestor of the given instance. + - Name: IsDescendantOf + ReturnType: boolean + Parameters: + - Name: instance + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Determines if this instance is a descendant of the given instance. + - Name: IsDescendantOfClass + ReturnType: boolean + Parameters: + - Name: className + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Determines if this instance is a descendant of the given class. + - Name: New + ReturnType: Instance + Parameters: + - Name: className + Type: string + IsOptional: false + DefaultValue: "" + - Name: parent + Type: Instance + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new instance of the specified class. + - Name: AddTag + ReturnType: nil + Parameters: + - Name: tag + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a tag to this instance. + - Name: RemoveTag + ReturnType: nil + Parameters: + - Name: tag + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Removes a tag from this instance. + - Name: HasTag + ReturnType: boolean + Parameters: + - Name: tag + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Checks if this instance has the specified tag. + - Name: Reparent + ReturnType: nil + Parameters: + - Name: to + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: GetParent + ReturnType: Instance + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets the parent of this instance. + - Name: SetParent + ReturnType: nil + Parameters: + - Name: newParent + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sets the parent of this instance. +Events: + - Name: ChildAdded + Arguments: + Name: child + Type: Instance + Description: Fires when child has been added to this instance + - Name: ChildRemoved + Arguments: + Name: child + Type: Instance + Description: Fires when child has been removed from this instance (either via + reparent or delete) + - Name: ChildDeleting + Arguments: + Name: child + Type: Instance + Description: Fires when child is being deleted from this instance + - Name: ChildDeleted + Arguments: + Name: child + Type: Instance + Description: Fires when child has been deleted from this instance +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Instance is the base class of all classes. Every class derives from + it and has all properties, events and functions Instance has. diff --git a/yaml/types/InstanceValue.yaml b/yaml/types/InstanceValue.yaml new file mode 100644 index 0000000..f84e7ad --- /dev/null +++ b/yaml/types/InstanceValue.yaml @@ -0,0 +1,15 @@ +Name: InstanceValue +BaseType: ValueBase +Properties: + - Name: Value + Type: Instance + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The value of this object. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: InstanceValue is an object that holds an Instance value. diff --git a/yaml/types/IntValue.yaml b/yaml/types/IntValue.yaml new file mode 100644 index 0000000..1fc2609 --- /dev/null +++ b/yaml/types/IntValue.yaml @@ -0,0 +1,15 @@ +Name: IntValue +BaseType: ValueBase +Properties: + - Name: Value + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The value of this object. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: IntValue is an object that holds an integer value. diff --git a/yaml/types/InteractionPrompt.yaml b/yaml/types/InteractionPrompt.yaml new file mode 100644 index 0000000..b1845b7 --- /dev/null +++ b/yaml/types/InteractionPrompt.yaml @@ -0,0 +1,48 @@ +Name: InteractionPrompt +BaseType: Dynamic +Properties: + - Name: Title + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: SubTitle + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: HoldDuration + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Key + Type: KeyCodeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: UseDefaultUI + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation +Methods: [] +Events: + - Name: Triggered + Arguments: "" + Description: Missing Documentation + - Name: TriggerStarted + Arguments: "" + Description: Missing Documentation + - Name: TriggerReleased + Arguments: "" + Description: Missing Documentation +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: WIP class, not functional yet diff --git a/yaml/types/Inventory.yaml b/yaml/types/Inventory.yaml new file mode 100644 index 0000000..ec7dc06 --- /dev/null +++ b/yaml/types/Inventory.yaml @@ -0,0 +1,9 @@ +Name: Inventory +BaseType: Hidden +Properties: [] +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Missing Documentation diff --git a/yaml/types/Light.yaml b/yaml/types/Light.yaml new file mode 100644 index 0000000..054fdbf --- /dev/null +++ b/yaml/types/Light.yaml @@ -0,0 +1,33 @@ +Name: Light +BaseType: Dynamic +Properties: + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Sets the color of the light. + - Name: Brightness + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Sets the brightness of the light. + - Name: Specular + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Sets the specular intensity of the light. + - Name: Shadows + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Enables or disables shadows cast by the light. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Light is an abstract base class for all light objects in the world. diff --git a/yaml/types/Lighting.yaml b/yaml/types/Lighting.yaml new file mode 100644 index 0000000..a1f38d2 --- /dev/null +++ b/yaml/types/Lighting.yaml @@ -0,0 +1,53 @@ +Name: Lighting +BaseType: Instance +Properties: + - Name: Skybox + Type: SkyboxEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Sets the skybox to one of the preset skyboxes. + - Name: AmbientSource + Type: AmbientSourceEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the source of ambient lighting in the place. + - Name: AmbientColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Sets the ambient color of the lighting in the place. + - Name: FogEnabled + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Enables or disables fog in the place. + - Name: FogColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Sets the color of the fog in the place. + - Name: FogStartDistance + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Sets the distance from the camera at which fog begins to appear. + - Name: FogEndDistance + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Sets the distance from the camera at which fog stops appearing. +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +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. diff --git a/yaml/types/LightingModifier.yaml b/yaml/types/LightingModifier.yaml new file mode 100644 index 0000000..0442dc2 --- /dev/null +++ b/yaml/types/LightingModifier.yaml @@ -0,0 +1,9 @@ +Name: LightingModifier +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Base class for lighting modifiers diff --git a/yaml/types/Marker3D.yaml b/yaml/types/Marker3D.yaml new file mode 100644 index 0000000..f75c6cd --- /dev/null +++ b/yaml/types/Marker3D.yaml @@ -0,0 +1,22 @@ +Name: Marker3D +BaseType: Dynamic +Properties: + - Name: Length + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: AppearOnTop + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Marker3D is a object that allows marking a specific point in world. + This will hint an axis gizmo in local test and creator. diff --git a/yaml/types/Mesh.yaml b/yaml/types/Mesh.yaml new file mode 100644 index 0000000..d4c7a62 --- /dev/null +++ b/yaml/types/Mesh.yaml @@ -0,0 +1,102 @@ +Name: Mesh +BaseType: Entity +Properties: + - Name: Asset + Type: MeshAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The mesh asset used by this Mesh. + - Name: IncludeOffset + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Whether to keep the offset of the mesh or recenter it. + - Name: CollisionType + Type: CollisionTypeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The type of collision shape to apply to the mesh. + - Name: PlayAnimationOnStart + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: 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 + Description: Whether to use the color of the part this mesh is attached to. + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the mesh. + - Name: CastShadows + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Whether the mesh casts shadows. + - Name: CurrentAnimation + Type: string + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the name of the current animation playing on the mesh. + - Name: IsAnimationPlaying + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether an animation is currently playing on the mesh. +Methods: + - Name: PlayAnimation + ReturnType: nil + Parameters: + - Name: animationName + Type: string + IsOptional: false + DefaultValue: "" + - Name: speed + Type: number + IsOptional: true + DefaultValue: "1" + - Name: loop + Type: boolean + IsOptional: true + DefaultValue: "True" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Plays the specified animation on the mesh. + - Name: StopAnimation + ReturnType: nil + Parameters: + - Name: animationName + Type: string + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Stops the specified animation on the mesh. + - Name: GetAnimations + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets a list of all animations available on the mesh. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +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. diff --git a/yaml/types/MeshAsset.yaml b/yaml/types/MeshAsset.yaml new file mode 100644 index 0000000..53d76af --- /dev/null +++ b/yaml/types/MeshAsset.yaml @@ -0,0 +1,9 @@ +Name: MeshAsset +BaseType: ResourceAsset +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Base class for mesh assets diff --git a/yaml/types/Model.yaml b/yaml/types/Model.yaml new file mode 100644 index 0000000..6d372bb --- /dev/null +++ b/yaml/types/Model.yaml @@ -0,0 +1,10 @@ +Name: Model +BaseType: Dynamic +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Model is an instance that can hold other instances, and which + transform affects its children. diff --git a/yaml/types/ModuleScript.yaml b/yaml/types/ModuleScript.yaml new file mode 100644 index 0000000..963731d --- /dev/null +++ b/yaml/types/ModuleScript.yaml @@ -0,0 +1,13 @@ +Name: ModuleScript +BaseType: Script +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +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 + and the client will run the ModuleScript once and store the result for other + scripts to retrieve with require(). diff --git a/yaml/types/NPC.yaml b/yaml/types/NPC.yaml new file mode 100644 index 0000000..ce9ad76 --- /dev/null +++ b/yaml/types/NPC.yaml @@ -0,0 +1,252 @@ +Name: NPC +BaseType: Physical +Properties: + - Name: SeatOffset + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: 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 + Description: The current health of the NPC. + - Name: MaxHealth + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The maximum health of the NPC. + - Name: JumpPower + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the jump power of the NPC. + - Name: WalkSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the walking speed of the NPC. + - Name: UseNametag + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the NPC uses a nametag. + - Name: NametagOffset + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the offset position of the NPC's nametag. + - Name: DisplayName + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the display name of the NPC. + - Name: JumpSound + Type: Sound + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the sound played when the NPC jumps. + - Name: IsSitting + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the NPC is currently sitting. + - Name: IsDead + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the NPC is currently dead. + - Name: HoldingTool + Type: Tool + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the tool currently held by the NPC. + - Name: SittingIn + Type: Seat + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the seat in which the NPC is currently sitting. + - Name: Character + Type: CharacterModel + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The character model associated with the NPC. + - Name: MoveTarget + Type: Dynamic + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the instance the NPC should walk towards. + - Name: OnGround + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the NPC is currently on the ground. + - Name: OnCeiling + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the NPC is currently on the ceiling. + - Name: NavDestinationDistance + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates the distance to the navigation destination. + - Name: NavDestinationReached + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the NPC has reached its navigation destination. + - Name: NavDestinationValid + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the navigation destination is valid. +Methods: + - Name: Kill + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Kills the NPC. + - Name: Jump + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Makes the NPC jump. + - Name: Sit + ReturnType: nil + Parameters: + - Name: seat + Type: Seat + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Makes the NPC sit on a specified seat. + - Name: Unsit + ReturnType: nil + Parameters: + - Name: addForce + Type: boolean + IsOptional: true + DefaultValue: "True" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Unsits the NPC from the current seat. + - Name: EquipTool + ReturnType: nil + Parameters: + - Name: tool + Type: Tool + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Equips the NPC with a specified tool. + - Name: DropTool + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Unequips the currently equipped tool from the NPC. + - Name: LoadAppearance + ReturnType: nil + Parameters: + - Name: userID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Loads the appearance of the NPC based on a user ID. + - Name: ClearAppearance + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Clears the NPC's current appearance. + - Name: SetNavDestination + ReturnType: nil + Parameters: + - Name: pos + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Determines the position the NPC should walk towards. + - Name: Respawn + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Respawns the NPC. + - Name: TakeDamage + ReturnType: nil + Parameters: + - Name: dmg + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Applies damage to the NPC. + - Name: Heal + ReturnType: nil + Parameters: + - Name: amount + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Heals the NPC by a specified amount. +Events: + - Name: Died + Arguments: "" + Description: Triggered when the NPC dies. + - Name: Landed + Arguments: "" + Description: Triggered when the NPC lands on the ground after a jump or fall. + - Name: NavFinished + Arguments: "" + Description: Triggered when the NPC finishes navigating to a destination. +IsStatic: false +IsAbstract: false +IsInstantiatable: true +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. diff --git a/yaml/types/NetMessage.yaml b/yaml/types/NetMessage.yaml new file mode 100644 index 0000000..a222dab --- /dev/null +++ b/yaml/types/NetMessage.yaml @@ -0,0 +1,225 @@ +Name: NetMessage +BaseType: null +Properties: [] +Methods: + - Name: AddString + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a string value to the message with the specified key. + - Name: AddInt + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds an integer value to the message with the specified key. + - Name: AddBool + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: boolean + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a boolean value to the message with the specified key. + - Name: AddNumber + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a number value to the message with the specified key. + - Name: AddVector2 + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a Vector2 value to the message with the specified key. + - Name: AddVector3 + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a Vector3 value to the message with the specified key. + - Name: AddColor + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: Color + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds a Color value to the message with the specified key. + - Name: AddInstance + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + - Name: value + Type: Instance + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Adds an Instance value to the message with the specified key. + - Name: GetString + ReturnType: string + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets a string value from the message with the specified key. + - Name: GetInt + ReturnType: number + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets an integer value from the message with the specified key. + - Name: GetNumber + ReturnType: number + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets a number value from the message with the specified key. + - Name: GetBool + ReturnType: boolean + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets a boolean value from the message with the specified key. + - Name: GetVector2 + ReturnType: Vector2 + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets a Vector2 value from the message with the specified key. + - Name: GetVector3 + ReturnType: Vector3 + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets a Vector3 value from the message with the specified key. + - Name: GetColor + ReturnType: Color + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets a Color value from the message with the specified key. + - Name: GetInstance + ReturnType: Instance + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Gets an Instance value from the message with the specified key. + - Name: New + ReturnType: NetMessage + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new NetMessage instance. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Represents a network message used for communication between clients + and servers. diff --git a/yaml/types/NetworkEvent.yaml b/yaml/types/NetworkEvent.yaml new file mode 100644 index 0000000..a2b9a12 --- /dev/null +++ b/yaml/types/NetworkEvent.yaml @@ -0,0 +1,70 @@ +Name: NetworkEvent +BaseType: Instance +Properties: + - Name: Reliable + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation +Methods: + - Name: InvokeServer + ReturnType: nil + Parameters: + - Name: msg + Type: NetMessage + IsOptional: false + DefaultValue: "" + - Name: _ + Type: any + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sends a message to the server. + - Name: InvokeClient + ReturnType: nil + Parameters: + - Name: msg + Type: NetMessage + IsOptional: false + DefaultValue: "" + - Name: player + Type: Player + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sends a message to a specific client. + - Name: InvokeClients + ReturnType: nil + Parameters: + - Name: msg + Type: NetMessage + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sends a message to all connected clients. +Events: + - Name: InvokedServer + Arguments: + - Name: sender + Type: Player + - Name: msg + Type: NetMessage + 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 +Description: Missing Documentation diff --git a/yaml/types/NetworkService.yaml b/yaml/types/NetworkService.yaml new file mode 100644 index 0000000..7579f59 --- /dev/null +++ b/yaml/types/NetworkService.yaml @@ -0,0 +1,9 @@ +Name: NetworkService +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Missing Documentation diff --git a/yaml/types/NetworkedObject.yaml b/yaml/types/NetworkedObject.yaml new file mode 100644 index 0000000..f334584 --- /dev/null +++ b/yaml/types/NetworkedObject.yaml @@ -0,0 +1,103 @@ +Name: NetworkedObject +BaseType: null +Properties: + - Name: Name + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: ClassName + Type: string + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: Shared + Type: ScriptSharedTable + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: NetworkedObjectID + Type: string + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: ObjectID + Type: string + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: ExistInNetwork + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation +Methods: + - Name: IsA + ReturnType: boolean + Parameters: + - Name: className + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Clone + ReturnType: NetworkedObject + Parameters: + - Name: parent + Type: NetworkedObject + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Destroy + ReturnType: nil + Parameters: + - Name: time + Type: number + IsOptional: true + DefaultValue: "0" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Delete + ReturnType: nil + Parameters: + - Name: time + Type: number + IsOptional: true + DefaultValue: "0" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: + - Name: PropertyChanged + Arguments: + Name: propertyName + Type: string + Description: Missing Documentation + - Name: Renamed + Arguments: "" + Description: Missing Documentation + - Name: TreeEntered + Arguments: "" + Description: Missing Documentation + - Name: TreeExited + Arguments: "" + Description: Missing Documentation +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Missing Documentation diff --git a/yaml/types/NewServerRequestData.yaml b/yaml/types/NewServerRequestData.yaml new file mode 100644 index 0000000..b96623e --- /dev/null +++ b/yaml/types/NewServerRequestData.yaml @@ -0,0 +1,29 @@ +Name: NewServerRequestData +BaseType: null +Properties: + - Name: PlacePath + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: MaxPlayers + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation +Methods: + - Name: New + ReturnType: NewServerRequestData + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Missing Documentation +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: NewServerRequestData represents the request data for a new server + instance, to be used with PlacesService. diff --git a/yaml/types/NumberRange.yaml b/yaml/types/NumberRange.yaml new file mode 100644 index 0000000..1e74823 --- /dev/null +++ b/yaml/types/NumberRange.yaml @@ -0,0 +1,50 @@ +Name: NumberRange +BaseType: ValueType +Properties: + - Name: Min + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the minimum value of the range. + - Name: Max + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the maximum value of the range. +Methods: + - Name: New + ReturnType: NumberRange + Parameters: + - Name: from + Type: number + IsOptional: false + DefaultValue: "" + - Name: to + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new NumberRange object with the specified minimum and + maximum values. + - Name: Lerp + ReturnType: number + Parameters: + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Linearly interpolates between the minimum and maximum values of the + range based on the parameter t, which is typically between 0 and 1. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: NumberRange is a data type that represents a range between two + numbers, defined by a minimum and maximum value. diff --git a/yaml/types/NumberValue.yaml b/yaml/types/NumberValue.yaml new file mode 100644 index 0000000..9160191 --- /dev/null +++ b/yaml/types/NumberValue.yaml @@ -0,0 +1,15 @@ +Name: NumberValue +BaseType: ValueBase +Properties: + - Name: Value + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The value of this object. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: NumberValue is an object that holds a number value. diff --git a/yaml/types/PTAudioAsset.yaml b/yaml/types/PTAudioAsset.yaml new file mode 100644 index 0000000..a4fbca2 --- /dev/null +++ b/yaml/types/PTAudioAsset.yaml @@ -0,0 +1,15 @@ +Name: PTAudioAsset +BaseType: AudioAsset +Properties: + - Name: AudioID + Type: number + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Audio asset which is loaded from Polytoria diff --git a/yaml/types/PTCallback.yaml b/yaml/types/PTCallback.yaml new file mode 100644 index 0000000..c74877d --- /dev/null +++ b/yaml/types/PTCallback.yaml @@ -0,0 +1,10 @@ +Name: PTCallback +BaseType: null +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: A function that doesn't expect a return value. This will sometimes + be referred as `function` diff --git a/yaml/types/PTFunction.yaml b/yaml/types/PTFunction.yaml new file mode 100644 index 0000000..61e64e8 --- /dev/null +++ b/yaml/types/PTFunction.yaml @@ -0,0 +1,10 @@ +Name: PTFunction +BaseType: null +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: A function that expects a return value. This will sometimes be + referred as `function` diff --git a/yaml/types/PTImageAsset.yaml b/yaml/types/PTImageAsset.yaml new file mode 100644 index 0000000..d176db8 --- /dev/null +++ b/yaml/types/PTImageAsset.yaml @@ -0,0 +1,21 @@ +Name: PTImageAsset +BaseType: ImageAsset +Properties: + - Name: ImageID + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Asset ID of this image + - Name: ImageType + Type: ImageTypeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Image type of this image +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: An image asset that's loaded from Polytoria. diff --git a/yaml/types/PTMeshAsset.yaml b/yaml/types/PTMeshAsset.yaml new file mode 100644 index 0000000..4e41854 --- /dev/null +++ b/yaml/types/PTMeshAsset.yaml @@ -0,0 +1,15 @@ +Name: PTMeshAsset +BaseType: MeshAsset +Properties: + - Name: AssetID + Type: number + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: Asset ID of this mesh +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: A mesh asset that's loaded from Polytoria. diff --git a/yaml/types/PTSignal.yaml b/yaml/types/PTSignal.yaml new file mode 100644 index 0000000..dd03ab9 --- /dev/null +++ b/yaml/types/PTSignal.yaml @@ -0,0 +1,49 @@ +Name: PTSignal +BaseType: null +Properties: [] +Methods: + - Name: Connect + ReturnType: nil + Parameters: + - Name: action + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Connect a function to this signal + - Name: Disconnect + ReturnType: nil + Parameters: + - Name: action + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Disconnect a function from this signal + - Name: Wait + ReturnType: any + Parameters: [] + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Wait until this signal's emitted + - Name: Once + ReturnType: nil + Parameters: + - Name: action + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Listen to this signal only once +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: A signal which scripts can subscribe to diff --git a/yaml/types/Part.yaml b/yaml/types/Part.yaml new file mode 100644 index 0000000..8085515 --- /dev/null +++ b/yaml/types/Part.yaml @@ -0,0 +1,33 @@ +Name: Part +BaseType: Entity +Properties: + - Name: Shape + Type: ShapeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the shape of the part. + - Name: Material + Type: PartMaterialEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the material of the part. + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the color of the part. + - Name: CastShadows + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the part casts shadows. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Parts represent the basic building blocks of the world. diff --git a/yaml/types/Particles.yaml b/yaml/types/Particles.yaml new file mode 100644 index 0000000..14cca26 --- /dev/null +++ b/yaml/types/Particles.yaml @@ -0,0 +1,77 @@ +Name: Particles +BaseType: Dynamic +Properties: + - Name: Image + Type: ImageAsset + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: The image used for the particles. + - Name: Color + Type: ColorSeries + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color gradient used for the particles. + - Name: Lifetime + Type: NumberRange + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the lifetime of a particle. + - Name: Amount + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the number of particles emitted. + - Name: Gravity + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the gravity effect applied to the particles. + - Name: Shaded + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the particles are shaded. + - Name: Autoplay + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the particle system plays automatically. +Methods: + - Name: Play + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Starts playing the particle system. + - Name: Stop + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Stops playing the particle system. + - Name: Emit + ReturnType: nil + Parameters: + - Name: count + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Emits a specified number of particles immediately. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Particles represents a particle system that can be used to create + various visual effects. diff --git a/yaml/types/Physical.yaml b/yaml/types/Physical.yaml new file mode 100644 index 0000000..8a7a672 --- /dev/null +++ b/yaml/types/Physical.yaml @@ -0,0 +1,65 @@ +Name: Physical +BaseType: Dynamic +Properties: + - Name: Anchored + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether this object is affected by physics. + - Name: CanCollide + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether this object can collide with other objects. + - Name: Velocity + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the linear velocity of this object. + - Name: AngularVelocity + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the angular velocity of this object. +Methods: + - Name: SetNetworkAuthority + ReturnType: nil + Parameters: + - Name: plr + Type: Player + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Sets the network authority of this object to the specified player. +Events: + - Name: Touched + Arguments: + Name: hit + Type: Physical + Description: Fires when this object has collide with other object + - Name: TouchEnded + Arguments: + Name: hit + Type: Physical + Description: Fires when this object has stopped colliding with other object + - Name: MouseEnter + Arguments: "" + Description: Fires when cursor is hovered on this object. Only fired locally + - Name: MouseExit + Arguments: "" + Description: Fires when cursor leaves this object. Only fired locally + - Name: Clicked + Arguments: + Name: player + Type: Player + Description: Fires when this object has been clicked by a player +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Physical represents an object affected by physics in the world. diff --git a/yaml/types/PhysicalModel.yaml b/yaml/types/PhysicalModel.yaml new file mode 100644 index 0000000..1ed7308 --- /dev/null +++ b/yaml/types/PhysicalModel.yaml @@ -0,0 +1,10 @@ +Name: PhysicalModel +BaseType: Physical +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: PhysicalModel is a object that represent a group of objects, that's + affected by physics. diff --git a/yaml/types/PlacesService.yaml b/yaml/types/PlacesService.yaml new file mode 100644 index 0000000..b5737b4 --- /dev/null +++ b/yaml/types/PlacesService.yaml @@ -0,0 +1,91 @@ +Name: PlacesService +BaseType: Instance +Properties: [] +Methods: + - Name: NewServerAsync + ReturnType: string + Parameters: + - Name: placePath + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Request a new server with data + - Name: NewServerAsync + ReturnType: string + Parameters: + - Name: data + Type: NewServerRequestData + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Request a new server with data + - Name: JoinPlaceAsync + ReturnType: nil + Parameters: + - Name: plr + Type: Player + IsOptional: false + DefaultValue: "" + - Name: to + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Join a player to a public server of the specified place + - Name: JoinPlacePartyAsync + ReturnType: nil + Parameters: + - Name: plrs + Type: table + IsOptional: false + DefaultValue: "" + - Name: to + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Join a party of player to a public server of the specified place + - Name: JoinPrivateAsync + ReturnType: nil + Parameters: + - Name: plr + Type: Player + IsOptional: false + DefaultValue: "" + - Name: accessID + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Join a player to a private server of the specified place + - Name: JoinPrivatePartyAsync + ReturnType: nil + Parameters: + - Name: players + Type: table + IsOptional: false + DefaultValue: "" + - Name: accessID + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Join a party of player to a private server of the specified place +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: PlacesService is a service that is used to join players to other places diff --git a/yaml/types/Player.yaml b/yaml/types/Player.yaml new file mode 100644 index 0000000..c46ad63 --- /dev/null +++ b/yaml/types/Player.yaml @@ -0,0 +1,182 @@ +Name: Player +BaseType: NPC +Properties: + - Name: UserID + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The unique ID of the player. + - Name: CanMove + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player can move. + - Name: SprintSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the sprinting speed of the player. + - Name: Stamina + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the current stamina of the player. + - Name: MaxStamina + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the maximum stamina of the player. + - Name: UseStamina + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player uses stamina. + - Name: StaminaRegen + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the rate at which the player's stamina regenerates. + - Name: StaminaBurn + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the rate at which the player's stamina depletes while sprinting. + - Name: RespawnTime + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the time the player has to wait before respawning. + - Name: UseHeadTurning + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player uses head turning. + - Name: UseBubbleChat + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player uses bubble chat. + - Name: AutoLoadAppearance + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player's appearance is automatically loaded. + - Name: NetworkPing + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The amount of network latency (ping) the player is experiencing. + - Name: IsAdmin + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Determines whether the player is an administrator. + - Name: IsCreator + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Determines whether the player is the creator of the game. + - Name: ChatColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the chat color of the player. + - Name: IsLocal + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Determines whether the player is the local player. + - Name: IsClimbing + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Determines whether the player is currently climbing. + - Name: ClimbingTruss + Type: Truss + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Determines the truss the player is currently climbing. + - Name: UserPlatform + Type: ClientPlatformEnum + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Determines the platform the player is using. + - Name: Inventory + Type: Inventory + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The inventory of the player. +Methods: + - Name: Jump + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Makes the player jump. + - Name: Kick + ReturnType: nil + Parameters: + - Name: reason + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Kicks the player from the game with the specified reason. + - Name: UnequipTool + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Unequips the currently equipped tool of the player. + - Name: Respawn + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Respawns the player. + - Name: ResetAppearance + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Resets the player's appearance to the default. +Events: + - Name: Chatted + Arguments: + Name: message + Type: string + Description: Fires when this player chats + - Name: Respawned + Arguments: "" + Description: Fires when this player has respawned +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Player represents a user playing the game. diff --git a/yaml/types/PlayerDefaults.yaml b/yaml/types/PlayerDefaults.yaml new file mode 100644 index 0000000..7d6cf0d --- /dev/null +++ b/yaml/types/PlayerDefaults.yaml @@ -0,0 +1,108 @@ +Name: PlayerDefaults +BaseType: Hidden +Properties: + - Name: MaxHealth + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The default maximum health of the player. + - Name: WalkSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The default walking speed of the player. + - Name: SprintSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The default sprinting speed of the player. + - Name: JumpPower + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The default jump power of the player. + - Name: RespawnTime + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The default time the player has to wait before respawning. + - Name: ChatColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The default chat color of the player. + - Name: CanMove + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player can move by default. + - Name: StaminaBurn + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The rate at which the player's stamina depletes while sprinting. + - Name: UseStamina + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player uses stamina. + - Name: Stamina + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the default stamina of players. + - Name: MaxStamina + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the default maximum stamina of players. + - Name: StaminaRegen + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the rate at which the player's stamina regenerates. + - Name: UseHeadTurning + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player uses head turning by default. + - Name: UseBubbleChat + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player uses bubble chat by default. + - Name: AutoLoadAppearance + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the player's appearance is automatically loaded + by default. +Methods: + - Name: LoadDefaults + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Resets the specified player back to their default values. +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: PlayerDefaults is a service used for storing the default values of + the Player when created. diff --git a/yaml/types/PlayerGUI.yaml b/yaml/types/PlayerGUI.yaml new file mode 100644 index 0000000..b37d7d6 --- /dev/null +++ b/yaml/types/PlayerGUI.yaml @@ -0,0 +1,9 @@ +Name: PlayerGUI +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: PlayerGUI is a class that contains all custom GUIs. diff --git a/yaml/types/Players.yaml b/yaml/types/Players.yaml new file mode 100644 index 0000000..68788ce --- /dev/null +++ b/yaml/types/Players.yaml @@ -0,0 +1,66 @@ +Name: Players +BaseType: Instance +Properties: + - Name: LocalPlayer + Type: Player + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The player who is currently playing the game. + - Name: PlayerCollisionEnabled + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether or not collisions between players are enabled. + - Name: PlayersCount + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The number of players currently in the game. +Methods: + - Name: GetPlayers + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns a table containing all the players currently in the game. + - Name: GetPlayer + ReturnType: Player + Parameters: + - Name: username + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns the player with the specified username. + - Name: GetPlayerByID + ReturnType: Player + Parameters: + - Name: userID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Returns the player with the specified user ID. +Events: + - Name: PlayerAdded + Arguments: + Name: player + Type: Player + Description: Fires when player has connected + - Name: PlayerRemoved + Arguments: + Name: player + Type: Player + Description: Fires when player has disconnected +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Players is the container class for all Player instances. diff --git a/yaml/types/PointLight.yaml b/yaml/types/PointLight.yaml new file mode 100644 index 0000000..bc7302c --- /dev/null +++ b/yaml/types/PointLight.yaml @@ -0,0 +1,16 @@ +Name: PointLight +BaseType: Light +Properties: + - Name: Range + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The range of the point light's illumination. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: PointLight is a type of light that emits light in all directions + from a single point. diff --git a/yaml/types/PolytorianModel.yaml b/yaml/types/PolytorianModel.yaml new file mode 100644 index 0000000..2719cd9 --- /dev/null +++ b/yaml/types/PolytorianModel.yaml @@ -0,0 +1,185 @@ +Name: PolytorianModel +BaseType: CharacterModel +Properties: + - Name: HeadColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: TorsoColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: LeftArmColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: RightArmColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: LeftLegColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: RightLegColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: FaceImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: ShirtImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: PantsImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: TorsoMesh + Type: MeshAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: Ragdolling + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: RagdollPosition + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation + - Name: RagdollRotation + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Missing Documentation +Methods: + - Name: StartRagdoll + ReturnType: nil + Parameters: + - Name: force + Type: Vector3 + IsOptional: true + DefaultValue: null + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: StopRagdoll + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: GetAttachment + ReturnType: Dynamic + Parameters: + - Name: attachmentEnum + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: LoadAppearance + ReturnType: nil + Parameters: + - Name: userID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: ClearAppearance + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: SetAttachmentTransformOverride + ReturnType: nil + Parameters: + - Name: attachment + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + - Name: overrideThis + Type: boolean + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: SetAttachmentPositionOverride + ReturnType: nil + Parameters: + - Name: attachment + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + - Name: pos + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: SetAttachmentRotationOverride + ReturnType: nil + Parameters: + - Name: attachment + Type: CharacterAttachmentEnum + IsOptional: false + DefaultValue: "" + - Name: rot + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: + - Name: RagdollStarted + Arguments: "" + Description: Fires when ragdoll has been started + - Name: RagdollStopped + Arguments: "" + Description: Fires when ragdoll has been stopped +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Missing Documentation diff --git a/yaml/types/PreferencesService.yaml b/yaml/types/PreferencesService.yaml new file mode 100644 index 0000000..6ec09b5 --- /dev/null +++ b/yaml/types/PreferencesService.yaml @@ -0,0 +1,29 @@ +Name: PreferencesService +BaseType: Instance +Properties: + - Name: UsePhotoMode + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Determines whether the player has photo mode enabled. + - Name: UsePostProcessing + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Determines whether the player has post-processing effects enabled. +Methods: [] +Events: + - Name: SettingChanged + Arguments: + - Name: settingName + Type: string + - Name: setTo + Type: any + Description: Fired when a user preference setting is changed. +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: PreferencesService is a service that allows scripts to access some + of the user preferences diff --git a/yaml/types/PresenceService.yaml b/yaml/types/PresenceService.yaml new file mode 100644 index 0000000..9392e09 --- /dev/null +++ b/yaml/types/PresenceService.yaml @@ -0,0 +1,29 @@ +Name: PresenceService +BaseType: Instance +Properties: + - Name: State + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation + - Name: CoverImage + Type: PTImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Missing Documentation +Methods: + - Name: ResetTimer + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: PresenceService is a service that allows scripts to set the active + status of the player. Which will be used to display in supported integrations. diff --git a/yaml/types/ProceduralSky.yaml b/yaml/types/ProceduralSky.yaml new file mode 100644 index 0000000..71d4c2c --- /dev/null +++ b/yaml/types/ProceduralSky.yaml @@ -0,0 +1,40 @@ +Name: ProceduralSky +BaseType: Sky +Properties: + - Name: SunSize + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The size of the sun in the sky. + - Name: SkyTint + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The tint color of the sky. + - Name: HorizonColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the horizon in the sky. + - Name: GroundColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the ground in the sky. + - Name: Exposure + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The exposure level of the sky. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: ProceduralSky is a type of sky that generates its appearance + procedurally based on the position of the sun and its properties. diff --git a/yaml/types/PurchasesService.yaml b/yaml/types/PurchasesService.yaml new file mode 100644 index 0000000..70f8289 --- /dev/null +++ b/yaml/types/PurchasesService.yaml @@ -0,0 +1,40 @@ +Name: PurchasesService +BaseType: Instance +Properties: [] +Methods: + - Name: Prompt + ReturnType: nil + Parameters: + - Name: player + Type: Player + IsOptional: false + DefaultValue: "" + - Name: assetID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Prompts the specified player to purchase the asset with the given asset ID. + - Name: OwnsItemAsync + ReturnType: boolean + Parameters: + - Name: player + Type: Player + IsOptional: false + DefaultValue: "" + - Name: assetID + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: true + IsObsolete: false + IsStatic: false + Description: Checks asynchronously if the specified player owns the asset with + the given asset ID. +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: Service responsible for handling in-game purchases and ownership verification. diff --git a/yaml/types/Quaternion.yaml b/yaml/types/Quaternion.yaml new file mode 100644 index 0000000..4519ae6 --- /dev/null +++ b/yaml/types/Quaternion.yaml @@ -0,0 +1,315 @@ +Name: Quaternion +BaseType: null +Properties: + - Name: X + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The X component of the quaternion. + - Name: Y + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The Y component of the quaternion. + - Name: Z + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The Z component of the quaternion. + - Name: W + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The W component of the quaternion. + - Name: Identity + Type: Quaternion + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The identity rotation. +Methods: + - Name: New + ReturnType: Quaternion + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Quaternion object with the specified components. + - Name: New + ReturnType: Quaternion + Parameters: + - Name: x + Type: number + IsOptional: false + DefaultValue: "" + - Name: y + Type: number + IsOptional: false + DefaultValue: "" + - Name: z + Type: number + IsOptional: false + DefaultValue: "" + - Name: w + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a new Quaternion object with the specified components. + - Name: Angle + ReturnType: Quaternion + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: Quaternion + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Calculates the angle between two quaternions. + - Name: AngleAxis + ReturnType: Quaternion + Parameters: + - Name: angle + Type: number + IsOptional: false + DefaultValue: "" + - Name: axis + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a rotation which rotates angle degrees around axis. + - Name: Dot + ReturnType: Quaternion + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: Quaternion + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Calculates the dot product of two quaternions. + - Name: Euler + ReturnType: Quaternion + Parameters: + - Name: x + Type: number + IsOptional: false + DefaultValue: "" + - Name: y + Type: number + IsOptional: false + DefaultValue: "" + - Name: z + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a quaternion from Euler angles specified by a Vector3. + - Name: Euler + ReturnType: Quaternion + Parameters: + - Name: euler + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a quaternion from Euler angles specified by a Vector3. + - Name: ToEuler + ReturnType: Vector3 + Parameters: + - Name: euler + Type: Quaternion + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Converts a quaternion to Euler angles represented as a Vector3. + - Name: FromToRotation + ReturnType: Quaternion + Parameters: + - Name: fromDirection + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: toDirection + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a rotation which rotates angle degrees around axis. + - Name: Inverse + ReturnType: Quaternion + Parameters: + - Name: rotation + Type: Quaternion + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Calculates the inverse of a quaternion. + - Name: Lerp + ReturnType: Quaternion + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Linearly interpolates between two quaternions. + - Name: LerpUnclamped + ReturnType: Quaternion + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Linearly interpolates between two quaternions without clamping the + interpolant. + - Name: LookRotation + ReturnType: Quaternion + Parameters: + - Name: forward + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a rotation with the specified forward and upwards directions. + - Name: LookRotation + ReturnType: Quaternion + Parameters: + - Name: forward + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: upwards + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Creates a rotation with the specified forward and upwards directions. + - Name: Normalize + ReturnType: Quaternion + Parameters: + - Name: quaternion + Type: Quaternion + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Normalizes the given quaternion. + - Name: RotateTowards + ReturnType: Quaternion + Parameters: + - Name: from + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: to + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: maxDegreesDelta + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Rotates a rotation from towards to by maxDegreesDelta. + - Name: Slerp + ReturnType: Quaternion + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Spherically interpolates between two quaternions. + - Name: SlerpUnclamped + ReturnType: Quaternion + Parameters: + - Name: a + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: b + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Spherically interpolates between two quaternions without clamping + the interpolant. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Represents a quaternion used for rotations. diff --git a/yaml/types/RayResult.yaml b/yaml/types/RayResult.yaml new file mode 100644 index 0000000..329032d --- /dev/null +++ b/yaml/types/RayResult.yaml @@ -0,0 +1,45 @@ +Name: RayResult +BaseType: ValueType +Properties: + - Name: Origin + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The origin point of the ray. + - Name: Direction + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The direction vector of the ray. + - Name: Position + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The position where the ray hit an object. + - Name: Normal + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The surface normal at the point where the ray hit. + - Name: Distance + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The distance from the ray's origin to the hit point. + - Name: Instance + Type: Instance + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The instance that was hit by the ray. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: RayResult is a data type that contains data about a raycast result. diff --git a/yaml/types/ResourceAsset.yaml b/yaml/types/ResourceAsset.yaml new file mode 100644 index 0000000..095ae9f --- /dev/null +++ b/yaml/types/ResourceAsset.yaml @@ -0,0 +1,9 @@ +Name: ResourceAsset +BaseType: BaseAsset +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Base class for resource based assets diff --git a/yaml/types/Script.yaml b/yaml/types/Script.yaml new file mode 100644 index 0000000..c81cabd --- /dev/null +++ b/yaml/types/Script.yaml @@ -0,0 +1,58 @@ +Name: Script +BaseType: Instance +Properties: + - Name: Source + Type: string + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: The source code of the script as a string. + - Name: LinkedScript + Type: FileLinkAsset + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: A linked script asset associated with this script. + - Name: Compatibility + Type: boolean + IsAccessibleByScripts: false + IsReadOnly: false + IsObsolete: false + Description: Indicates whether the script is running in compatibility mode. +Methods: + - Name: Call + ReturnType: nil + Parameters: + - Name: funcName + Type: string + IsOptional: false + DefaultValue: "" + - Name: args + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Calls a function in the script with the given arguments. + - Name: CallAsync + ReturnType: nil + Parameters: + - Name: funcName + Type: string + IsOptional: false + DefaultValue: "" + - Name: args + Type: any + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Calls a function in the script asynchronously with the given arguments. +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Scripts are abstract base classes representing Lua code that can be + executed in the game. diff --git a/yaml/types/ScriptService.yaml b/yaml/types/ScriptService.yaml new file mode 100644 index 0000000..0351746 --- /dev/null +++ b/yaml/types/ScriptService.yaml @@ -0,0 +1,10 @@ +Name: ScriptService +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: ScriptService is a service used for storing scripts and local + scripts. It is also responsible for managing their execution within the game. diff --git a/yaml/types/ScriptSharedTable.yaml b/yaml/types/ScriptSharedTable.yaml new file mode 100644 index 0000000..40e742d --- /dev/null +++ b/yaml/types/ScriptSharedTable.yaml @@ -0,0 +1,10 @@ +Name: ScriptSharedTable +BaseType: null +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Shared table of object. This class provides a table which any + scripts can modify. diff --git a/yaml/types/Seat.yaml b/yaml/types/Seat.yaml new file mode 100644 index 0000000..837a704 --- /dev/null +++ b/yaml/types/Seat.yaml @@ -0,0 +1,31 @@ +Name: Seat +BaseType: Part +Properties: + - Name: Occupant + Type: NPC + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Indicates who is currently occupying the seat. + - Name: CanNPCSit + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether NPCs are allowed to sit on this seat or only players. +Methods: [] +Events: + - Name: Sat + Arguments: + Name: occupant + Type: NPC + Description: Fires when an occupant sits on the seat. + - Name: Vacated + Arguments: + Name: occupant + Type: NPC + Description: Fires when an occupant leaves the seat. +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Seats are parts the player can sit on. diff --git a/yaml/types/ServerHidden.yaml b/yaml/types/ServerHidden.yaml new file mode 100644 index 0000000..063f4e2 --- /dev/null +++ b/yaml/types/ServerHidden.yaml @@ -0,0 +1,11 @@ +Name: ServerHidden +BaseType: Hidden +Properties: [] +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: ServerHidden, similar to Hidden, is a container for objects that + are meant to be hidden. Unlike Hidden, ServerHidden won't replicate its + contents to clients and can only be accessed by the server. diff --git a/yaml/types/ServerScript.yaml b/yaml/types/ServerScript.yaml new file mode 100644 index 0000000..5e635bc --- /dev/null +++ b/yaml/types/ServerScript.yaml @@ -0,0 +1,9 @@ +Name: ServerScript +BaseType: Script +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: ServerScript is a script that runs on the server. diff --git a/yaml/types/Sky.yaml b/yaml/types/Sky.yaml new file mode 100644 index 0000000..ba52ed9 --- /dev/null +++ b/yaml/types/Sky.yaml @@ -0,0 +1,9 @@ +Name: Sky +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: Sky is an abstract base class representing the sky in the game world. diff --git a/yaml/types/Sound.yaml b/yaml/types/Sound.yaml new file mode 100644 index 0000000..77999e1 --- /dev/null +++ b/yaml/types/Sound.yaml @@ -0,0 +1,105 @@ +Name: Sound +BaseType: Dynamic +Properties: + - Name: Audio + Type: AudioAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The audio asset to be played by the sound. + - Name: Volume + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The volume level of the sound. + - Name: Pitch + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The pitch level of the sound. + - Name: Autoplay + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the sound should start playing automatically + when loaded. + - Name: Loop + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the sound should loop when it reaches the end. + - Name: PlayInWorld + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the sound should be played in the 3D world space. + - Name: MaxDistance + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The maximum distance at which the sound can be heard. + - Name: Time + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Indicates the current playback position of the sound in seconds. + - Name: Playing + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the sound is currently playing. + - Name: Loading + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the sound is currently loading. + - Name: Length + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The total length of the sound in seconds. +Methods: + - Name: Play + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Starts playing the sound. + - Name: PlayOneShot + ReturnType: nil + Parameters: + - Name: volume + Type: number + IsOptional: true + DefaultValue: "1" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Plays the sound once at the specified volume without affecting the + current playback. + - Name: Stop + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Stops the sound if it is currently playing. +Events: + - Name: Loaded + Arguments: "" + Description: Fires when this sound has loaded +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Sounds are objects that can be placed in the world and play audio. diff --git a/yaml/types/SpotLight.yaml b/yaml/types/SpotLight.yaml new file mode 100644 index 0000000..6914fd8 --- /dev/null +++ b/yaml/types/SpotLight.yaml @@ -0,0 +1,22 @@ +Name: SpotLight +BaseType: Light +Properties: + - Name: Range + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The maximum distance the light can reach. + - Name: Angle + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The angle of the spotlight's cone. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: SpotLight is a source of light emitting in a specific direction and + angle that can be placed in the world. diff --git a/yaml/types/StringValue.yaml b/yaml/types/StringValue.yaml new file mode 100644 index 0000000..fc6307e --- /dev/null +++ b/yaml/types/StringValue.yaml @@ -0,0 +1,15 @@ +Name: StringValue +BaseType: ValueBase +Properties: + - Name: Value + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The value of this object. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: StringValue is an object that holds a string value. diff --git a/yaml/types/SunLight.yaml b/yaml/types/SunLight.yaml new file mode 100644 index 0000000..2231c28 --- /dev/null +++ b/yaml/types/SunLight.yaml @@ -0,0 +1,10 @@ +Name: SunLight +BaseType: Light +Properties: [] +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: SunLight is the main directional light source representing the sun + in the game world. diff --git a/yaml/types/Temporary.yaml b/yaml/types/Temporary.yaml new file mode 100644 index 0000000..8920f0a --- /dev/null +++ b/yaml/types/Temporary.yaml @@ -0,0 +1,10 @@ +Name: Temporary +BaseType: Hidden +Properties: [] +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: A temporary container. All class that were instantiated from + `Instance.New` will have this class as their first parent. diff --git a/yaml/types/Text3D.yaml b/yaml/types/Text3D.yaml new file mode 100644 index 0000000..f673069 --- /dev/null +++ b/yaml/types/Text3D.yaml @@ -0,0 +1,69 @@ +Name: Text3D +BaseType: Dynamic +Properties: + - Name: Text + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The text content displayed. + - Name: FontSize + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The size of the font used for the text. + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the text. + - Name: OutlineWidth + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The width of the text outline. + - Name: OutlineColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the text outline. + - Name: FaceCamera + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the text should always be facing the camera. + - Name: HorizontalAlignment + Type: TextHorizontalAlignmentEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the horizontal alignment of the text. + - Name: VerticalAlignment + Type: TextVerticalAlignmentEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the vertical alignment of the text. + - Name: FontAsset + Type: FontAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The font asset used for the text. + - Name: UseRichText + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the text should be parsed as rich text. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Text3D is a class that represents 3D text in the game world. diff --git a/yaml/types/Tool.yaml b/yaml/types/Tool.yaml new file mode 100644 index 0000000..80df706 --- /dev/null +++ b/yaml/types/Tool.yaml @@ -0,0 +1,60 @@ +Name: Tool +BaseType: PhysicalModel +Properties: + - Name: Droppable + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the tool can be dropped by the player. + - Name: Holder + Type: NPC + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines who is currently holding this tool. +Methods: + - Name: Activate + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Activates the tool, similarly to pressing the mouse button. + - Name: Deactivate + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Deactivates the tool, similarly to releasing the mouse button. + - Name: PlayAnimation + ReturnType: nil + Parameters: + - Name: animationName + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Plays the specified animation on the holder of the tool. +Events: + - Name: Equipped + Arguments: "" + Description: Fires when this tool has been equipped + - Name: Unequipped + Arguments: "" + Description: Fires when this tool has been unequipped + - Name: Activated + Arguments: "" + Description: Fires when this tool has been activated (via mouse press or + `Tool:Activate`) + - Name: Deactivated + Arguments: "" + Description: Fires when this tool has been deactivated (via mouse release or + `Tool:Deactivate`) +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Tools are objects that can be held by the player. diff --git a/yaml/types/Truss.yaml b/yaml/types/Truss.yaml new file mode 100644 index 0000000..be7e645 --- /dev/null +++ b/yaml/types/Truss.yaml @@ -0,0 +1,15 @@ +Name: Truss +BaseType: Part +Properties: + - Name: ClimbSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The speed at which the player can climb the truss. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Trusses are parts that can be climbed by the player. diff --git a/yaml/types/TweenObject.yaml b/yaml/types/TweenObject.yaml new file mode 100644 index 0000000..ae11923 --- /dev/null +++ b/yaml/types/TweenObject.yaml @@ -0,0 +1,268 @@ +Name: TweenObject +BaseType: null +Properties: + - Name: Looped + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if this tween is looped + - Name: Parallel + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if this tween will run all the tweens in parallel + - Name: SpeedScale + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the speed scale of this tween + - Name: IsRunning + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Returns whether or not this tween is running + - Name: ElapsedTime + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Returns the elapsed time of this tween +Methods: + - Name: SetDirection + ReturnType: TweenObject + Parameters: + - Name: dir + Type: TweenDirectionEnum + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Set the direction of this tween. This function returns a + `TweenObject` which means you can stack it with other functions. + - Name: SetTrans + ReturnType: TweenObject + Parameters: + - Name: trans + Type: TweenTransitionEnum + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Set the transition of this tween. This function returns a + `TweenObject` which means you can stack it with other functions. + - Name: TweenPosition + ReturnType: nil + Parameters: + - Name: target + Type: Dynamic + IsOptional: false + DefaultValue: "" + - Name: destination + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: time + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Tweens the position of a Dynamic. + - Name: TweenRotation + ReturnType: nil + Parameters: + - Name: target + Type: Dynamic + IsOptional: false + DefaultValue: "" + - Name: destination + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: time + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Tweens the rotation of a Dynamic. + - Name: TweenSize + ReturnType: nil + Parameters: + - Name: target + Type: Dynamic + IsOptional: false + DefaultValue: "" + - Name: destination + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: time + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Tweens the size of a Dynamic. + - Name: TweenColor + ReturnType: nil + Parameters: + - Name: from + Type: Color + IsOptional: false + DefaultValue: "" + - Name: to + Type: Color + IsOptional: false + DefaultValue: "" + - Name: time + Type: number + IsOptional: false + DefaultValue: "" + - Name: callback + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Tweens a color between two specified values. + - Name: TweenNumber + ReturnType: nil + Parameters: + - Name: from + Type: number + IsOptional: false + DefaultValue: "" + - Name: to + Type: number + IsOptional: false + DefaultValue: "" + - Name: time + Type: number + IsOptional: false + DefaultValue: "" + - Name: callback + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Tweens a number between two specified values. + - Name: TweenVector2 + ReturnType: nil + Parameters: + - Name: from + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: to + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: time + Type: number + IsOptional: false + DefaultValue: "" + - Name: callback + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Tweens a Vector2 between two specified values. + - Name: TweenVector3 + ReturnType: nil + Parameters: + - Name: from + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: to + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: time + Type: number + IsOptional: false + DefaultValue: "" + - Name: callback + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Tweens a Vector3 between two specified values. + - Name: Play + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Play this tween + - Name: Pause + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Pause this tween + - Name: Stop + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Stop this tween + - Name: Interval + ReturnType: nil + Parameters: + - Name: sec + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Creates a delay in the tween. + - Name: Chain + ReturnType: TweenObject + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Chain a tween if parallel is set to true + - Name: Cancel + ReturnType: nil + Parameters: + - Name: callFinsihed + Type: boolean + IsOptional: true + DefaultValue: "False" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Cancel this tween +Events: + - Name: Finished + Arguments: "" + Description: Fires when this tween has finished + - Name: Canceled + Arguments: "" + Description: Fires when this tween has been canceled +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: An object that represents tween diff --git a/yaml/types/TweenService.yaml b/yaml/types/TweenService.yaml new file mode 100644 index 0000000..2734718 --- /dev/null +++ b/yaml/types/TweenService.yaml @@ -0,0 +1,19 @@ +Name: TweenService +BaseType: Instance +Properties: [] +Methods: + - Name: NewTween + ReturnType: TweenObject + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: >- + Creates a new tween object + + Note: Tween will run automatically after one frame, you must use it's function right after creating it. +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +Description: TweenService is a service for managing tweens diff --git a/yaml/types/UIButton.yaml b/yaml/types/UIButton.yaml new file mode 100644 index 0000000..fd6fbb0 --- /dev/null +++ b/yaml/types/UIButton.yaml @@ -0,0 +1,12 @@ +Name: UIButton +BaseType: UILabel +Properties: [] +Methods: [] +Events: + - Name: Clicked + Arguments: "" + Description: Fires when user click on this button +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UIButton is a class that represents a clickable button UI element. diff --git a/yaml/types/UIField.yaml b/yaml/types/UIField.yaml new file mode 100644 index 0000000..de8ba11 --- /dev/null +++ b/yaml/types/UIField.yaml @@ -0,0 +1,99 @@ +Name: UIField +BaseType: Instance +Properties: + - Name: PositionOffset + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The offset of the UI element in pixels. + - Name: PositionRelative + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The position of the UI element relative to its parent. + - Name: Rotation + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The rotation of the UI element in degrees. + - Name: SizeOffset + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The size offset of the UI element in pixels. + - Name: SizeRelative + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The size of the UI element relative to its parent. + - Name: ClipDescendants + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the UI element clips its descendants. + - Name: PivotPoint + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The pivot point of the UI element. + - Name: Scale + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The scale of the UI element. + - Name: Visible + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the UI element is visible. + - Name: MaskMode + Type: MaskModeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the mask mode of the UI element. + - Name: AbsoluteSize + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The absolute size of the UI element in pixels. + - Name: IsVisibleInTree + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the UI element is visible in the UI hierarchy. +Methods: [] +Events: + - Name: MouseEnter + Arguments: "" + Description: Fires when user's cursor hovers on this UI + - Name: MouseExit + Arguments: "" + Description: Fires when user's cursor leaves this UI + - Name: MouseDown + Arguments: "" + Description: Fires when user hold down mouse on this UI + - Name: MouseUp + Arguments: "" + Description: Fires when user release mouse on this UI + - Name: TransformChanged + Arguments: "" + Description: Fires when this UI transform has been changed + - Name: VisibilityChanged + Arguments: "" + Description: Fires when this UI visibility has been changed +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UIField is the abstract base class of all UI classes. diff --git a/yaml/types/UIHVLayout.yaml b/yaml/types/UIHVLayout.yaml new file mode 100644 index 0000000..31d2858 --- /dev/null +++ b/yaml/types/UIHVLayout.yaml @@ -0,0 +1,22 @@ +Name: UIHVLayout +BaseType: UIField +Properties: + - Name: Spacing + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The spacing between child elements in the layout. + - Name: ChildAlignment + Type: UILayoutAlignmentEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the alignment of child elements within the layout. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: UIHVLayout is an abstract class that provides horizontal and + vertical layout functionality for UI elements. diff --git a/yaml/types/UIHorizontalLayout.yaml b/yaml/types/UIHorizontalLayout.yaml new file mode 100644 index 0000000..d471ad2 --- /dev/null +++ b/yaml/types/UIHorizontalLayout.yaml @@ -0,0 +1,9 @@ +Name: UIHorizontalLayout +BaseType: UIHVLayout +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UIHorizontalLayout is a class that aligns all of its children horizontally. diff --git a/yaml/types/UIImage.yaml b/yaml/types/UIImage.yaml new file mode 100644 index 0000000..db36d08 --- /dev/null +++ b/yaml/types/UIImage.yaml @@ -0,0 +1,33 @@ +Name: UIImage +BaseType: UIField +Properties: + - Name: Image + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The image asset used for the image. + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color applied to the image. + - Name: StretchMode + Type: ImageStretchModeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines how the image is stretched within the view. + - Name: Loading + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Indicates whether the image is currently loading. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UIImage is a class that can be used to display images. diff --git a/yaml/types/UILabel.yaml b/yaml/types/UILabel.yaml new file mode 100644 index 0000000..ea0aed1 --- /dev/null +++ b/yaml/types/UILabel.yaml @@ -0,0 +1,63 @@ +Name: UILabel +BaseType: UIView +Properties: + - Name: Text + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The text of the label. + - Name: TextColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the text. + - Name: OutlineWidth + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The width of the text outline. + - Name: OutlineColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the text outline. + - Name: HorizontalAlignment + Type: TextHorizontalAlignmentEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the horizontal alignment of the text. + - Name: VerticalAlignment + Type: TextVerticalAlignmentEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the vertical alignment of the text. + - Name: FontSize + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The font size of the text. + - Name: UseRichText + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the text uses rich text formatting. + - Name: FontAsset + Type: FontAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The font asset used for the text. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UILabel is a class that can be used to display text. diff --git a/yaml/types/UIScrollView.yaml b/yaml/types/UIScrollView.yaml new file mode 100644 index 0000000..de66025 --- /dev/null +++ b/yaml/types/UIScrollView.yaml @@ -0,0 +1,21 @@ +Name: UIScrollView +BaseType: UIField +Properties: + - Name: HorizontalScrollMode + Type: ScrollModeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the horizontal scroll mode of the scroll view. + - Name: VerticalScrollMode + Type: ScrollModeEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the vertical scroll mode of the scroll view. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UIScrollView is a class that allows the user to scroll content within a view. diff --git a/yaml/types/UITextInput.yaml b/yaml/types/UITextInput.yaml new file mode 100644 index 0000000..31faa0a --- /dev/null +++ b/yaml/types/UITextInput.yaml @@ -0,0 +1,86 @@ +Name: UITextInput +BaseType: UIView +Properties: + - Name: Text + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The text of the label. + - Name: TextColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the text. + - Name: JustifyText + Type: TextHorizontalAlignmentEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines how text is justified. + - Name: FontSize + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The font size of the label. + - Name: IsMultiline + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the text input supports multiple lines. + - Name: Placeholder + Type: string + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The placeholder text displayed when the input is empty. + - Name: PlaceholderColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the placeholder text. + - Name: ReadonlyColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The color of the text when the input is read-only. + - Name: IsReadOnly + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines whether the text input is read-only. + - Name: FontAsset + Type: FontAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The font asset used for the text. +Methods: + - Name: Focus + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Forces the local player to focus on the text input. +Events: + - Name: Submitted + Arguments: + Name: text + Type: string + Description: Fires when user submitted the text + - Name: Changed + Arguments: + Name: text + Type: string + Description: Fires when user changed the text +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UITextInput is a class that allows the user to enter text. diff --git a/yaml/types/UIVerticalLayout.yaml b/yaml/types/UIVerticalLayout.yaml new file mode 100644 index 0000000..0c143bb --- /dev/null +++ b/yaml/types/UIVerticalLayout.yaml @@ -0,0 +1,9 @@ +Name: UIVerticalLayout +BaseType: UIHVLayout +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UIVerticalLayout is a class that aligns all of its children vertically. diff --git a/yaml/types/UIView.yaml b/yaml/types/UIView.yaml new file mode 100644 index 0000000..60becc8 --- /dev/null +++ b/yaml/types/UIView.yaml @@ -0,0 +1,33 @@ +Name: UIView +BaseType: UIField +Properties: + - Name: BorderColor + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the border color of the UI. + - Name: Color + Type: Color + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the color of the UI. + - Name: BorderWidth + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the width of the border of the UI. + - Name: CornerRadius + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the corner radius of the UI. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: UIView is a class that displays a rectangle in your place's UI. diff --git a/yaml/types/UIViewport.yaml b/yaml/types/UIViewport.yaml new file mode 100644 index 0000000..db668cf --- /dev/null +++ b/yaml/types/UIViewport.yaml @@ -0,0 +1,9 @@ +Name: UIViewport +BaseType: UIField +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Missing Documentation diff --git a/yaml/types/ValueBase.yaml b/yaml/types/ValueBase.yaml new file mode 100644 index 0000000..63f683e --- /dev/null +++ b/yaml/types/ValueBase.yaml @@ -0,0 +1,12 @@ +Name: ValueBase +BaseType: Instance +Properties: [] +Methods: [] +Events: + - Name: Changed + Arguments: "" + Description: Fires when value has been changed +IsStatic: false +IsAbstract: true +IsInstantiatable: false +Description: ValueBase is an abstract base class for objects that hold a value. diff --git a/yaml/types/Vector2.yaml b/yaml/types/Vector2.yaml new file mode 100644 index 0000000..1c8b9e8 --- /dev/null +++ b/yaml/types/Vector2.yaml @@ -0,0 +1,297 @@ +Name: Vector2 +BaseType: null +Properties: + - Name: X + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The X component of the vector. + - Name: Y + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The Y component of the vector. + - Name: Down + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector2.New(0, -1). + - Name: Left + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector2.New(-1, 0). + - Name: One + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector2.New(1, 1). + - Name: Zero + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector2.New(0, 0). + - Name: Right + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector2.New(1, 0). + - Name: Up + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector2.New(0, 1). + - Name: Magnitude + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The length of the vector. + - Name: Normalized + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The normalized version of the vector. + - Name: SqrMagnitude + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The squared length of the vector. +Methods: + - Name: New + ReturnType: Vector2 + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector2 with the given x and y components. + - Name: New + ReturnType: Vector2 + Parameters: + - Name: d + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector2 with the given x and y components. + - Name: New + ReturnType: Vector2 + Parameters: + - Name: x + Type: number + IsOptional: false + DefaultValue: "" + - Name: y + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector2 with the given x and y components. + - Name: Angle + ReturnType: number + Parameters: + - Name: from + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: to + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the angle in degrees between from and to. + - Name: Cross + ReturnType: Vector2 + Parameters: + - Name: lhs + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: rhs + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the cross product of lhs and rhs. + - Name: Distance + ReturnType: number + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the distance between a and b. + - Name: Dot + ReturnType: number + Parameters: + - Name: lhs + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: rhs + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the dot product of lhs and rhs. + - Name: Lerp + ReturnType: Vector2 + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new vector that is the linear interpolation between a and b by t. + - Name: Max + ReturnType: Vector2 + Parameters: + - Name: lhs + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: rhs + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a vector that is made from the largest components of two vectors. + - Name: Min + ReturnType: Vector2 + Parameters: + - Name: lhs + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: rhs + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a vector that is made from the smallest components of two vectors. + - Name: MoveTowards + ReturnType: Vector2 + Parameters: + - Name: current + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: target + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: maxDistanceDelta + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Calculate a position between the points specified by current and + target, moving no farther than the distance specified by maxDistanceDelta. + - Name: Normalize + ReturnType: Vector2 + Parameters: + - Name: value + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector2 that is the normalized version of the given vector. + - Name: Project + ReturnType: Vector2 + Parameters: + - Name: vector + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: onNormal + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the projection of a vector onto another vector. + - Name: Reflect + ReturnType: Vector2 + Parameters: + - Name: inDirection + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: inNormal + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the reflection of a vector off the plane defined by a normal. + - Name: Slerp + ReturnType: Vector2 + Parameters: + - Name: a + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector2 + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Spherically interpolates between two vectors. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Vector2 is a 2D vector with an x and y component. diff --git a/yaml/types/Vector2Value.yaml b/yaml/types/Vector2Value.yaml new file mode 100644 index 0000000..4bddb04 --- /dev/null +++ b/yaml/types/Vector2Value.yaml @@ -0,0 +1,15 @@ +Name: Vector2Value +BaseType: ValueBase +Properties: + - Name: Value + Type: Vector2 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The value of this object. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Vector2Value is an object that holds a Vector2 value. diff --git a/yaml/types/Vector3.yaml b/yaml/types/Vector3.yaml new file mode 100644 index 0000000..453a96f --- /dev/null +++ b/yaml/types/Vector3.yaml @@ -0,0 +1,370 @@ +Name: Vector3 +BaseType: null +Properties: + - Name: X + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The X component of the vector. + - Name: Y + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The Y component of the vector. + - Name: Z + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The Z component of the vector. + - Name: Forward + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector3.New(0, 0, -1). + - Name: Back + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector3.New(0, 0, 1). + - Name: Down + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector3.New(0, -1, 0). + - Name: Left + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector3.New(-1, 0, 0). + - Name: One + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector3.New(1, 1, 1). + - Name: Zero + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector3.New(0, 0, 0). + - Name: Right + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector3.New(1, 0, 0). + - Name: Up + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: Shorthand for Vector3.New(0, 1, 0). + - Name: Magnitude + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The length of the vector. + - Name: Normalized + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The normalized version of the vector. + - Name: SqrMagnitude + Type: number + IsAccessibleByScripts: true + IsReadOnly: true + IsObsolete: false + Description: The squared length of the vector. +Methods: + - Name: New + ReturnType: Vector3 + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector3 with the given Vector2 components and a z + component of 0. + - Name: New + ReturnType: Vector3 + Parameters: + - Name: d + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector3 with the given Vector2 components and a z + component of 0. + - Name: New + ReturnType: Vector3 + Parameters: + - Name: x + Type: number + IsOptional: false + DefaultValue: "" + - Name: y + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector3 with the given Vector2 components and a z + component of 0. + - Name: New + ReturnType: Vector3 + Parameters: + - Name: x + Type: number + IsOptional: false + DefaultValue: "" + - Name: y + Type: number + IsOptional: false + DefaultValue: "" + - Name: z + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector3 with the given Vector2 components and a z + component of 0. + - Name: New + ReturnType: Vector3 + Parameters: + - Name: v + Type: Vector2 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector3 with the given Vector2 components and a z + component of 0. + - Name: Angle + ReturnType: number + Parameters: + - Name: from + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: to + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the angle in degrees between from and to. + - Name: Cross + ReturnType: Vector3 + Parameters: + - Name: lhs + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: rhs + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the cross product of lhs and rhs. + - Name: Distance + ReturnType: number + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the distance between a and b. + - Name: Dot + ReturnType: number + Parameters: + - Name: lhs + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: rhs + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the dot product of lhs and rhs. + - Name: Lerp + ReturnType: Vector3 + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector3 that is the linear interpolation between a + and b by t. + - Name: Max + ReturnType: Vector3 + Parameters: + - Name: lhs + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: rhs + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a vector that is made from the largest components of two vectors. + - Name: Min + ReturnType: Vector3 + Parameters: + - Name: lhs + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: rhs + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a vector that is made from the smallest components of two vectors. + - Name: MoveTowards + ReturnType: Vector3 + Parameters: + - Name: current + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: target + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: maxDistanceDelta + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Calculate a position between the points specified by current and + target, moving no farther than the distance specified by maxDistanceDelta. + - Name: Normalize + ReturnType: Vector3 + Parameters: + - Name: value + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns a new Vector3 that is the normalized version of the given vector. + - Name: Project + ReturnType: Vector3 + Parameters: + - Name: vector + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: onNormal + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the projection of a vector onto another vector. + - Name: Reflect + ReturnType: Vector3 + Parameters: + - Name: inDirection + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: inNormal + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the reflection of a vector off the plane defined by a normal. + - Name: SignedAngle + ReturnType: number + Parameters: + - Name: from + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: to + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: axis + Type: Vector3 + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Returns the signed angle in degrees between from and to. + - Name: Slerp + ReturnType: Vector3 + Parameters: + - Name: a + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: b + Type: Vector3 + IsOptional: false + DefaultValue: "" + - Name: t + Type: number + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: true + Description: Spherically interpolates between two vectors. +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: false +Description: Vector3 is a 3D vector with an x, y and z component. diff --git a/yaml/types/Vector3Value.yaml b/yaml/types/Vector3Value.yaml new file mode 100644 index 0000000..f702042 --- /dev/null +++ b/yaml/types/Vector3Value.yaml @@ -0,0 +1,15 @@ +Name: Vector3Value +BaseType: ValueBase +Properties: + - Name: Value + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: The value of this object. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Vector3Value is an object that holds a Vector3 value. diff --git a/yaml/types/Vehicle.yaml b/yaml/types/Vehicle.yaml new file mode 100644 index 0000000..5decd1f --- /dev/null +++ b/yaml/types/Vehicle.yaml @@ -0,0 +1,45 @@ +Name: Vehicle +BaseType: PhysicalModel +Properties: + - Name: MaxSpeed + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the forward force limit in kg/s. + - Name: SteerLimit + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the steering limit in degrees. + - Name: Force + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the forward force in kg/s. + - Name: Brake + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the break amount in kg/s. + - Name: Steering + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the steering angle in degrees + - Name: Driver + Type: Player + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the current driver of this vehicle. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: Vehicle class represents a vehicle that can be driven by a player diff --git a/yaml/types/VehicleSeat.yaml b/yaml/types/VehicleSeat.yaml new file mode 100644 index 0000000..0b4e21b --- /dev/null +++ b/yaml/types/VehicleSeat.yaml @@ -0,0 +1,9 @@ +Name: VehicleSeat +BaseType: Seat +Properties: [] +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: A seat for Vehicle diff --git a/yaml/types/VehicleWheel.yaml b/yaml/types/VehicleWheel.yaml new file mode 100644 index 0000000..ab0fcfd --- /dev/null +++ b/yaml/types/VehicleWheel.yaml @@ -0,0 +1,27 @@ +Name: VehicleWheel +BaseType: Dynamic +Properties: + - Name: UseForTraction + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if this wheel should be used for traction. + - Name: UseForSteering + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines if this wheel should be used for steering. + - Name: Radius + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + Description: Determines the radius for this wheel. +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +Description: A wheel for the vehicle