---
sidebar_position: 2
---

# Freerounds Model

## Index

### Properties

* [arrFreeroundsData](#arrfreeroundsdata) Stores the list of available freerounds data.
* [betPoint](#betpoint) Current bet point used in the freerounds.
* [freeroundsID](#freeroundsid) Identifier of the current freerounds session.
* [totalFreerounds](#totalfreerounds) Total number of freerounds awarded.
* [freeroundsPlayed](#freeroundsplayed) Number of freerounds already played.
* [totalWinPoint](#totalwinpoint) Accumulated win points from freerounds.

### Methods

* [SetArrayFreeroundsData](#setarrayfreeroundsdata) Stores an array of freerounds data.
* [GetFreeroundsData](#getfreeroundsdata) Retrieves the first item from the freerounds data array.
* [ShiftFreeroundsData](#shiftfreeroundsdata) Removes and returns the first element from the freerounds data array.
* [SetFreeroundsID](#setfreeroundsid) Sets the freerounds session ID.
* [GetFreeroundsID](#getfreeroundsid) Retrieves the current freerounds session ID.
* [SetBetPoint](#setbetpoint) Sets the bet point value.
* [GetBetPoint](#getbetpoint) Gets the current bet point value.
* [SetTotalFreerounds](#settotalfreerounds) Sets the total number of freerounds available.
* [GetTotalFreerounds](#gettotalfreerounds) Gets the total number of freerounds.
* [SetFreeroundsPlayed](#setfreeroundsplayed) Sets the number of freerounds that have been played.
* [GetFreeroundsPlayed](#getfreeroundsplayed) Gets the number of freerounds played.
* [CheckFreeroundsCompleted](#checkfreeroundscompleted) Checks whether all freerounds have been completed.
* [SetTotalWinPoint](#settotalwinpoint) Sets the total accumulated win points.
* [GetTotalWinPoint](#gettotalwinpoint) Gets the total win points earned in freerounds.
* [GetFreeroundsLeft](#getfreeroundsleft) Calculates how many freerounds are remaining.

## Details

### Properties

#### arrFreeroundsData

> Stores the list of available freerounds data.

| meta | description |
|------|-------|
| Type | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L7](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L7) |

#### betPoint

> Current bet point used in the freerounds.

| meta | description |
|------|--------|
| Type | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L8](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L8) |

#### freeroundsID

> Identifier of the current freerounds session.

| meta | description |
|------|--------|
| Type | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)|
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L9](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L9) |

#### totalFreerounds

> Total number of freerounds awarded.

| meta | description |
|------|--------|
| Type | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L10](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L10) |

#### freeroundsPlayed

> Number of freerounds already played.

| meta | description |
|------|--------|
| Type | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L11](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L11) |

#### totalWinPoint

> Accumulated win points from freerounds.

| meta | description |
|------|--------|
| Type | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L12](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L12) |

### Methods

#### SetArrayFreeroundsData

Stores an array of freerounds data.

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

<p style={{ color: 'gray', fontSize: '1.0em' }}>

 **Parameters**
 * `arrFreeroundsData` [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
</p>

#### GetFreeroundsData

Retrieves the first item from the freerounds data array.

| meta | description |
| :--- | :---------- |
| Returns | [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L17](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L17) |

#### ShiftFreeroundsData

Removes and returns the first element from the freerounds data array.

| meta | description |
| :--- | :---------- |
| Returns | [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L21](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L21) |

#### SetFreeroundsID

Sets the freerounds session ID.

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

<p style={{ color: 'gray', fontSize: '1.0em' }}>

 **Parameters**
 * `freeroundsID` [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
</p>

#### GetFreeroundsID

Retrieves the current freerounds session ID.

| meta | description |
| :--- | :---------- |
| Returns | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L29](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L29) |

#### SetBetPoint

Sets the bet point value.

| meta | description |
| :--- | :---------- |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L33](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L33) |
<p style={{ color: 'gray', fontSize: '1.0em' }}>

 **Parameters**
 * `betPoint` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
</p>

#### GetBetPoint

Gets the current bet point value.

| meta | description |
| :--- | :---------- |
| Returns | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L37](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L37) |

#### SetTotalFreerounds

Sets the total number of freerounds available.

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

<p style={{ color: 'gray', fontSize: '1.0em' }}>

 **Parameters**
 * `totalFreerounds` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
</p>

#### GetTotalFreerounds

Gets the total number of freerounds.

| meta | description |
| :--- | :---------- |
| Returns | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L45](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L45) |

#### SetFreeroundsPlayed

Sets the number of freerounds that have been played.

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

<p style={{ color: 'gray', fontSize: '1.0em' }}>

 **Parameters**
 * `freeroundsPlayed` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
</p>

#### GetFreeroundsPlayed

Gets the number of freerounds played.

| meta | description |
| :--- | :---------- |
| Returns | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L53](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L53) |

#### CheckFreeroundsCompleted

Checks whether all freerounds have been completed.

| meta | description |
| :--- | :---------- |
| Returns | [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L57](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L57) |

#### SetTotalWinPoint

Sets the total accumulated win points.

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

<p style={{ color: 'gray', fontSize: '1.0em' }}>

 **Parameters**
 * `totalWinPoint` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
</p>

#### GetTotalWinPoint

Gets the total win points earned in freerounds.

| meta | description |
| :--- | :---------- |
| Returns | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L65](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L65) |

#### GetFreeroundsLeft

Calculates how many freerounds are remaining.

| meta | description |
| :--- | :---------- |
| Returns | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
| Defined in | [p4f-slotty-core/src/model/freerounds-model.js#L69](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/freerounds-model.js#L69) |