dev-public/doc-slot-core-manual
19
0
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity
doc-slot-core-manual/api-doc/slot-machine/auto-spin/auto-spin-model.md

307 lines
11 KiB
Markdown
Raw Blame History

---
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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/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)
Reference in New Issue View Git Blame Copy Permalink