add api auto spin
This commit is contained in:
parent
9109548120
commit
bc9b6054e5
18
api-doc/controllers/auto-spin/_category_.json
Normal file
18
api-doc/controllers/auto-spin/_category_.json
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"position": 4,
|
||||||
|
"label": "Auto Spin",
|
||||||
|
"collapsible": true,
|
||||||
|
"collapsed": true,
|
||||||
|
"link": {
|
||||||
|
"type": "generated-index",
|
||||||
|
"title": "Auto Spin",
|
||||||
|
"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",
|
||||||
|
"auto-spin"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
352
api-doc/controllers/auto-spin/auto-spin-controller.md
Normal file
352
api-doc/controllers/auto-spin/auto-spin-controller.md
Normal file
@ -0,0 +1,352 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
# Auto Spin Controller
|
||||||
|
|
||||||
|
## Index
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [totalBet](#totalbet) `Number` Total current bet in a spin round.
|
||||||
|
- [totalWin](#totalwin) `Number` Total win points collected.
|
||||||
|
- [betLossAccumulation](#betlossaccumulation) `Number` Accumulated loss for checking loss limit condition.
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
|
- [onSpinStarted](#onspinstarted) Decrements remaining auto spins and disables auto spin if none are left.
|
||||||
|
- [onRoundEnd](#onroundend) Triggers win/loss limit checks at end of round.
|
||||||
|
- [onTake](#ontake) Triggers win/loss limit checks when a take action occurs.
|
||||||
|
- [onFreeroundsTriggered](#onfreeroundstriggered) Stops auto spin if freerounds are triggered.
|
||||||
|
- [onPresentFreeroundsWinStarted](#onpresentfreeroundswinstarted) Stops auto spin on freeround win presentation.
|
||||||
|
- [onMiniGameStarted](#onminigamestarted) Stops auto spin if a mini-game starts.
|
||||||
|
- [onBetDataChanged](#onbetdatachanged) Updates internal bet tracking based on input data.
|
||||||
|
- [onAutoSpinActivated](#onautospinactivated) Activates auto spin mode.
|
||||||
|
- [onAutoSpinDeactivated](#onautospindeactivated) Disables auto spin and resets `betLossAccumulation`.
|
||||||
|
- [onAutoSpinQuantityChanged](#onautospinquantitychanged) Updates number of auto spins remaining.
|
||||||
|
- [onFeatureTrigger](#onfeaturetrigger) Stops auto spin if feature is triggered and `stopOnFeatureTrigger` is enabled.
|
||||||
|
- [onStopOnTriggerFeatureToggled](#onstopontriggerfeaturetoggled) Toggles stop-on-feature behavior.
|
||||||
|
- [onLossLimitToggled](#onlosslimittoggled) Enables/disables auto-spin stop based on loss limit.
|
||||||
|
- [onLossLimitValueChanged](#onlosslimitvaluechanged) Updates configured loss limit value.
|
||||||
|
- [onWinLimitToggled](#onwinlimittoggled) Enables or disables win limit mode.
|
||||||
|
- [onWinLimitValueChanged](#onwinlimitvaluechanged) Updates win limit threshold.
|
||||||
|
- [onLobbyForcePauseGame](#onlobbyforcepausegame) Immediately stops auto spin when lobby forces pause.
|
||||||
|
- [onLobbyAllowResumeGame](#onlobbyallowresumegame) No action defined.
|
||||||
|
- [onDisconnected](#ondisconnected) Stops auto spin due to network disconnect.
|
||||||
|
- [onError](#onerror) Stops auto spin when error occurs.
|
||||||
|
- [onErrorAllowContinue](#onerrorallowcontinue) Stops auto spin when recoverable error is received.
|
||||||
|
- [stopAutoSpin](#stopautospin) Utility method to disable auto spin if currently active. Triggers `AutoSpinDeactivated` event.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Details
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
#### totalBet
|
||||||
|
|
||||||
|
> Total current bet in a spin round.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L12](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L12)|
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### totalWin
|
||||||
|
|
||||||
|
> Total win points collected.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L13](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L13)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### betLossAccumulation
|
||||||
|
|
||||||
|
> Accumulated loss for checking loss limit condition.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L14](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L14)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
|
#### onSpinStarted
|
||||||
|
|
||||||
|
Decrements remaining auto spins and disables auto spin if none are left.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L43](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L43)|
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
* `data` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
||||||
|
|
||||||
|
* `isFreeSpin` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onRoundEnd
|
||||||
|
|
||||||
|
Triggers win/loss limit checks at end of round.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L55](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L55)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onTake
|
||||||
|
|
||||||
|
Triggers win/loss limit checks when a take action occurs.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L61](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L61)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onFreeroundsTriggered
|
||||||
|
|
||||||
|
Stops auto spin if freerounds are triggered.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L88](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L88)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onPresentFreeroundsWinStarted
|
||||||
|
|
||||||
|
Stops auto spin on freeround win presentation.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L94](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L94)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onMiniGameStarted
|
||||||
|
|
||||||
|
Stops auto spin if a mini-game starts.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L100](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L100)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onBetDataChanged
|
||||||
|
|
||||||
|
Updates internal bet tracking based on input data.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L106](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L106)|
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
* `betData` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
|
||||||
|
|
||||||
|
* `totalBetPoint` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onAutoSpinActivated
|
||||||
|
|
||||||
|
Activates auto spin mode.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L112](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L112)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onAutoSpinDeactivated
|
||||||
|
|
||||||
|
Disables auto spin and resets `betLossAccumulation`.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L118](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L118)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onAutoSpinQuantityChanged
|
||||||
|
|
||||||
|
Updates number of auto spins remaining.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L125](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L125)|
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
* `totalBetPoint` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onFeatureTrigger
|
||||||
|
|
||||||
|
Stops auto spin if:
|
||||||
|
- A free spin is triggered.
|
||||||
|
- The `stopOnFeatureTrigger` option in the UI is enabled in the model.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L131](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L131)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onStopOnTriggerFeatureToggled
|
||||||
|
|
||||||
|
Toggles stop-on-feature behavior.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L139](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L139)|
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
* `isOn` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onLossLimitToggled
|
||||||
|
|
||||||
|
Enables/disables auto-spin stop based on loss limit.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L145](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L145)|
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
* `isOn` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onLossLimitValueChanged
|
||||||
|
|
||||||
|
Updates configured loss limit value.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L151](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L151)|
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
* `lossLimit` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onWinLimitToggled
|
||||||
|
|
||||||
|
Enables or disables win limit mode.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L157](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L157)|
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
* `isOn` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onWinLimitValueChanged
|
||||||
|
|
||||||
|
Updates win limit threshold.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L163](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L163)|
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
* `winLimit` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onLobbyForcePauseGame
|
||||||
|
|
||||||
|
Immediately stops auto spin when lobby forces pause.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L169](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L169)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onLobbyAllowResumeGame
|
||||||
|
|
||||||
|
No action defined. Placeholder handler.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L174](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L174)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onDisconnected
|
||||||
|
|
||||||
|
Stops auto spin due to network disconnect.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L176](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L176)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onError
|
||||||
|
|
||||||
|
Stops auto spin when error occurs.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L181](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L181)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### onErrorAllowContinue
|
||||||
|
|
||||||
|
Stops auto spin when recoverable error is received.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L186](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L186)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### stopAutoSpin
|
||||||
|
|
||||||
|
Utility method to disable auto spin if currently active. Triggers `AutoSpinDeactivated` event.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/controller/auto-spin-controller.js#L191](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/auto-spin-controller.js#L191)|
|
||||||
307
api-doc/controllers/auto-spin/auto-spin-model.md
Normal file
307
api-doc/controllers/auto-spin/auto-spin-model.md
Normal file
@ -0,0 +1,307 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
# Auto Spin Model
|
||||||
|
|
||||||
|
## Index
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
- [autoSpinLeft](#autospinleft) `Number` Remaining number of auto spins.
|
||||||
|
- [isAutoSpin](#isautospin) `Boolean` Indicates whether auto spin is active.
|
||||||
|
- [isStopOnFeatureTrigger](#isstoponfeaturetrigger) `Boolean` Whether to stop auto spin on feature trigger.
|
||||||
|
- [winLimit](#winlimit) `Number` Win threshold for stopping auto spin.
|
||||||
|
- [isWinLimitActive](#iswinlimitactive) `Boolean` Indicates whether win limit tracking is enabled.
|
||||||
|
- [lossLimit](#losslimit) `Number` Loss threshold for stopping auto spin.
|
||||||
|
- [isLossLimitActive](#islosslimitactive) `Boolean` Indicates whether loss limit tracking is enabled.
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
|
- [SetAutoSpinLeft](#setautospinleft) Sets remaining number of auto spins.
|
||||||
|
- [GetAutoSpinLeft](#getautospinleft) Gets remaining number of auto spins.
|
||||||
|
- [SetIsAutoSpin](#setisautospin) Activates or deactivates auto spin.
|
||||||
|
- [GetIsAutoSpin](#getisautospin) Returns the current auto spin status.
|
||||||
|
- [SetIsStopOnFeatureTrigger](#setisstoponfeaturetrigger) Sets whether auto spin should stop on feature trigger.
|
||||||
|
- [GetIsStopOnFeatureTrigger](#getisstoponfeaturetrigger) Gets stop-on-feature-trigger status.
|
||||||
|
- [SetIsLossLimitActive](#setislosslimitactive) Enables or disables loss limit tracking.
|
||||||
|
- [GetIsLossLimitActive](#getislosslimitactive) Returns whether loss limit is active.
|
||||||
|
- [SetLossLimit](#setlosslimit) Sets the loss limit value.
|
||||||
|
- [GetLossLimit](#getlosslimit) Gets the current loss limit value.
|
||||||
|
- [SetIsWinLimitActive](#setiswinlimitactive) Enables or disables win limit tracking.
|
||||||
|
- [GetIsWinLimitActive](#getiswinlimitactive) Returns whether win limit is active.
|
||||||
|
- [SetWinLimit](#setwinlimit) Sets the win limit value.
|
||||||
|
- [GetWinLimit](#getwinlimit) Gets the current win limit value.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Details
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
#### autoSpinLeft
|
||||||
|
|
||||||
|
> Remaining number of auto spins.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | Number |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L9](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L9)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### isAutoSpin
|
||||||
|
|
||||||
|
> Indicates whether auto spin is active.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | Boolean |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L10](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L10)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### isStopOnFeatureTrigger
|
||||||
|
|
||||||
|
> Whether to stop auto spin on feature trigger.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | Boolean |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L11](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L11)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### winLimit
|
||||||
|
|
||||||
|
> Win threshold for stopping auto spin.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | Number |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L12](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L12)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### isWinLimitActive
|
||||||
|
|
||||||
|
> Indicates whether win limit tracking is enabled.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | Boolean |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L13](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L13)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### lossLimit
|
||||||
|
|
||||||
|
> Loss threshold for stopping auto spin.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | Number |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L14](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L14)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### isLossLimitActive
|
||||||
|
|
||||||
|
> Indicates whether loss limit tracking is enabled.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Type | Boolean |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L15](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L15)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Methods
|
||||||
|
|
||||||
|
#### SetAutoSpinLeft
|
||||||
|
|
||||||
|
Sets remaining number of auto spins.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L20](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L20)
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
- `autoSpinLeft` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### GetAutoSpinLeft
|
||||||
|
|
||||||
|
Gets remaining number of auto spins
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Returns | Number |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L26](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L26)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### SetIsAutoSpin
|
||||||
|
|
||||||
|
Activates or deactivates auto spin
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L32](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L32)
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
- `isAutoSpin` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### GetIsAutoSpin
|
||||||
|
|
||||||
|
Returns the current auto spin status.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Returns | Boolean |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L38](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L38)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### SetIsStopOnFeatureTrigger
|
||||||
|
|
||||||
|
Sets whether auto spin should stop on feature trigger.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#44](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#44)
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
|
||||||
|
- `isActive` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### GetIsStopOnFeatureTrigger
|
||||||
|
|
||||||
|
Gets stop-on-feature-trigger status
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Returns | Boolean |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#50](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#50)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### SetIsLossLimitActive
|
||||||
|
|
||||||
|
Enables or disables loss limit tracking.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#56](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#56)
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
- `isLossLimitActive` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### GetIsLossLimitActive
|
||||||
|
|
||||||
|
Returns whether loss limit is active
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Returns | Boolean |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#62](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#62)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### SetLossLimit
|
||||||
|
|
||||||
|
Sets the loss limit value.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L68](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L68)
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
- `lossLimit` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### GetLossLimit
|
||||||
|
|
||||||
|
Gets the current loss limit value.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Returns | Number |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#74](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L74)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### SetIsWinLimitActive
|
||||||
|
|
||||||
|
Enables or disables win limit tracking
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L80](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L80)
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
- `isWinLimitActive` [Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### GetIsWinLimitActive
|
||||||
|
|
||||||
|
Returns whether win limit is active.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Returns | Boolean |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L86](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L86)|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### SetWinLimit
|
||||||
|
|
||||||
|
Sets the win limit value.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#92](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L92)
|
||||||
|
|
||||||
|
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
- `winLimit` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### GetWinLimit
|
||||||
|
|
||||||
|
Gets the current win limit value.
|
||||||
|
|
||||||
|
| meta | description |
|
||||||
|
| :--- | :---------- |
|
||||||
|
| Returns | Number |
|
||||||
|
| Defined in | [p4f-slotty-core/src/model/auto-spin-model.js.js#L98](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/auto-spin-model.js#L98)
|
||||||
15
api-doc/controllers/auto-spin/auto-spin-view.md
Normal file
15
api-doc/controllers/auto-spin/auto-spin-view.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Auto Spin view
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
* AutoSpinView is a view class for the spin feature in the slot game. It extends the base View class and is intended to handle the visual representation and UI logic for spins.
|
||||||
|
|
||||||
|
## Description:
|
||||||
|
* Initializes a new instance of AutoSpinView.
|
||||||
|
* Calls the base View constructor.
|
||||||
|
* [p4f-game-core/src/view/auto-spin-view.js:12](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/view/auto-spin-view.js#L5)
|
||||||
|
|
||||||
Loading…
x
Reference in New Issue
Block a user