---
sidebar_position: 2
---

# Free Game Model

## Index

### Methods

* [SetTotalFreeSpin](#settotalfreespin) Sets the total number of free spins.
* [GetTotalFreeSpin](#gettotalfreespin) Retrieves the total number of free spins.
* [SetFreeSpinLeft](#setfreespinleft) Sets how many free spins are left to play.
* [GetFreeSpinLeft](#getfreespinleft) Gets the number of remaining free spins.
* [GetFreeSpinPlayed](#getfreespinplayed) Calculates the number of spins that have been played already.
* [SetFreeSpinBoost](#setfreespinboost) Sets the boost/multiplier for the free spin session.
* [GetFreeSpinBoost](#getfreespinboost) Gets the current boost/multiplier for free spins.

---

## Details

### Methods

#### SetTotalFreeSpin

Sets the total number of free spins.

| meta | description |
| :--- | :---------- |
| Defined in | [p4f-slotty-core/src/model/free-game-model.js#L16](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/free-game-model.js#L16) |

---

#### GetTotalFreeSpin

Retrieves the total number of free spins.

| meta | description |
| :--- | :---------- |
| Defined in | [p4f-slotty-core/src/model/free-game-model.js#L22](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/free-game-model.js#L22) |

---

#### SetFreeSpinLeft

Sets how many free spins are left to play.

| meta | description |
| :--- | :---------- |
| Defined in | [p4f-slotty-core/src/model/free-game-model.js#L26](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/free-game-model.js#L26) |

---

#### GetFreeSpinLeft

Gets the number of remaining free spins.

| meta | description |
| :--- | :---------- |
| Defined in | [p4f-slotty-core/src/model/free-game-model.js#L32](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/free-game-model.js#L32) |

---

#### GetFreeSpinPlayed

Calculates the number of spins that have been played already.

| meta | description |
| :--- | :---------- |
| Defined in | [p4f-slotty-core/src/model/free-game-model.js#L36](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/free-game-model.js#L36) |

---

#### SetFreeSpinBoost

Sets the boost/multiplier for the free spin session.

| meta | description |
| :--- | :---------- |
| Defined in | [p4f-slotty-core/src/model/free-game-model.js#L40](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/free-game-model.js#L40) |

---

#### GetFreeSpinBoost

Gets the current boost/multiplier for free spins.

| meta | description |
| :--- | :---------- |
| Defined in | [p4f-slotty-core/src/model/free-game-model.js#L46](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/free-game-model.js#L46) |