add doc freeround
This commit is contained in:
parent
4b3f3d0c4b
commit
67ff0e7dfb
@ -8,24 +8,8 @@ sidebar_position: 3
|
||||
|
||||
The `FreeGameView` class manages the presentation layer for the Free Game feature. It handles the UI transitions and animations when entering the Free Game mode during gameplay.
|
||||
|
||||
---
|
||||
## Description
|
||||
|
||||
## Index
|
||||
|
||||
### Methods
|
||||
|
||||
* [presentFreeGame](#presentfreegame) — Displays the Free Game UI presentation.
|
||||
|
||||
---
|
||||
|
||||
## Details
|
||||
|
||||
### Methods
|
||||
|
||||
#### presentFreeGame
|
||||
|
||||
Displays the Free Game screen to the player. This method is triggered when the player enters the Free Game feature. It typically includes animations or UI transitions indicating the start of Free Game mode.
|
||||
|
||||
| Meta | Description |
|
||||
|------|-------------|
|
||||
| Defined in | [p4f-slotty-core/src/view/free-game-view.js#L6](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/view/free-game-view.js#L6) |
|
||||
* Constructs a new FreeroundsView instance.
|
||||
* Invokes the base View constructor for initialization.
|
||||
* [Source code reference](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/view/free-game-view.js#L6)
|
||||
18
api-doc/slot-machine/freeround/_category_.json
Normal file
18
api-doc/slot-machine/freeround/_category_.json
Normal file
@ -0,0 +1,18 @@
|
||||
{
|
||||
"position": 24,
|
||||
"label": "Freeround Game",
|
||||
"collapsible": true,
|
||||
"collapsed": true,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Freeround Game",
|
||||
"description": "This section will guide you through the process of setting up a new project, including creating a new repository and configuring your development environment.",
|
||||
"keywords": [
|
||||
"controller",
|
||||
"project",
|
||||
"repository",
|
||||
"model",
|
||||
"freeround-game"
|
||||
]
|
||||
}
|
||||
}
|
||||
234
api-doc/slot-machine/freeround/freerounds-controller.md
Normal file
234
api-doc/slot-machine/freeround/freerounds-controller.md
Normal file
@ -0,0 +1,234 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Freerounds Controller
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
### Methods
|
||||
|
||||
* [_start](#_start) Initializes freerounds session and presents appropriate dialogs based on state.
|
||||
* [_complete](#_complete) Clears timers and unregisters auto-spin deactivation events.
|
||||
* [_registerEvent](#_registerevent) Registers relevant network and game events.
|
||||
* [presentDialog](#presentdialog) Displays appropriate freerounds dialog based on configuration.
|
||||
* [onFreeroundsDataReceived](#onfreeroundsdatareceived) Handles incoming freerounds data and updates model.
|
||||
* [onFreeroundsTotalWinPointReceived](#onfreeroundstotalwinpointreceived) Updates model with total win points.
|
||||
* [onSelectFreeroundsDataReceived](#onselectfreeroundsdatareceived) Processes selected freerounds data.
|
||||
* [onFreeroundsReadyToPlay](#onfreeroundsreadytoplay) Continues the game when ready.
|
||||
* [onStartFreeroundsClicked](#onstartfreeroundsclicked) Handles player clicking to start freerounds.
|
||||
* [onSkipFreeroundsClicked](#onskipfreeroundsclicked) Skips the current freerounds selection screen.
|
||||
* [onHideFreeroundsWinClicked](#onhidefreeroundswinclicked) Finalizes win screen and resets related states.
|
||||
* [onAutoSpinActivated](#onautospinactivated) Triggers spin automatically if conditions met.
|
||||
* [onSpinClicked](#onspinclicked) Triggers spin on user interaction.
|
||||
* [onAutoSpinDeactivated](#onautospindeactivated) Stops any auto-spin delay timers.
|
||||
* [selectFreeroundsCompleted](#selectfreeroundscompleted) Finalizes selection and initializes freerounds session.
|
||||
* [continue](#continue) Determines game flow after selection or spin completion.
|
||||
* [spin](#spin) Executes one spin of the freeround feature.
|
||||
|
||||
## Details
|
||||
|
||||
### Properties
|
||||
|
||||
### Methods
|
||||
|
||||
#### _start
|
||||
|
||||
Initializes freerounds session and presents appropriate dialogs based on state
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L22](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L22) |
|
||||
|
||||
#### _complete
|
||||
|
||||
Clears timers and unregisters auto-spin deactivation events.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L40](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L40) |
|
||||
|
||||
#### _registerEvent
|
||||
|
||||
Registers relevant network and game events.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L47](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L47) |
|
||||
|
||||
#### presentDialog
|
||||
|
||||
Displays appropriate freerounds dialog based on configuration.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L59](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L59) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
* `freeroundsData` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
||||
|
||||
* `spinPlayed` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
|
||||
* `allowChangeOptions` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
||||
</p>
|
||||
|
||||
#### onFreeroundsDataReceived
|
||||
|
||||
Handles incoming freerounds data and updates model.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L83](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L83) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
* `data` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
||||
|
||||
* `spinLeft` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
* `freeroundsID` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
</p>
|
||||
|
||||
#### onFreeroundsTotalWinPointReceived
|
||||
|
||||
Updates model with total win points.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L98](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L98) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
|
||||
`totalWinPoint` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
|
||||
</p>
|
||||
|
||||
#### onSelectFreeroundsDataReceived
|
||||
|
||||
Processes selected freerounds data.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L106](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L106) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
|
||||
`data` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
||||
|
||||
</p>
|
||||
|
||||
#### onFreeroundsReadyToPlay
|
||||
|
||||
Continues the game when ready.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L114](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L114) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
|
||||
`data` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
||||
|
||||
</p>
|
||||
|
||||
#### onStartFreeroundsClicked
|
||||
|
||||
Handles player clicking to start freerounds.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L122](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L122) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
|
||||
`optionIndex` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
|
||||
</p>
|
||||
|
||||
#### onSkipFreeroundsClicked
|
||||
|
||||
Skips the current freerounds selection screen.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L136](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L136) |
|
||||
|
||||
#### onHideFreeroundsWinClicked
|
||||
|
||||
Finalizes win screen and resets related states.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L145](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L145) |
|
||||
|
||||
#### onAutoSpinActivated
|
||||
|
||||
Triggers spin automatically if conditions met.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L164](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L164) |
|
||||
|
||||
#### onSpinClicked
|
||||
|
||||
Triggers spin on user interaction.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L172](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L172) |
|
||||
|
||||
#### onAutoSpinDeactivated
|
||||
|
||||
Stops any auto-spin delay timers.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L180](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L180) |
|
||||
|
||||
#### selectFreeroundsCompleted
|
||||
|
||||
Finalizes selection and initializes freerounds session.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L191](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L191) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
* `freeroundsData` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
||||
|
||||
* `freeroundsID` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
* `spinCount` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
* `betPoint` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
* `spinPlayed` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
|
||||
</p>
|
||||
|
||||
#### continue
|
||||
|
||||
Determines game flow after selection or spin completion.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L214](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L214) |
|
||||
|
||||
#### spin
|
||||
|
||||
Executes one spin of the freeround feature.
|
||||
|
||||
| meta | description |
|
||||
|:-----|:------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/freerounds-controller.js#L227](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/freerounds-controller.js#L227) |
|
||||
258
api-doc/slot-machine/freeround/freerounds-model.md
Normal file
258
api-doc/slot-machine/freeround/freerounds-model.md
Normal file
@ -0,0 +1,258 @@
|
||||
---
|
||||
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) |
|
||||
15
api-doc/slot-machine/freeround/freerounds-view.md
Normal file
15
api-doc/slot-machine/freeround/freerounds-view.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# FreeroundsView
|
||||
|
||||
## Overview
|
||||
|
||||
EndRoundView is a UI component for managing the end-of-round visuals in the slot machine game. It handles the UI transitions and animations when entering the Free round Game mode during gameplay.
|
||||
|
||||
## Description
|
||||
|
||||
* Constructs a new FreeroundsView instance.
|
||||
* Invokes the base View constructor for initialization.
|
||||
* [Source code reference](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/view/freerounds-view.js#L5)
|
||||
Loading…
x
Reference in New Issue
Block a user