Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create ios_pause_background.md #128

Merged
merged 1 commit into from
Dec 23, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/ios_pause_background.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Get Started

This step is only for iOS, it will indicate if your Game in Godot should be paused or not when a full-screen ad is shown, such as Interstitial, Rewarded, and Rewarded Interstitial.

On Android, your game will be automatically paused when a full-screen ad is shown (Google doesn't allow it to configure). Calling this method passing a `true` parameter will duplicate this behavior on iOS.

On iOS, the default value is `false`.

# Prerequisites

- Complete the [Get started guide](README.md)
- Use Godot v4.1 or higher
- Use AdMob Plugin **[Editor](https://github.com/Poing-Studios/godot-admob-plugin/releases/tag/v3.1.0)** and **[iOS](https://github.com/Poing-Studios/godot-admob-ios/releases/tag/v3.1.0)**: v3.1.0+

# How to use
You can use this whenever you want this method, before, during, or after the initialization, such as:

```gdscript linenums="1" hl_lines="2"
func _on_set_ios_app_pause_on_background_button_pressed() -> void:
MobileAds.set_ios_app_pause_on_background(true)
```

# Important notes

If your game is multiplayer, probably you will need this value as `false` due to connection issues.
Read more about it here: https://github.com/Poing-Studios/godot-admob-ios/issues/70