Add doc for canPop

2024-03-21 10:52:23 +11:00
parent 684ff50ef4
commit 7305820aa9
1 changed files with 5 additions and 0 deletions
@@ -22,4 +22,9 @@ function screen:onShown() end
 --- been popped off of the stack.
 function screen:onHidden() end

+--- Called when this screen is about to be popped off of the stack. If this
+--- returns false, it will not be popped. May be a function, or any boolean
+--- convertable value.
+function screen:canPop() end
+
 return screen