api dump update

apiDump.json

@@ -1,7 +1,4 @@
-{
+[
-    "_generatedVersion": "DEBUG_BUILD 0.7.1",
-    "_generatedAt": "02/11/2019 18:33:38",
-    "classes": [
     {
         "methods": {
             "reloadShaders": []
@@ -135,8 +132,9 @@
     },
     {
         "methods": {
-                "rayTestScreenAllHits": [],
+            "getContacts": [],
             "resume": [],
+            "rayTestScreenAllHits": [],
             "rayTestAllHits": [],
             "pause": [],
             "rayTestClosest": [],
@@ -147,6 +145,10 @@
         "subclasses": [],
         "class": "physics",
         "properties": {
+            "running": {
+                "defaultType": "boolean",
+                "writable": false
+            },
             "className": {
                 "defaultType": "string",
                 "writable": false
@@ -155,8 +157,8 @@
                 "defaultType": "string",
                 "writable": false
             },
-                "running": {
+            "gravity": {
-                    "defaultType": "boolean",
+                "defaultType": "vector3",
                 "writable": false
             }
         }
@@ -186,8 +188,9 @@
     },
     {
         "methods": {
-                "urlEncode": [],
             "post": [],
+            "request": [],
+            "urlEncode": [],
             "urlDecode": [],
             "get": []
         },
@@ -290,29 +293,30 @@
         "subclasses": [],
         "class": "luaFolder",
         "properties": {
+            "className": {
+                "defaultType": "string",
+                "writable": false
+            },
             "name": {
                 "defaultType": "string",
                 "writable": false
             },
-                "className": {
+            "disableDefaultLoaders": {
-                    "defaultType": "string",
+                "defaultType": "boolean",
-                    "writable": false
+                "writable": "boolean"
             }
         }
     },
     {
         "methods": {
+            "run": [],
             "editExternal": []
         },
         "derivedFrom": "baseClass",
         "events": [],
         "subclasses": [],
-            "class": "scriptSource",
+        "class": "script",
         "properties": {
-                "containers": {
-                    "defaultType": "table",
-                    "writable": false
-                },
             "className": {
                 "defaultType": "string",
                 "writable": false
@@ -324,30 +328,13 @@
             "id": {
                 "defaultType": "number",
                 "writable": false
-                }
-            }
             },
-        {
-            "methods": [],
-            "derivedFrom": "baseClass",
-            "events": [],
-            "subclasses": [],
-            "class": "scriptContainer",
-            "properties": {
             "autoRun": {
                 "defaultType": "boolean",
                 "writable": "boolean"
             },
-                "scriptType": {
+            "ran": {
-                    "defaultType": "number",
-                    "writable": "number"
-                },
-                "source": {
                 "defaultType": "boolean",
-                    "writable": "scriptSource"
-                },
-                "className": {
-                    "defaultType": "string",
                 "writable": false
             }
         }
@@ -464,17 +451,9 @@
         "subclasses": [],
         "class": "block",
         "properties": {
-                "velocity": {
+            "renderQueue": {
-                    "defaultType": "vector3",
+                "defaultType": "number",
-                    "writable": "vector3"
+                "writable": "number"
-                },
-                "rotation": {
-                    "defaultType": "quaternion",
-                    "writable": "quaternion"
-                },
-                "emissiveColour": {
-                    "defaultType": "colour",
-                    "writable": "colour"
             },
             "linearFactor": {
                 "desc": "Restricts the linear movement in the physics engine. A value of (1,1,1) allows the object to move in all directions whereas (0,1,0) means the object can only move up and down on the y axis.",
@@ -490,12 +469,11 @@
                 "defaultType": "number",
                 "writable": "number"
             },
-                "mesh": {
+            "linearDamping": {
-                    "desc": "The file that teverse will use to load a 3d model, using [[resource locators]].",
+                "defaultType": "number",
-                    "defaultType": "string",
+                "writable": "number"
-                    "writable": "string"
             },
-                "renderQueue": {
+            "metalness": {
                 "defaultType": "number",
                 "writable": "number"
             },
@@ -503,29 +481,30 @@
                 "defaultType": "number",
                 "writable": "number"
             },
-                "spinningFriction": {
+            "size": {
-                    "defaultType": "number",
+                "defaultType": "vector3",
-                    "writable": "number"
+                "writable": "vector3"
             },
             "workshopLocked": {
                 "desc": "Solely used in workshop",
                 "defaultType": "boolean",
                 "writable": "boolean"
             },
-                "size": {
-                    "defaultType": "vector3",
-                    "writable": "vector3"
-                },
             "meshScale": {
                 "desc": "This is the value Teverse has had to scale the loaded mesh down in order to fit it in a 1x1x1 bounding box",
                 "defaultType": "vector3",
                 "writable": false
             },
+            "mesh": {
+                "desc": "The file that teverse will use to load a 3d model, using [[resource locators]].",
+                "defaultType": "string",
+                "writable": "string"
+            },
             "roughness": {
                 "defaultType": "number",
                 "writable": "number"
             },
-                "linearDamping": {
+            "emissiveness": {
                 "defaultType": "number",
                 "writable": "number"
             },
@@ -534,39 +513,39 @@
                 "defaultType": "vector3",
                 "writable": "vector3"
             },
-                "networkedId": {
-                    "defaultType": "number",
-                    "writable": false
-                },
             "physics": {
                 "desc": "When true, things like raycasting may not work correctly for this object",
                 "defaultType": "boolean",
                 "writable": "boolean"
             },
+            "colour": {
+                "defaultType": "colour",
+                "writable": "colour"
+            },
             "angularFactor": {
                 "defaultType": "vector3",
                 "writable": "vector3"
             },
-                "metalness": {
+            "networkedId": {
                 "defaultType": "number",
-                    "writable": "number"
+                "writable": false
             },
             "static": {
                 "desc": "When true, this object will not move as it will become unaffected by forces including gravity.",
                 "defaultType": "boolean",
                 "writable": "boolean"
             },
-                "rollingFriction": {
+            "linearVelocity": {
-                    "defaultType": "number",
+                "defaultType": "vector3",
-                    "writable": "number"
+                "writable": "vector3"
             },
             "className": {
                 "defaultType": "string",
                 "writable": false
             },
-                "colour": {
+            "rotation": {
-                    "defaultType": "colour",
+                "defaultType": "quaternion",
-                    "writable": "colour"
+                "writable": "quaternion"
             },
             "castsShadows": {
                 "defaultType": "boolean",
@@ -610,6 +589,7 @@
     },
     {
         "methods": {
+            "screenToWorld": [],
             "worldToScreen": {
                 "desc": "Converts a 3d cooridinate into screenspace. Returns a bool indicating if the point is infront of the camera, returns a vector2 with the screenspace coordinates,",
                 "returns": [
@@ -655,6 +635,83 @@
             }
         }
     },
+    {
+        "methods": {
+            "applyImpulse": [],
+            "applyTorque": [],
+            "applyForce": [],
+            "applyForceAtPosition": [],
+            "applyImpulseAtPosition": [],
+            "applyTorqueImpulse": []
+        },
+        "derivedFrom": "baseClass",
+        "events": {
+            "mouseLeftPressed": [],
+            "collisionStarted": [],
+            "mouseLeftReleased": [],
+            "mouseRightPressed": [],
+            "mouseRightReleased": [],
+            "collisionEnded": [],
+            "mouseMiddleReleased": [],
+            "mouseMiddlePressed": []
+        },
+        "subclasses": [],
+        "class": "compoundGroup",
+        "properties": {
+            "rotation": {
+                "defaultType": "quaternion",
+                "writable": "quaternion"
+            },
+            "position": {
+                "defaultType": "vector3",
+                "writable": "vector3"
+            },
+            "linearFactor": {
+                "defaultType": "vector3",
+                "writable": "vector3"
+            },
+            "linearVelocity": {
+                "defaultType": "vector3",
+                "writable": "vector3"
+            },
+            "friction": {
+                "defaultType": "number",
+                "writable": "number"
+            },
+            "className": {
+                "defaultType": "string",
+                "writable": false
+            },
+            "linearDamping": {
+                "defaultType": "number",
+                "writable": "number"
+            },
+            "static": {
+                "defaultType": "boolean",
+                "writable": "boolean"
+            },
+            "restitution": {
+                "defaultType": "number",
+                "writable": "number"
+            },
+            "angularDamping": {
+                "defaultType": "number",
+                "writable": "number"
+            },
+            "angularVelocity": {
+                "defaultType": "vector3",
+                "writable": "vector3"
+            },
+            "name": {
+                "defaultType": "string",
+                "writable": "string"
+            },
+            "angularFactor": {
+                "defaultType": "vector3",
+                "writable": "vector3"
+            }
+        }
+    },
     {
         "methods": {
             "lookAt": []
@@ -668,9 +725,9 @@
                 "defaultType": "quaternion",
                 "writable": "quaternion"
             },
-                "position": {
+            "shadowNearClip": {
-                    "defaultType": "vector3",
+                "defaultType": "number",
-                    "writable": "vector3"
+                "writable": "number"
             },
             "power": {
                 "defaultType": "number",
@@ -696,17 +753,17 @@
                 "defaultType": "string",
                 "writable": false
             },
-                "shadows": {
+            "position": {
-                    "defaultType": "boolean",
+                "defaultType": "vector3",
-                    "writable": "boolean"
+                "writable": "vector3"
             },
             "type": {
                 "defaultType": "number",
                 "writable": "number"
             },
-                "falloff": {
+            "shadows": {
-                    "defaultType": "number",
+                "defaultType": "boolean",
-                    "writable": "number"
+                "writable": "boolean"
             },
             "diffuseColour": {
                 "defaultType": "colour",
@@ -716,7 +773,7 @@
                 "defaultType": "number",
                 "writable": "number"
             },
-                "shadowNearClip": {
+            "falloff": {
                 "defaultType": "number",
                 "writable": "number"
             }
@@ -739,9 +796,9 @@
                 "defaultType": "quaternion",
                 "writable": "quaternion"
             },
-                "position": {
+            "size": {
-                    "defaultType": "vector3",
+                "defaultType": "number",
-                    "writable": "vector3"
+                "writable": "number"
             },
             "colour": {
                 "defaultType": "colour",
@@ -751,9 +808,34 @@
                 "defaultType": "string",
                 "writable": false
             },
-                "size": {
+            "position": {
-                    "defaultType": "number",
+                "defaultType": "vector3",
-                    "writable": "number"
+                "writable": "vector3"
+            }
+        }
+    },
+    {
+        "methods": [],
+        "derivedFrom": "baseClass",
+        "events": [],
+        "subclasses": [],
+        "class": "line",
+        "properties": {
+            "colour": {
+                "defaultType": "colour",
+                "writable": "colour"
+            },
+            "positionB": {
+                "defaultType": "vector3",
+                "writable": "vector3"
+            },
+            "className": {
+                "defaultType": "string",
+                "writable": false
+            },
+            "positionA": {
+                "defaultType": "vector3",
+                "writable": "vector3"
             }
         }
     },
@@ -884,9 +966,9 @@
                 "defaultType": "vector2",
                 "writable": "vector2"
             },
-                "scrollBarColour": {
+            "scrollBarWidth": {
-                    "defaultType": "colour",
+                "defaultType": "number",
-                    "writable": "colour"
+                "writable": "number"
             },
             "canvasSize": {
                 "defaultType": "guiCoord",
@@ -896,9 +978,9 @@
                 "defaultType": "string",
                 "writable": false
             },
-                "scrollBarWidth": {
+            "scrollBarColour": {
-                    "defaultType": "number",
+                "defaultType": "colour",
-                    "writable": "number"
+                "writable": "colour"
             }
         }
     },
@@ -1043,7 +1125,13 @@
     },
     {
         "methods": {
-                "bindSizeBreakpoint": []
+            "bindSizeBreakpoint": {
+                "desc": "",
+                "parameters": {
+                    "properties": "table",
+                    "breakpoint": "enums.sizeBreakpoint"
+                }
+            }
         },
         "derivedFrom": "baseClass",
         "events": {
@@ -1082,9 +1170,9 @@
                 "defaultType": "number",
                 "writable": "number"
             },
-                "borderWidth": {
+            "position": {
-                    "defaultType": "number",
+                "defaultType": "guiCoord",
-                    "writable": "number"
+                "writable": "guiCoord"
             },
             "visible": {
                 "defaultType": "boolean",
@@ -1114,9 +1202,9 @@
                 "defaultType": "string",
                 "writable": "string"
             },
-                "size": {
+            "borderRadius": {
-                    "defaultType": "guiCoord",
+                "defaultType": "number",
-                    "writable": "guiCoord"
+                "writable": "number"
             },
             "backgroundColour": {
                 "defaultType": "colour",
@@ -1126,13 +1214,13 @@
                 "defaultType": "number",
                 "writable": "number"
             },
-                "borderRadius": {
+            "size": {
-                    "defaultType": "number",
-                    "writable": "number"
-                },
-                "position": {
                 "defaultType": "guiCoord",
                 "writable": "guiCoord"
+            },
+            "borderWidth": {
+                "defaultType": "number",
+                "writable": "number"
             }
         }
     },
@@ -1162,22 +1250,25 @@
     },
     {
         "methods": {
+            "disconnectGame": [],
             "joinGame": [],
             "hasLocalTevGit": [],
-                "getMembersOfInstance": [],
+            "reloadCreate": [],
             "setTevGit": [],
-                "openFileDialogue": [],
+            "saveGame": [],
             "setSettings": [],
             "setSoundDebug": [],
-                "reloadCreate": [],
+            "openFileDialogue": [],
             "newGame": [],
             "remoteTestServer": [],
+            "reloadShaders": [],
             "clearGame": [],
             "apiDump": [],
-                "saveGameAsDialogue": [],
-                "reloadShaders": [],
             "getEventsOfObject": [],
-                "saveGame": [],
+            "isHomeRunning": [],
+            "saveGameAsDialogue": [],
+            "home": [],
+            "getMembersOfInstance": [],
             "loadString": [],
             "getMembersOfObject": [],
             "publishDialogue": [],
@@ -1222,7 +1313,7 @@
                 ]
             },
             "isContainer": {
-                    "desc": "",
+                "desc": "Returns true if this object can contain other objects.",
                 "returns": [
                     "boolean"
                 ]
@@ -1267,7 +1358,12 @@
                     "ancestor": "baseClass"
                 }
             },
-                "describe": [],
+            "describe": {
+                "desc": "",
+                "returns": [
+                    "string"
+                ]
+            },
             "clone": {
                 "desc": "Creates and returns a copy of this object",
                 "returns": [
@@ -1287,13 +1383,13 @@
             "childAdded": {
                 "desc": "Fired when a child is added",
                 "parameters": {
-                        "child": "baseClass"
+                    "child": "variant"
                 }
             },
             "childRemoved": {
                 "desc": "Fired when a child is removed",
                 "parameters": {
-                        "child": "baseClass"
+                    "child": "variant"
                 }
             },
             "destroying": {
@@ -1313,16 +1409,17 @@
             "folder",
             "assetsFolder",
             "luaFolder",
-                "scriptSource",
+            "script",
-                "scriptContainer",
             "luaClientFolder",
             "luaServerFolder",
             "luaSharedFolder",
             "block",
             "workspace",
             "camera",
+            "compoundGroup",
             "light",
             "grid",
+            "line",
             "audioEmitter",
             "sounds",
             "guiBase",
@@ -1346,8 +1443,9 @@
     },
     {
         "methods": {
-                "isAuthenticated": [],
+            "openUrl": [],
-                "construct": []
+            "construct": [],
+            "isAuthenticated": []
         },
         "derivedFrom": "baseClass",
         "events": [],
@@ -1370,44 +1468,44 @@
                 "defaultType": "guiFrameMultiColour",
                 "writable": false
             },
-                "scriptSource": {
+            "compoundGroup": {
-                    "defaultType": "scriptSource",
+                "defaultType": "compoundGroup",
                 "writable": false
             },
             "sounds": {
                 "defaultType": "sounds",
                 "writable": false
             },
-                "guiScrollView": {
+            "guiButton": {
-                    "defaultType": "guiScrollView",
+                "defaultType": "guiButton",
                 "writable": false
             },
             "block": {
                 "defaultType": "block",
                 "writable": false
             },
-                "http": {
+            "graphics": {
-                    "defaultType": "http",
+                "defaultType": "graphics",
                 "writable": false
             },
-                "workspace": {
+            "guiScrollView": {
-                    "defaultType": "workspace",
+                "defaultType": "guiScrollView",
                 "writable": false
             },
             "platform": {
                 "defaultType": "string",
                 "writable": false
             },
-                "tween": {
-                    "defaultType": "tween",
-                    "writable": false
-                },
             "guiFrame": {
                 "defaultType": "guiFrame",
                 "writable": false
             },
-                "scriptContainer": {
+            "script": {
-                    "defaultType": "scriptContainer",
+                "defaultType": "script",
+                "writable": false
+            },
+            "folder": {
+                "defaultType": "folder",
                 "writable": false
             },
             "assets": {
@@ -1422,8 +1520,8 @@
                 "defaultType": "physics",
                 "writable": false
             },
-                "graphics": {
+            "debug": {
-                    "defaultType": "graphics",
+                "defaultType": "debug",
                 "writable": false
             },
             "guiTextBox": {
@@ -1434,8 +1532,8 @@
                 "defaultType": "json",
                 "writable": false
             },
-                "debug": {
+            "workspace": {
-                    "defaultType": "debug",
+                "defaultType": "workspace",
                 "writable": false
             },
             "className": {
@@ -1454,19 +1552,18 @@
                 "defaultType": "interface",
                 "writable": false
             },
-                "guiButton": {
+            "tween": {
-                    "defaultType": "guiButton",
+                "defaultType": "tween",
                 "writable": false
             },
             "name": {
                 "defaultType": "string",
                 "writable": false
             },
-                "folder": {
+            "line": {
-                    "defaultType": "folder",
+                "defaultType": "line",
                 "writable": false
             }
         }
     }
-    ]
+]
-}

utilities/docs.lua

@@ -38,10 +38,9 @@ addDocs("baseClass", {
         getDescendants              = method("Returns a table of all descended objects", nil, {"table"}),
         destroy                     = method("Locks the object before removing it from the hierarchy. Children will also be destroyed."),
         destroyAllChildren          = method("Invokes the destroy method on each child of this instance."),
-        isContainer                 = method("", nil, {
+        isContainer                 = method("Returns true if this object can contain other objects.", nil, {
                                         "boolean"
                                      }),
-        clone                       = method(),
         isA                         = method("Returns true if this object is derived from the className given.", {
                                         className = "string"
                                       }, {
@@ -54,7 +53,8 @@ addDocs("baseClass", {
                                         ancestor = "baseClass"
                                     }, {"boolean"}),
         getFullName                 = method("Returns a string including ancestor names", nil, {"string"}),
-        clone                       = method("Creates and returns a copy of this object", nil, {"variant"})
+        clone                       = method("Creates and returns a copy of this object", nil, {"variant"}),
+        describe                    = method("", nil, {"string"})
     },
     
     events      = {
@@ -64,10 +64,10 @@ addDocs("baseClass", {
                                         oldValue     = "variant"
                                       }),
         childAdded                  = event("Fired when a child is added", {
-                                        child = "baseClass"
+                                        child = "variant"
                                     }),
         childRemoved                = event("Fired when a child is removed", {
-                                        child = "baseClass"
+                                        child = "variant"
                                     }),
         destroying                  = event("Fired just before an object is destroyed."),
     }
@@ -125,7 +125,6 @@ addDocs("block", {
     }
 })
 
-
 addDocs("camera", {
     description = "",
     properties  = {
@@ -141,4 +140,17 @@ addDocs("camera", {
     }
 })
 
+addDocs("guiBase", {
+    description = "",
+    properties  = {
+    
+    },
+    methods = {
+        bindSizeBreakpoint = method("", {
+            breakpoint = "enums.sizeBreakpoint",
+            properties = "table"
+        }),
+    }
+})
+
 return docs