tovector, toquaternion, touuid now accept nil (#66)

Author: tapple

generated/slua_default.d.luau

@@ -146,10 +146,10 @@ end
 
 
 declare function dangerouslyexecuterequiredmodule(f: (...any) -> ...any): ...any
-declare function touuid(val: string | buffer | uuid): uuid?
-declare function tovector(val: string | vector): vector?
-declare function toquaternion(val: string | quaternion): quaternion?
-declare function torotation(val: string | quaternion): quaternion?
+declare function touuid(val: string? | buffer | uuid): uuid?
+declare function tovector(val: string? | vector): vector?
+declare function toquaternion(val: string? | quaternion): quaternion?
+declare function torotation(val: string? | quaternion): quaternion?
 
 ---------------------------
 -- Global Table: bit32
@@ -415,8 +415,8 @@ declare utf8: {
 -- Global Table: uuid
 ---------------------------
 
-declare uuid: ((value: string | buffer | uuid) -> uuid?) & {
-  create: (value: string | buffer | uuid) -> uuid?,
+declare uuid: ((value: string? | buffer | uuid) -> uuid) & {
+  create: (value: string? | buffer | uuid) -> uuid,
 }
 
 

generated/slua_default.docs.json

@@ -3,7 +3,7 @@
         "documentation": "Dangerously executes a required module function"
     },
     "@sl-slua/global/touuid": {
-        "documentation": "Converts a string, buffer, or uuid to a uuid, returns nil if invalid"
+        "documentation": "Creates a new uuid from a string, buffer, or existing uuid. Returns nil if the string is not a valid UUID, or the the buffer is shorter than 16 bytes."
     },
     "@sl-slua/global/tovector": {
         "documentation": "Converts a string to a vector, returns nil if invalid"
@@ -735,10 +735,10 @@
         "learn_more_link": "https://create.roblox.com/docs/reference/engine/libraries/utf8#offset"
     },
     "@sl-slua/global/uuid": {
-        "documentation": "Creates a new uuid from a string, buffer, or existing uuid. Returns nil if the string is not a valid UUID. Throws an error if the buffer is shorter than 16 bytes. Alias of uuid.create"
+        "documentation": "Creates a new uuid from a string, buffer, or existing uuid. Throws an error if the string is not a valid UUID, or the the buffer is shorter than 16 bytes. Alias of uuid.create."
     },
     "@sl-slua/global/uuid.create": {
-        "documentation": "Creates a new uuid from a string, buffer, or existing uuid. Returns nil if the string is not a valid UUID. Throws an error if the buffer is shorter than 16 bytes."
+        "documentation": "Creates a new uuid from a string, buffer, or existing uuid. Throws an error if the string is not a valid UUID, or the the buffer is shorter than 16 bytes."
     },
     "@sl-slua/global/vector": {
         "documentation": "Creates a new vector with the given component values. Alias of vector.create.",

generated/slua_keywords_pretty.xml

@@ -11176,7 +11176,7 @@ vector position - position in local coordinates
                      <key>tooltip</key>
                      <string></string>
                      <key>type</key>
-                     <string>string | quaternion</string>
+                     <string>string? | quaternion</string>
                   </map>
                </map>
             </array>
@@ -11199,7 +11199,7 @@ vector position - position in local coordinates
                      <key>tooltip</key>
                      <string></string>
                      <key>type</key>
-                     <string>string | quaternion</string>
+                     <string>string? | quaternion</string>
                   </map>
                </map>
             </array>
@@ -11222,7 +11222,7 @@ vector position - position in local coordinates
                      <key>tooltip</key>
                      <string></string>
                      <key>type</key>
-                     <string>string | buffer | uuid</string>
+                     <string>string? | buffer | uuid</string>
                   </map>
                </map>
             </array>
@@ -11233,7 +11233,7 @@ vector position - position in local coordinates
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Converts a string, buffer, or uuid to a uuid, returns nil if invalid</string>
+            <string>Creates a new uuid from a string, buffer, or existing uuid. Returns nil if the string is not a valid UUID, or the the buffer is shorter than 16 bytes.</string>
          </map>
          <key>tovector</key>
          <map>
@@ -11245,7 +11245,7 @@ vector position - position in local coordinates
                      <key>tooltip</key>
                      <string></string>
                      <key>type</key>
-                     <string>string | vector</string>
+                     <string>string? | vector</string>
                   </map>
                </map>
             </array>
@@ -16038,18 +16038,18 @@ Returns true if result is non-zero.</string>
                      <key>tooltip</key>
                      <string></string>
                      <key>type</key>
-                     <string>string | buffer | uuid</string>
+                     <string>string? | buffer | uuid</string>
                   </map>
                </map>
             </array>
             <key>energy</key>
             <real>10.0</real>
             <key>return</key>
-            <string>uuid?</string>
+            <string>uuid</string>
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Creates a new uuid from a string, buffer, or existing uuid. Returns nil if the string is not a valid UUID. Throws an error if the buffer is shorter than 16 bytes. Alias of uuid.create</string>
+            <string>Creates a new uuid from a string, buffer, or existing uuid. Throws an error if the string is not a valid UUID, or the the buffer is shorter than 16 bytes. Alias of uuid.create.</string>
          </map>
          <key>uuid.create</key>
          <map>
@@ -16061,18 +16061,18 @@ Returns true if result is non-zero.</string>
                      <key>tooltip</key>
                      <string></string>
                      <key>type</key>
-                     <string>string | buffer | uuid</string>
+                     <string>string? | buffer | uuid</string>
                   </map>
                </map>
             </array>
             <key>energy</key>
             <real>10.0</real>
             <key>return</key>
-            <string>uuid?</string>
+            <string>uuid</string>
             <key>sleep</key>
             <real>0.0</real>
             <key>tooltip</key>
-            <string>Creates a new uuid from a string, buffer, or existing uuid. Returns nil if the string is not a valid UUID. Throws an error if the buffer is shorter than 16 bytes.</string>
+            <string>Creates a new uuid from a string, buffer, or existing uuid. Throws an error if the string is not a valid UUID, or the the buffer is shorter than 16 bytes.</string>
          </map>
          <key>vector</key>
          <map>

generated/slua_selene.yml

@@ -3925,18 +3925,24 @@ globals:
   touuid:
     args:
     - type: string
-    description: Converts a string, buffer, or uuid to a uuid, returns nil if invalid
+    must_use: true
+    description: Creates a new uuid from a string, buffer, or existing uuid. Returns
+      nil if the string is not a valid UUID, or the the buffer is shorter than 16
+      bytes.
   tovector:
     args:
     - type: string
+    must_use: true
     description: Converts a string to a vector, returns nil if invalid
   toquaternion:
     args:
     - type: string
+    must_use: true
     description: Converts a string to a quaternion, returns nil if invalid
   torotation:
     args:
     - type: string
+    must_use: true
     description: Converts a string to a rotation (quaternion), returns nil if invalid
   bit32.arshift:
     args:
@@ -5062,16 +5068,16 @@ globals:
     args:
     - type: any
     must_use: true
-    description: Creates a new uuid from a string, buffer, or existing uuid. Returns
-      nil if the string is not a valid UUID. Throws an error if the buffer is shorter
-      than 16 bytes. Alias of uuid.create
+    description: Creates a new uuid from a string, buffer, or existing uuid. Throws
+      an error if the string is not a valid UUID, or the the buffer is shorter than
+      16 bytes. Alias of uuid.create.
   uuid.create:
     args:
     - type: any
     must_use: true
-    description: Creates a new uuid from a string, buffer, or existing uuid. Returns
-      nil if the string is not a valid UUID. Throws an error if the buffer is shorter
-      than 16 bytes.
+    description: Creates a new uuid from a string, buffer, or existing uuid. Throws
+      an error if the string is not a valid UUID, or the the buffer is shorter than
+      16 bytes.
   vector:
     args:
     - type: number

slua_definitions.yaml

@@ -303,33 +303,39 @@ globalFunctions:
     type: (...any) -> ...any
   returnType: '...any'
 - name: touuid
-  comment: Converts a string, buffer, or uuid to a uuid, returns nil if invalid
+  comment: Creates a new uuid from a string, buffer, or existing uuid. Returns
+    nil if the string is not a valid UUID, or the the buffer is
+    shorter than 16 bytes.
   parameters:
   - name: val
-    type: string | buffer | uuid
+    type: string? | buffer | uuid
     selene-type: string
   returnType: uuid?
+  must-use: true
 - name: tovector
   comment: Converts a string to a vector, returns nil if invalid
   parameters:
   - name: val
-    type: string | vector
+    type: string? | vector
     selene-type: string
   returnType: vector?
+  must-use: true
 - name: toquaternion
   comment: Converts a string to a quaternion, returns nil if invalid
   parameters:
   - name: val
-    type: string | quaternion
+    type: string? | quaternion
     selene-type: string
   returnType: quaternion?
+  must-use: true
 - name: torotation
   comment: Converts a string to a rotation (quaternion), returns nil if invalid
   parameters:
   - name: val
-    type: string | quaternion
+    type: string? | quaternion
     selene-type: string
   returnType: quaternion?
+  must-use: true
 modules:
 - name: bit32
   comment: Bitwise operations library.
@@ -2160,23 +2166,23 @@ modules:
   comment: UUID library.
   callable:
     name: uuid
-    comment: Creates a new uuid from a string, buffer, or existing uuid. Returns
-      nil if the string is not a valid UUID. Throws an error if the buffer is
-      shorter than 16 bytes. Alias of uuid.create
+    comment: Creates a new uuid from a string, buffer, or existing uuid. Throws
+      an error if the string is not a valid UUID, or the the buffer is
+      shorter than 16 bytes. Alias of uuid.create.
     parameters:
     - name: value
-      type: string | buffer | uuid
-    returnType: uuid?
+      type: string? | buffer | uuid
+    returnType: uuid
     must-use: true
   functions:
   - name: create
-    comment: Creates a new uuid from a string, buffer, or existing uuid. Returns
-      nil if the string is not a valid UUID. Throws an error if the buffer is
+    comment: Creates a new uuid from a string, buffer, or existing uuid. Throws
+      an error if the string is not a valid UUID, or the the buffer is
       shorter than 16 bytes.
     parameters:
     - name: value
-      type: string | buffer | uuid
-    returnType: uuid?
+      type: string? | buffer | uuid
+    returnType: uuid
     must-use: true
 - name: vector
   comment: Vector manipuluation library.