{"id":"raphtalia/robloxapi","name":"robloxapi","scope":"raphtalia","platform":"roblox","description":"Parser for Roblox API dumps","version":"1.0.0","latest":"1.0.0","versions":["1.0.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"79c8baca7bd2323f3619b7fde75bf58d8327c10e16a0ac25d41705e2586fee2f","likes":0,"downloads":0,"install":"forest install raphtalia/robloxapi","url":"https://forest.dev/p/roblox/raphtalia/robloxapi","files":"https://api.forest.dev/ai/package/roblox/raphtalia/robloxapi/files","readme":"# RobloxAPI\n\nLibrary for parsing MaximumADHD's [Roblox-Client-Tracker](https://github.com/MaximumADHD/Roblox-Client-Tracker) API\ndumps.\n\n## Example\n\n```lua\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\nlocal RobloxAPI = require(ReplicatedStorage.RobloxAPI)\nlocal API = RobloxAPI()\n\nlocal classes = API:GetClasses()\nprint(classes.BasePart)\nprint(API:GetClass(\"BasePart\")) -- Identical to above\n\n--[[\n    These will include deprecated members but will exclude members not\n    accessible by the current script identity.\n]]\nprint(API:GetProperties(workspace))\nprint(API:GetFunctions(workspace))\nprint(API:GetEvents(workspace))\n\n-- To get members not accessible by the current script identity\nprint(API:GetClass(\"BasePart\"):GetProperties())\nprint(API:GetClass(\"BasePart\"):GetFunctions())\nprint(API:GetClass(\"BasePart\"):GetEvents())\n```\n\n## Members\n\n```lua\n-- All members have the following properties & methods\nlocal member = API:GetClass(\"Instance\"):GetProperties().Name\nprint(member.Name) --> \"Name\"\nprint(member.MemberType) --> \"Property\"\nprint(member.ThreadSafety) --> \"ReadSafe\"\n\nprint(member:IsA(\"Property\")) --> true\nprint(member:GetTags()) --> string[]\nprint(member:HasTag(\"Deprecated\")) --> false\n\n-- Short-hand methods for HasTag()\nprint(member:IsDeprecated()) --> false\nprint(member:IsReadOnly()) --> false\nprint(member:IsReplicated()) --> true\nprint(member:IsScriptable()) --> true\n\nprint(member:GetReadSecurity()) --> \"None\"\nprint(member:GetWriteSecurity()) --> \"None\"\n```\n\n## Property members\n\n```lua\nlocal member = API:GetClass(\"Instance\"):GetProperties().Name\nprint(member:GetValueType()) --> { Category: string, Name: string }\nprint(member:GetCategory()) --> String\nprint(member:CanLoad()) --> true\nprint(member:CanSave()) --> true\n```\n\n## Function members\n\n```lua\nlocal member = API:GetClass(\"Instance\"):GetFunctions().Destroy\nprint(member:Yields()) --> false\nprint(member:GetParameters()) --> { Category: string, Name: string }[]\nprint(member:GetReturnType()) --> { Category: string, Name: string }\n```\n\n## Event members\n\n```lua\nlocal member = API:GetClass(\"Instance\"):GetFunctions().Changed\nprint(member:GetParameters()) --> { Category: string, Name: string }[]\n```\n","readmeTruncated":false}