Merge pull request #22 from defold/fix_documentation

Fix documentation

Author: AGulev

docs/index.md

@@ -55,7 +55,15 @@ Rewarded breaks allow for a user to choose to watch a rewarded video ad in excha
 
 ```lua
 -- gameplay stops
-poki_sdk.rewarded_break(function(self, success)end)
+poki_sdk.rewarded_break(function(self, status)
+  if status == poki_sdk.REWARDED_BREAK_ERROR then
+    print("Rewarded break error!")
+  elseif status == poki_sdk.REWARDED_BREAK_START then
+    print("Rewarded break start")
+  elseif status == poki_sdk.REWARDED_BREAK_SUCCESS then
+    print("Rewarded break success")
+  end
+end)
 ```
 
 ### About the rewarded break timer
@@ -71,9 +79,14 @@ Make sure that audio and keyboard input are disabled during commercialBreaks, so
 
 ```lua
 -- gameplay stops
--- fire your mute audio function
+-- fire your mute audio function, for example:
+sound.pause("#music", true)
 poki_sdk.commercial_break(function(self)
-  -- fire your unmute audio function
+  -- fire your unmute audio function, for example:
+  if status == poki_sdk.REWARDED_BREAK_ERROR or
+     status == poki_sdk.REWARDED_BREAK_SUCCESS then
+     sound.pause("#music", false)
+  end
   -- fire your function to continue to game
 end)
 ```

poki-sdk/api/poki-sdk.script_api

@@ -36,6 +36,18 @@
     - name: callback
       type: function
 
+      parameters:
+        - name: self
+          type: object
+          desc: The calling script instance
+
+        - name: status
+          type: number
+          desc: "One of the statuses:
+               `poki_sdk.REWARDED_BREAK_ERROR`,
+               `poki_sdk.REWARDED_BREAK_START`,
+               `poki_sdk.REWARDED_BREAK_SUCCESS`"
+
 #*****************************************************************************************************
 
   - name: set_debug