Browse Source

Document newThread shenanigans;

bjorn 5 years ago
parent
commit
3a447f1041
2 changed files with 958 additions and 1256 deletions
  1. 951 1255
      api/init.lua
  2. 7 1
      api/lovr/thread/newThread.lua

File diff suppressed because it is too large
+ 951 - 1255
api/init.lua


+ 7 - 1
api/lovr/thread/newThread.lua

@@ -35,7 +35,13 @@ return {
       returns = { 'thread' }
     }
   },
-  notes = 'The Thread won\'t start running immediately.  Use `Thread:start` to start it.',
+  notes = [[
+    The Thread won\'t start running immediately.  Use `Thread:start` to start it.
+
+    The string argument is assumed to be a filename if there isn't a newline in the first 1024
+    characters.  For really short thread code, an extra newline can be added to trick LÖVR into
+    loading it properly.
+  ]],
   related = {
     'Thread:start',
     'lovr.threaderror'

Some files were not shown because too many files changed in this diff