Merge pull request 'feature/add-respin' (#91) from feature/add-respin into develop
Reviewed-on: #91 Reviewed-by: Pham Huynh Duc Huy <huy.pham@mercurystudiogroup.com>
@ -1,7 +1,72 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
# Respin Feature
|
||||
|
||||
# Respin
|
||||
### Overview
|
||||
**Respin** is a bonus mechanic in slot games that allows players to re-spin selected reels without restarting the full spin.
|
||||
It typically triggers after a specific in-game condition (e.g. near-win or bonus hit) and enhances player engagement.
|
||||
|
||||
> To be added
|
||||
> Respin ends when the respin counter reaches **zero**.
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
Spin --> SpinEnd
|
||||
Spin --> Condition_Trigger : case Special
|
||||
|
||||
SpinEnd --> Condition_Trigger : No Win
|
||||
SpinEnd --> Win
|
||||
Win --> Win_Complete : case normal
|
||||
Win_Complete --> Condition_Trigger
|
||||
Condition_Trigger --> Trigger_Respin
|
||||
```
|
||||
---
|
||||
|
||||
### Main Scene
|
||||
|
||||
#### Triggering Respin
|
||||
- Triggered by game logic after a win or specific pattern.
|
||||
- Node setup required in Scene graph.
|
||||
|
||||
| Action | Image |
|
||||
|--------|-------|
|
||||
| Create Respin Trigger Node |  |
|
||||
|
||||
#### Respin Feature
|
||||
1. **Trigger Respin**
|
||||

|
||||
|
||||
2. **Re-trigger Respin**
|
||||

|
||||
|
||||
3. **Respin Win**
|
||||
This step handles the outcome evaluation after a respin.
|
||||
Its implementation depends on the specific game design and may be optional in some games.
|
||||
|
||||
---
|
||||
|
||||
### Handle Event
|
||||
|
||||
#### Respin Event Handling
|
||||
- Override class: `hyper-gaming-server-handler`
|
||||
|
||||
| Process | Image |
|
||||
|---------|-------|
|
||||
| Listen for event: `"respins" |  |
|
||||
| Trigger Data from Server |  |
|
||||
| Re-trigger Data |  |
|
||||
|
||||
---
|
||||
|
||||
### Feature Management
|
||||
|
||||
#### Feature Class Setup
|
||||
- Create `feature-respin` class extending `feature-game`
|
||||
- Responsibilities:
|
||||
- Manage respin panel UI
|
||||
- Handle trigger & retrigger logic
|
||||
|
||||
| Action | Image |
|
||||
|--------|-------|
|
||||
| Script: Feature Panel |  |
|
||||
| Script: Trigger/Retrigger |  |
|
||||
|
BIN
docs/03-setup-special-feature/img/respin/handle-event.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
docs/03-setup-special-feature/img/respin/handle-retrigger.png
Normal file
After Width: | Height: | Size: 50 KiB |
BIN
docs/03-setup-special-feature/img/respin/handle-trigger.png
Normal file
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 1.5 KiB |
BIN
docs/03-setup-special-feature/img/respin/overview.png
Normal file
After Width: | Height: | Size: 503 KiB |
BIN
docs/03-setup-special-feature/img/respin/respin-left.png
Normal file
After Width: | Height: | Size: 87 KiB |
BIN
docs/03-setup-special-feature/img/respin/retrigger.png
Normal file
After Width: | Height: | Size: 457 KiB |
After Width: | Height: | Size: 1.5 KiB |
After Width: | Height: | Size: 4.2 KiB |
After Width: | Height: | Size: 514 KiB |
BIN
docs/03-setup-special-feature/img/respin/trigger.png
Normal file
After Width: | Height: | Size: 425 KiB |