diff --git a/docs/02-setup-main-game/05-main-scene/05-win-point-on-reel.md b/docs/02-setup-main-game/05-main-scene/05-win-point-on-reel.md index 0700f6c..669eb9e 100644 --- a/docs/02-setup-main-game/05-main-scene/05-win-point-on-reel.md +++ b/docs/02-setup-main-game/05-main-scene/05-win-point-on-reel.md @@ -2,7 +2,7 @@ sidebar_position: 5 --- -# Win Point On Reel +# Win Point on Reel ## Overview @@ -13,55 +13,136 @@ sidebar_position: 5 ## Implementation -### Core Prefabs +### Prefab Locations -| Path | Example | -|------|---------| -| `assets\core-assets\hyper-core\packages\on-reel-present-win-point\prefab` | ![Overview](../img/05-main-scene/win-point-on-reel/win-point-core.png) | +#### In Core + + + + + + + + + + + + + + +
PathExample
assets\core-assets\hyper-core\packages\on-reel-present-win-point\prefab
![Core Prefab](../img/05-main-scene/win-point-on-reel/win-point-core.png)
+ +#### In Game + + + + + + + + + + + + + + +
PathExample
assets\game-assets\prefabs
![Copied Prefab](../img/05-main-scene/win-point-on-reel/prefab-on-reel-in-game.png)
### Setup Steps -#### Steps 1. +#### Steps 1: Add Prefab to Scene -- Add the win point on reel prefab to your main scene. +Add the win point on reel prefab to your main scene. + + + + + + + + + + + + + + + + + + +
ComponentDescription
on-reel-present-win-pointA component to **show/hide** points on reels
hyper-present-win-pointManages win point presentation flow
- | Component | Description | - |----------------------------------|-----------------------------------------------------| - | `on-reel-present-win-point` | Component to **show/hide** points on reels | - | `hyper-present-win-point` | Manages win point presentation flow | ![Overview](../img/05-main-scene/win-point-on-reel/win-point-component.png) -#### Steps 2. -- Manages the display and animation of win point labels at specific reel positions in the slot game. +#### Steps 2: Configure Node Targets +Set the target node where each win point label appears and define its size and offset. ![Overview](../img/05-main-scene/win-point-on-reel/win-point-node-target-component.png) - | Property | Type | Description | - |--------------------|-----------|---------------------------------------------| - | `labelPosition` | `cc.Vec2` | Offset position for the win point label | - | `nodeTarget` | `cc.Node` | Target node containing the label | - | `cellItemSize` | `cc.Vec2` | Size of each slot cell | - | `defaultFontSize` | `number` | Default font size for the label | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
labelPositioncc.Vec2Offset position for the win point label
nodeTargetcc.NodeTarget node containing the label
cellItemSizecc.Vec2Size of each slot cell
defaultFontSizenumberDefault font size for the label
-#### Steps 3 - -- Set Up Label - - ![Overview](../img/05-main-scene/win-point-on-reel/win-point-label-component.png) - - - Add `label-point`: - - **Display:** Shows win points on reels. - - **Formatting:** Supports number and currency formats for localization. - - - Add Font: - - Add a custom font asset to the win point component. - - | path | example | - |---------------------------|---------------------------------------------------------------| - |path: `assets\game-assets\fonts\preloads\main-game\fnt-win-point-on-reel`|![Overview](../img/05-main-scene/win-point-on-reel/add-font.png)| +#### Steps 3: Set Up Label Component +![Overview](../img/05-main-scene/win-point-on-reel/win-point-label-component.png) + +- **Component**: + - Displays win values on the reels. + - Supports formatted text (number, currency). + +- **Custom Font**: + Add a custom font to style the win label. + + + + + + + + + + + + + +
PathExample
assets\game-assets\fonts\preloads\main-game\fnt-win-point-on-reel
![Overview](../img/05-main-scene/win-point-on-reel/add-font.png)
+ +:::tip + - **Position And Size**: Follow Game Design. +::: ## Game Result Examples diff --git a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/prefab-on-reel-in-game.png b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/prefab-on-reel-in-game.png new file mode 100644 index 0000000..f2967f2 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/prefab-on-reel-in-game.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-component.png b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-component.png index a1de817..5a540ca 100644 Binary files a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-component.png and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-component.png differ