diff --git a/autogen/mdgen.js b/autogen/mdgen.js index f6ba0ac..783a004 100644 --- a/autogen/mdgen.js +++ b/autogen/mdgen.js @@ -145,7 +145,7 @@ for (const yamlFile of yamlFiles) { fs.writeFileSync(mdPath, mk) } -console.log(`Converted ${yamlFiles.length} XML files to Markdown`) +console.log(`Converted ${yamlFiles.length} YAML files to Markdown`) // Process Enums const yamlEnumFiles = fs.readdirSync(yamlEnumPath).filter(file => file.endsWith('.yaml')); @@ -191,4 +191,4 @@ for (const yamlFile of yamlEnumFiles) { fs.writeFileSync(mdPath, mk) } -console.log(`Converted ${yamlEnumFiles.length} enum XML files to Markdown`) \ No newline at end of file +console.log(`Converted ${yamlEnumFiles.length} enum YAML files to Markdown`) \ No newline at end of file diff --git a/autogen/yamlgen.js b/autogen/yamlgen.js index 037bc50..c9ba423 100644 --- a/autogen/yamlgen.js +++ b/autogen/yamlgen.js @@ -32,8 +32,8 @@ for (const c of data.Classes) { let existingClassDescription = "Missing Documentation"; if (fs.existsSync(yamlPath)) { - const existingXml = fs.readFileSync(yamlPath, "utf-8"); - const existingData = yaml.parse(existingXml); + const existingYaml = fs.readFileSync(yamlPath, "utf-8"); + const existingData = yaml.parse(existingYaml); // Preserve existing class description if (existingData.Description) { @@ -117,8 +117,8 @@ for (const e of data.Enums) { let existingDescriptions = {}; let existingEnumDescription = ""; if (fs.existsSync(yamlPath)) { - const existingXml = fs.readFileSync(yamlPath, "utf-8"); - const existingData = yaml.parse(existingXml); + const existingYaml = fs.readFileSync(yamlPath, "utf-8"); + const existingData = yaml.parse(existingYaml); existingEnumDescription = existingData.Description || ""; diff --git a/yaml/enums/ParticleEmissionShape.yaml b/yaml/enums/ParticleEmissionShape.yaml new file mode 100644 index 0000000..6999324 --- /dev/null +++ b/yaml/enums/ParticleEmissionShape.yaml @@ -0,0 +1,14 @@ +Name: ParticleEmissionShape +InternalName: ParticleEmissionShapeEnum +Options: + - Name: Point + Description: "" + - Name: Sphere + Description: "" + - Name: SphereSurface + Description: "" + - Name: Box + Description: "" + - Name: Ring + Description: "" +Description: "" diff --git a/yaml/enums/ParticleSimulationSpace.yaml b/yaml/enums/ParticleSimulationSpace.yaml new file mode 100644 index 0000000..c7d3028 --- /dev/null +++ b/yaml/enums/ParticleSimulationSpace.yaml @@ -0,0 +1,8 @@ +Name: ParticleSimulationSpace +InternalName: ParticleSimulationSpaceEnum +Options: + - Name: Local + Description: "" + - Name: World + Description: "" +Description: "" diff --git a/yaml/types/ChatService.yaml b/yaml/types/ChatService.yaml index 3de60d9..2df21ad 100644 --- a/yaml/types/ChatService.yaml +++ b/yaml/types/ChatService.yaml @@ -1,6 +1,13 @@ Name: ChatService BaseType: Instance -Properties: [] +Properties: + - Name: ChatPredicate + Type: function + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation Methods: - Name: BroadcastMessage ReturnType: nil @@ -42,6 +49,9 @@ Events: Type: string Description: Fires when new message has been received from either `BroadcastMessage` or `UnicastMessage` + - Name: MessageDeclined + Arguments: "" + Description: Missing Documentation IsStatic: true IsAbstract: false IsInstantiatable: false diff --git a/yaml/types/ColorSeries.yaml b/yaml/types/ColorSeries.yaml index 29d5216..d901074 100644 --- a/yaml/types/ColorSeries.yaml +++ b/yaml/types/ColorSeries.yaml @@ -64,6 +64,20 @@ Methods: IsObsolete: false IsStatic: false Description: Removes the point at the specified index from the color series. + - Name: GetOffsets + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: GetColors + ReturnType: table + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: SetOffset ReturnType: nil Parameters: @@ -101,6 +115,21 @@ Methods: IsObsolete: false IsStatic: false Description: Gets the offset at the specified point in the color series. + - Name: AddPoint + ReturnType: number + Parameters: + - Name: offset + Type: number + IsOptional: false + DefaultValue: "" + - Name: color + Type: Color + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: Lerp ReturnType: Color Parameters: diff --git a/yaml/types/Dynamic.yaml b/yaml/types/Dynamic.yaml index a13e1c3..3725f76 100644 --- a/yaml/types/Dynamic.yaml +++ b/yaml/types/Dynamic.yaml @@ -153,72 +153,6 @@ Methods: IsObsolete: false IsStatic: false Description: Rotates the object by the specified Euler angles. - - Name: InverseTransformPoint - ReturnType: Vector3 - Parameters: - - Name: point - Type: Vector3 - IsOptional: false - DefaultValue: "" - IsAsync: false - IsObsolete: false - IsStatic: false - Description: Transforms a point from world space to local space. - - Name: TransformPoint - ReturnType: Vector3 - Parameters: - - Name: point - Type: Vector3 - IsOptional: false - DefaultValue: "" - IsAsync: false - IsObsolete: false - IsStatic: false - Description: Transforms a point from local space to world space. - - Name: InverseTransformDirection - ReturnType: Vector3 - Parameters: - - Name: direction - Type: Vector3 - IsOptional: false - DefaultValue: "" - IsAsync: false - IsObsolete: false - IsStatic: false - Description: Transforms a direction from world space to local space. - - Name: TransformDirection - ReturnType: Vector3 - Parameters: - - Name: direction - Type: Vector3 - IsOptional: false - DefaultValue: "" - IsAsync: false - IsObsolete: false - IsStatic: false - Description: Transforms a direction from local space to world space. - - Name: InverseTransformVector - ReturnType: Vector3 - Parameters: - - Name: vector - Type: Vector3 - IsOptional: false - DefaultValue: "" - IsAsync: false - IsObsolete: false - IsStatic: false - Description: Transforms a vector from world space to local space. - - Name: InverseTransformPosition - ReturnType: Vector3 - Parameters: - - Name: position - Type: Vector3 - IsOptional: false - DefaultValue: "" - IsAsync: false - IsObsolete: false - IsStatic: false - Description: Transforms a position from world space to local space. - Name: GetBounds ReturnType: Bounds Parameters: [] diff --git a/yaml/types/ImageSky.yaml b/yaml/types/ImageSky.yaml new file mode 100644 index 0000000..f622afd --- /dev/null +++ b/yaml/types/ImageSky.yaml @@ -0,0 +1,52 @@ +Name: ImageSky +BaseType: Sky +Properties: + - Name: TopImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: BottomImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: LeftImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: RightImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: FrontImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: BackImage + Type: ImageAsset + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation +Methods: [] +Events: [] +IsStatic: false +IsAbstract: false +IsInstantiatable: true +StaticAlias: null +Description: Missing Documentation diff --git a/yaml/types/Instance.yaml b/yaml/types/Instance.yaml index bafd454..6242d95 100644 --- a/yaml/types/Instance.yaml +++ b/yaml/types/Instance.yaml @@ -68,6 +68,28 @@ Methods: IsObsolete: false IsStatic: false Description: Finds a child of this instance by class name. + - Name: FindChildWithTag + ReturnType: Instance + Parameters: + - Name: tag + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: GetChildrenWithTag + ReturnType: table + Parameters: + - Name: tag + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: FindAncestorByClass ReturnType: Instance Parameters: diff --git a/yaml/types/NPC.yaml b/yaml/types/NPC.yaml index 70b6950..3ded816 100644 --- a/yaml/types/NPC.yaml +++ b/yaml/types/NPC.yaml @@ -50,6 +50,13 @@ Properties: IsObsolete: false IsStatic: false Description: Determines the offset position of the NPC's nametag. + - Name: NametagVisibleRadius + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: DisplayName Type: string IsAccessibleByScripts: true diff --git a/yaml/types/NetworkEvent.yaml b/yaml/types/NetworkEvent.yaml index 151e185..bb8d623 100644 --- a/yaml/types/NetworkEvent.yaml +++ b/yaml/types/NetworkEvent.yaml @@ -62,8 +62,6 @@ Events: Description: Fires when server receives message from client - Name: InvokedClient Arguments: - - Name: sender - Type: nil - Name: msg Type: NetMessage Description: Fires when client receives message from server diff --git a/yaml/types/Particles.yaml b/yaml/types/Particles.yaml index 9d2fefb..90b7ffe 100644 --- a/yaml/types/Particles.yaml +++ b/yaml/types/Particles.yaml @@ -1,9 +1,16 @@ Name: Particles BaseType: Dynamic Properties: + - Name: Playing + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: Image Type: ImageAsset - IsAccessibleByScripts: false + IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false @@ -30,12 +37,54 @@ Properties: IsStatic: false Description: Determines the number of particles emitted. - Name: Gravity - Type: number + Type: Vector3 IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false Description: Determines the gravity effect applied to the particles. + - Name: VelocityDirection + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: InitialVelocity + Type: NumberRange + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Spread + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Flatness + Type: number + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Scale + Type: NumberRange + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: HueVariation + Type: NumberRange + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: Shaded Type: boolean IsAccessibleByScripts: true @@ -43,13 +92,27 @@ Properties: IsObsolete: false IsStatic: false Description: Determines whether the particles are shaded. - - Name: Autoplay - Type: boolean + - Name: EmissionShape + Type: ParticleEmissionShapeEnum IsAccessibleByScripts: true IsReadOnly: false IsObsolete: false IsStatic: false - Description: Determines whether the particle system plays automatically. + Description: Missing Documentation + - Name: EmissionShapeScale + Type: Vector3 + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: SimulationSpace + Type: ParticleSimulationSpaceEnum + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation Methods: - Name: Play ReturnType: nil diff --git a/yaml/types/Physical.yaml b/yaml/types/Physical.yaml index ed9cc12..2a305a4 100644 --- a/yaml/types/Physical.yaml +++ b/yaml/types/Physical.yaml @@ -15,6 +15,13 @@ Properties: IsObsolete: false IsStatic: false Description: Determines whether this object can collide with other objects. + - Name: CanTouch + Type: boolean + IsAccessibleByScripts: true + IsReadOnly: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: Velocity Type: Vector3 IsAccessibleByScripts: true diff --git a/yaml/types/PolytorianModel.yaml b/yaml/types/PolytorianModel.yaml index 831aa27..9264510 100644 --- a/yaml/types/PolytorianModel.yaml +++ b/yaml/types/PolytorianModel.yaml @@ -131,6 +131,10 @@ Methods: Type: number IsOptional: false DefaultValue: "" + - Name: loadTool + Type: boolean + IsOptional: true + DefaultValue: "True" IsAsync: false IsObsolete: false IsStatic: false diff --git a/yaml/types/ScriptSharedTable.yaml b/yaml/types/ScriptSharedTable.yaml index aa1b639..4ac3d7b 100644 --- a/yaml/types/ScriptSharedTable.yaml +++ b/yaml/types/ScriptSharedTable.yaml @@ -2,6 +2,46 @@ Name: ScriptSharedTable BaseType: null Properties: [] Methods: + - Name: Clear + ReturnType: nil + Parameters: [] + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: Remove + ReturnType: nil + Parameters: + - Name: key + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: ClearPrefix + ReturnType: nil + Parameters: + - Name: prefix + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation + - Name: ClearSuffix + ReturnType: nil + Parameters: + - Name: suffix + Type: string + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: __index ReturnType: any Parameters: diff --git a/yaml/types/SocialService.yaml b/yaml/types/SocialService.yaml new file mode 100644 index 0000000..6fea0c7 --- /dev/null +++ b/yaml/types/SocialService.yaml @@ -0,0 +1,10 @@ +Name: SocialService +BaseType: Instance +Properties: [] +Methods: [] +Events: [] +IsStatic: true +IsAbstract: false +IsInstantiatable: false +StaticAlias: Social +Description: Missing Documentation diff --git a/yaml/types/TweenObject.yaml b/yaml/types/TweenObject.yaml index 504beea..6a9429d 100644 --- a/yaml/types/TweenObject.yaml +++ b/yaml/types/TweenObject.yaml @@ -210,6 +210,29 @@ Methods: IsObsolete: false IsStatic: false Description: Tweens a Vector3 between two specified values. + - Name: TweenQuaternion + ReturnType: nil + Parameters: + - Name: from + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: to + Type: Quaternion + IsOptional: false + DefaultValue: "" + - Name: time + Type: number + IsOptional: false + DefaultValue: "" + - Name: callback + Type: function + IsOptional: false + DefaultValue: "" + IsAsync: false + IsObsolete: false + IsStatic: false + Description: Missing Documentation - Name: Play ReturnType: nil Parameters: [] diff --git a/yaml/types/UITextInput.yaml b/yaml/types/UITextInput.yaml index 2c996e8..476cc5b 100644 --- a/yaml/types/UITextInput.yaml +++ b/yaml/types/UITextInput.yaml @@ -90,6 +90,12 @@ Events: Name: text Type: string Description: Fires when user changed the text + - Name: FocusEnter + Arguments: "" + Description: Missing Documentation + - Name: FocusExit + Arguments: "" + Description: Missing Documentation IsStatic: false IsAbstract: false IsInstantiatable: true