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 index bc776d7..cd5423e 100644 --- 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 @@ -8,38 +8,67 @@ description: Display win and gamble limit notifications in-game. ## Overview -This component handles the display of **win limit** or **gamble limit** notifications during gameplay. -It ensures players are informed when a maximum win condition is reached in a slot game. +- Shows a win limit popup during gameplay. +- Win limit notifications can appear in the **main game** or **Free Spin mode**. + +![Overview](../img/05-main-scene/win-limit/overview.png) + +--- ## Implementation -### Location +### Prefab Location -#### Core +| Path | Prefab Name | +|----------------------------------------------------------|------------------------------| +| `assets/core-assets/hyper-core/packages/present/prefabs` | `present-win-limit-reached` | -| Path | Name | -|----------------------------------------------------------|-----------------------------| -| `assets\core-assets\hyper-core\packages\present\prefabs` | `present-win-limit-reached` | +--- -#### Game +### Scene Hierarchy -##### In Scene +Place the prefab in the following scene structure: -- structure in scene. - -``` +``` Canvas └── [main-view] └── [game-view] └── [present-win-limit-reached] -``` -![Component](../img/05-main-scene/win-limit/win-limit-component.png) -- component Animation: +``` -|Status| Path | Show | -|------|-------------------------------------------------------------------|--------------------------------------| -|Show | `assets\core-assets\slotty-core\packages\feature-game\animations` | `anim-show-feature-win-presentation` | -|Hide | `assets\core-assets\slotty-core\packages\feature-game\animations` | `anim-hide-feature-win-presentation` | +![Scene Structure](../img/05-main-scene/win-limit/win-limit-component.png) + +#### `hyper-present-win-limit-reached` + +- Displays win/gamble limit notifications. +- Supports animations and user interactions. +- Ensure all node references are assigned in the Inspector. + +#### `Animation` + +| Status | Animation Path | Animation Name | +|--------|-------------------------------------------------------------------|--------------------------------------| +| Show | `assets/core-assets/slotty-core/packages/feature-game/animations` | `anim-show-feature-win-presentation` | +| Hide | `assets/core-assets/slotty-core/packages/feature-game/animations` | `anim-hide-feature-win-presentation` | + +--- + +## 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) + +### 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. +- Configure win limits per 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.png b/docs/02-setup-main-game/img/05-main-scene/win-limit/overview.png new file mode 100644 index 0000000..e5d117c Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-limit/overview.png differ