Browse Source

docs: Add note about instance methods as callbacks in scripting

gxalpha 2 years ago
parent
commit
4d2f7ef009
1 changed files with 3 additions and 0 deletions
  1. 3 0
      docs/sphinx/scripting.rst

+ 3 - 0
docs/sphinx/scripting.rst

@@ -122,6 +122,9 @@ without necessarily having to lock scripts/interpreters every frame.
 
     Adds an timer callback which triggers every *milliseconds*.
 
+    Note: Using instance methods as callbacks is not supported. Always
+    use module methods.
+
 .. py:function:: timer_remove(callback)
 
     Removes a timer callback.  (Note: You can also use