diff --git a/docs/02-setup-main-game/05-main-scene/17-win-limit.md b/docs/02-setup-main-game/05-main-scene/17-win-limit.md new file mode 100644 index 0000000..db3b517 --- /dev/null +++ b/docs/02-setup-main-game/05-main-scene/17-win-limit.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 17 +title: Win Limit +description: Display limit win +--- + +# Win Limit + +### Overview + +#### Win Limit + +- The **Win Limit** popup appears during gameplay when the player's win points reach a predefined threshold. + +![Win Limit Popup](../img/05-main-scene/win-limit/overview.png) + +#### Gamble Win Limit + +- The **Gamble Win Limit** popup is triggered during the gamble feature when the player reaches the maximum number of allowed gamble attempts (typically 5). + +![Gamble Win Limit Popup](../img/05-main-scene/win-limit/overview-gamble.png) + +--- + +### Prefab Location + +| Path | Prefab Name | +|----------------------------------------------------------|------------------------------| +| `assets/core-assets/hyper-core/packages/present/prefabs` | `present-win-limit-reached` | + +### Scene Hierarchy + +Place the prefab in the following scene structure: + +``` +Canvas +└── [main-view] + └── [game-view] + └── [present-win-limit-reached] +``` + +![Scene Structure](../img/05-main-scene/win-limit/win-limit-component.png) + +--- + +### Asset Setup + +- Drag and drop the required image onto the node in the editor: + +![Asset Setup](../img/05-main-scene/win-limit/assets-win-limit.png) + +| Drag Sprite | Node Name | +|-------------------------|-----------------------| +| `you-won` | `you-won` | +| `win-limit-reached` | `win-limit-reached` | +| `gamble-limit-reached` | `gamble-limit-reached`| +| `btn-normal` | `btn-continue` | +| `text-continue` | `continue` | + + +### Font + +- Use a **custom font** to match the win label style for your game theme. + +![Font](../img/05-main-scene/win-limit/add-font.png) + +--- + +:::tip +- Follow the game design layout for assets and fonts. +- Win limit configuration may vary by game. +::: diff --git a/docs/02-setup-main-game/img/05-main-scene/win-limit/add-font.png b/docs/02-setup-main-game/img/05-main-scene/win-limit/add-font.png new file mode 100644 index 0000000..c748b98 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-limit/add-font.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-limit/assets-win-limit.png b/docs/02-setup-main-game/img/05-main-scene/win-limit/assets-win-limit.png new file mode 100644 index 0000000..96675ea Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-limit/assets-win-limit.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-limit/overview-gamble.png b/docs/02-setup-main-game/img/05-main-scene/win-limit/overview-gamble.png new file mode 100644 index 0000000..572b2a8 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-limit/overview-gamble.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-limit/overview.png b/docs/02-setup-main-game/img/05-main-scene/win-limit/overview.png new file mode 100644 index 0000000..d700f4d Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-limit/overview.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-limit/win-limit-component.png b/docs/02-setup-main-game/img/05-main-scene/win-limit/win-limit-component.png new file mode 100644 index 0000000..f4999e8 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-limit/win-limit-component.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-limit/win-limit.png b/docs/02-setup-main-game/img/05-main-scene/win-limit/win-limit.png new file mode 100644 index 0000000..9f3d48a Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-limit/win-limit.png differ