Browse Source

lovr.event.push note;

bjorn 7 years ago
parent
commit
91af964637
2 changed files with 7 additions and 3 deletions
  1. 3 2
      api/init.lua
  2. 4 1
      api/lovr/event/push.lua

+ 3 - 2
api/init.lua

@@ -4595,12 +4595,13 @@ return {
                 {
                   name = "...",
                   type = "*",
-                  description = "The arguments for the event."
+                  description = "The arguments for the event.  Currently, up to 4 are supported."
                 }
               },
               returns = {}
             }
-          }
+          },
+          notes = "Only nil, booleans, numbers, strings, and LÖVR objects are supported types for event payloads."
         },
         {
           name = "quit",

+ 4 - 1
api/lovr/event/push.lua

@@ -14,10 +14,13 @@ return {
     {
       name = '...',
       type = '*',
-      description = 'The arguments for the event.'
+      description = 'The arguments for the event.  Currently, up to 4 are supported.'
     }
   },
   returns = {},
+  notes = [[
+    Only nil, booleans, numbers, strings, and LÖVR objects are supported types for event payloads.
+  ]],
   related = {
     'lovr.event.poll',
     'lovr.event.quit'