diff --git a/docs/03-setup-special-feature/03-respin.md b/docs/03-setup-special-feature/03-respin.md index a9bd018..ea9cb45 100644 --- a/docs/03-setup-special-feature/03-respin.md +++ b/docs/03-setup-special-feature/03-respin.md @@ -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 \ No newline at end of file +> 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 | ![Trigger](./img/respin/node-trigger-in-scenes.png) | + +#### Respin Feature +1. **Trigger Respin** + ![Trigger](./img/respin/trigger.png) + +2. **Re-trigger Respin** + ![Retrigger](./img/respin/retrigger.png) + +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" | ![Script](./img/respin/handle-event.png) | +| Trigger Data from Server | ![Trigger](./img/respin/handle-trigger.png) | +| Re-trigger Data | ![Retrigger](./img/respin/handle-retrigger.png) | + +--- + +### 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](./img/respin/script-feature-respin.png) | +| Script: Trigger/Retrigger | ![Trigger](./img/respin/script-trigger-retrigger.png) | diff --git a/docs/03-setup-special-feature/img/respin/handle-event.png b/docs/03-setup-special-feature/img/respin/handle-event.png new file mode 100644 index 0000000..b17fe32 Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/handle-event.png differ diff --git a/docs/03-setup-special-feature/img/respin/handle-retrigger.png b/docs/03-setup-special-feature/img/respin/handle-retrigger.png new file mode 100644 index 0000000..017a2ea Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/handle-retrigger.png differ diff --git a/docs/03-setup-special-feature/img/respin/handle-trigger.png b/docs/03-setup-special-feature/img/respin/handle-trigger.png new file mode 100644 index 0000000..3ceb5b9 Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/handle-trigger.png differ diff --git a/docs/03-setup-special-feature/img/respin/node-trigger-in-scenes.png b/docs/03-setup-special-feature/img/respin/node-trigger-in-scenes.png new file mode 100644 index 0000000..8fda78a Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/node-trigger-in-scenes.png differ diff --git a/docs/03-setup-special-feature/img/respin/overview.png b/docs/03-setup-special-feature/img/respin/overview.png new file mode 100644 index 0000000..12a51d1 Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/overview.png differ diff --git a/docs/03-setup-special-feature/img/respin/respin-left.png b/docs/03-setup-special-feature/img/respin/respin-left.png new file mode 100644 index 0000000..cbf3522 Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/respin-left.png differ diff --git a/docs/03-setup-special-feature/img/respin/retrigger.png b/docs/03-setup-special-feature/img/respin/retrigger.png new file mode 100644 index 0000000..396dd9a Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/retrigger.png differ diff --git a/docs/03-setup-special-feature/img/respin/script-feature-respin.png b/docs/03-setup-special-feature/img/respin/script-feature-respin.png new file mode 100644 index 0000000..9501e7c Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/script-feature-respin.png differ diff --git a/docs/03-setup-special-feature/img/respin/script-trigger-retrigger.png b/docs/03-setup-special-feature/img/respin/script-trigger-retrigger.png new file mode 100644 index 0000000..dd57ed2 Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/script-trigger-retrigger.png differ diff --git a/docs/03-setup-special-feature/img/respin/static-symbols-respin.png b/docs/03-setup-special-feature/img/respin/static-symbols-respin.png new file mode 100644 index 0000000..84ec0a8 Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/static-symbols-respin.png differ diff --git a/docs/03-setup-special-feature/img/respin/trigger.png b/docs/03-setup-special-feature/img/respin/trigger.png new file mode 100644 index 0000000..f7cd135 Binary files /dev/null and b/docs/03-setup-special-feature/img/respin/trigger.png differ