documents the isolated argument to DREAMLUAU_NEW_STATE

tgstation · Nov 3, 2024 · 79193e2 · 79193e2
1 parent 2da9af6
commit 79193e2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/dmsrc/api.dm b/dmsrc/api.dm
@@ -131,6 +131,10 @@
 /**
  * Create a new luau state.
  * 
+ * @param isolated if truthy, the `dm`, `list`, and `pointer` modules are not included in the state,
+ * and values other than null, numbers, or strings passed as function call or thread resume arguments
+ * are converted to `nil`
+ * 
  * @return a handle to the created state.
  */
 #define DREAMLUAU_NEW_STATE DREAMLUAU_CALL(new_state)