diff --git a/docs/02-setup-main-game/05-main-scene/05-present-win.md b/docs/02-setup-main-game/05-main-scene/05-present-win.md deleted file mode 100644 index 1bfbe12..0000000 --- a/docs/02-setup-main-game/05-main-scene/05-present-win.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Prensent Win - -> To be added - ---- - -> To be added \ No newline at end of file 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 new file mode 100644 index 0000000..58a14e4 --- /dev/null +++ b/docs/02-setup-main-game/05-main-scene/05-win-point-on-reel.md @@ -0,0 +1,148 @@ +--- +sidebar_position: 5 +--- + +# Win Point on Reel + +## Overview + +- Displays win points for each payline, including scatter wins. + +![Overview](../img/05-main-scene/win-point-on-reel/win-point-overview.png) + +## Implementation + +### Prefab Locations + +#### 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: Add Prefab to 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
+ + + ![Overview](../img/05-main-scene/win-point-on-reel/win-point-component.png) + +#### 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) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 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 + + ![Overview](../img/05-main-scene/win-point-on-reel/win-point-result.png)| \ No newline at end of file diff --git a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/add-font.png b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/add-font.png new file mode 100644 index 0000000..6c2bf15 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/add-font.png differ 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 new file mode 100644 index 0000000..5a540ca Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-component.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-core.png b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-core.png new file mode 100644 index 0000000..c8cb9c1 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-core.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-label-component.png b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-label-component.png new file mode 100644 index 0000000..3e78b59 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-label-component.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-node-target-component.png b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-node-target-component.png new file mode 100644 index 0000000..3f34a07 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-node-target-component.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-overview.png b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-overview.png new file mode 100644 index 0000000..4ee836c Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-overview.png differ diff --git a/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-result.png b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-result.png new file mode 100644 index 0000000..61b6377 Binary files /dev/null and b/docs/02-setup-main-game/img/05-main-scene/win-point-on-reel/win-point-result.png differ