add doc present feature win
This commit is contained in:
parent
6ad5c9d960
commit
2af308f258
18
api-doc/slot-machine/present-feature-win/_category_.json
Normal file
18
api-doc/slot-machine/present-feature-win/_category_.json
Normal file
@ -0,0 +1,18 @@
|
||||
{
|
||||
"position": 29,
|
||||
"label": "Present Feature Win",
|
||||
"collapsible": true,
|
||||
"collapsed": true,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Present Feature Win",
|
||||
"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",
|
||||
"present-feature-win"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,60 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
# Present Feature Win Controller
|
||||
|
||||
## Index
|
||||
|
||||
### Methods
|
||||
|
||||
- [_start](#_start) Initializes feature win state and notifies the game controller.
|
||||
- [_complete](#_complete) Resets the model state after feature is done.
|
||||
- [getFeatureWinData](#getfeaturewindata) Retrieves a structured object describing current feature win state.
|
||||
- [onViewPresentFeatureWinCompleted](#onviewpresentfeaturewincompleted) Handles the event when the view finishes win presentation. Triggers bonus, freespin, or round end logic accordingly.
|
||||
|
||||
---
|
||||
|
||||
## Details
|
||||
|
||||
### Methods
|
||||
|
||||
#### _start
|
||||
|
||||
Initializes feature win state and notifies the game controller.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/controller/present-feature-win-controller.js#L17](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/present-feature-win-controller.js#L17) |
|
||||
|
||||
---
|
||||
|
||||
#### _complete
|
||||
|
||||
Resets the model state after feature is done.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/controller/present-feature-win-controller.js#L28](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/present-feature-win-controller.js#L28) |
|
||||
|
||||
---
|
||||
|
||||
#### getFeatureWinData
|
||||
|
||||
Retrieves a structured object describing current feature win state
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Returns | Object |
|
||||
| Defined in | [p4f-slotty-core/src/controller/present-feature-win-controller.js#L34](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/present-feature-win-controller.js#L34) |
|
||||
|
||||
---
|
||||
|
||||
#### onViewPresentFeatureWinCompleted
|
||||
|
||||
Handles the event when the view finishes win presentation. Triggers bonus, freespin, or round end logic accordingly.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/controller/present-feature-win-controller.js#L47](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/present-feature-win-controller.js#L47) |
|
||||
|
||||
---
|
||||
@ -0,0 +1,181 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# Present Feature Win Model
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
- [featureHitRule](#featurehitrule) `String` Rule that determines how the feature is triggered.
|
||||
- [featurePlayedCount](#featureplayedcount) `Number` Number of times the feature has been played.
|
||||
- [gameWinPoint](#gamewinpoint) `Number` Points won in the base game.
|
||||
- [featureWinPoint](#featurewinpoint) `Number` Points won in the feature game.
|
||||
|
||||
### Methods
|
||||
|
||||
- [Reset](#reset) Resets all model properties to default values.
|
||||
- [SetFeaturePlayedCount](#setfeatureplayedcount) Sets the number of times the feature has been played.
|
||||
- [GetFeaturePlayedCount](#getfeatureplayedcount) Gets the number of times the feature has been played.
|
||||
- [SetFeatureHitRule](#setfeaturehitrule) Sets the rule used to trigger the feature.
|
||||
- [GetFeatureHitRule](#getfeaturehitrule) Gets the feature hit rule.
|
||||
- [SetGameWinPoint](#setgamewinpoint) Sets the number of points won in the base game.
|
||||
- [GetGameWinPoint](#getgamewinpoint) Gets the number of points won in the base game.
|
||||
- [SetFeatureWinPoint](#setfeaturewinpoint) Sets the number of points won in the feature game.
|
||||
- [GetFeatureWinPoint](#getfeaturewinpoint) Gets the number of points won in the feature game.
|
||||
- [GetTotalWinPoint](#gettotalwinpoint) Gets the total number of points won (game + feature).
|
||||
|
||||
---
|
||||
|
||||
## Details
|
||||
|
||||
### Properties
|
||||
|
||||
#### featureHitRule
|
||||
|
||||
> Rule that determines how the feature is triggered.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Type | String |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L7](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L7) |
|
||||
|
||||
---
|
||||
|
||||
#### featurePlayedCount
|
||||
|
||||
> Number of times the feature has been played.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Type | Number |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L8](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L8) |
|
||||
|
||||
---
|
||||
|
||||
#### gameWinPoint
|
||||
|
||||
> Points won in the base game.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Type | Number |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L9](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L9) |
|
||||
|
||||
---
|
||||
|
||||
#### featureWinPoint
|
||||
|
||||
> Points won in the feature game.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Type | Number |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L10](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L10) |
|
||||
|
||||
---
|
||||
|
||||
### Methods
|
||||
|
||||
#### Reset
|
||||
|
||||
Resets all model properties to default values.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L16](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L16) |
|
||||
|
||||
---
|
||||
|
||||
#### SetFeaturePlayedCount
|
||||
|
||||
Sets the number of times the feature has been played.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L25](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L25) |
|
||||
|
||||
---
|
||||
|
||||
#### GetFeaturePlayedCount
|
||||
|
||||
Gets the number of times the feature has been played.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Returns | Number |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L31](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L31) |
|
||||
|
||||
---
|
||||
|
||||
#### SetFeatureHitRule
|
||||
|
||||
Sets the rule used to trigger the feature.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L35](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L35) |
|
||||
|
||||
---
|
||||
|
||||
#### GetFeatureHitRule
|
||||
|
||||
Gets the feature hit rule.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Returns | String |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#41](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#41) |
|
||||
|
||||
---
|
||||
|
||||
#### SetGameWinPoint
|
||||
|
||||
Sets the number of points won in the base game.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L45](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L45) |
|
||||
|
||||
---
|
||||
|
||||
#### GetGameWinPoint
|
||||
|
||||
Gets the number of points won in the base game.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Returns | Number |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L51](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L51) |
|
||||
|
||||
---
|
||||
|
||||
#### SetFeatureWinPoint
|
||||
|
||||
Sets the number of points won in the feature game.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L55](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L55) |
|
||||
|
||||
---
|
||||
|
||||
#### GetFeatureWinPoint
|
||||
|
||||
Gets the number of points won in the feature game.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Returns | Number |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L61](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L61) |
|
||||
|
||||
---
|
||||
|
||||
#### GetTotalWinPoint
|
||||
|
||||
Gets the total number of points won (game + feature).
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Returns | Number |
|
||||
| Defined in | [p4f-slotty-core/src/model/present-feature-win-model.js#L65](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/present-feature-win-model.js#L65) |
|
||||
@ -0,0 +1,24 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
# Present Feature Win View
|
||||
|
||||
## Index
|
||||
|
||||
### Methods
|
||||
|
||||
- [PresentComplete](#presentcomplete) Triggers the `PresentFeatureWinCompleted` event.
|
||||
|
||||
---
|
||||
|
||||
## Details
|
||||
|
||||
### Methods
|
||||
|
||||
#### PresentComplete
|
||||
|
||||
Triggers the `PresentFeatureWinCompleted` event which signals that the feature win presentation has completed.
|
||||
|
||||
| meta | description |
|
||||
| :--- | :---------- |
|
||||
| Defined in | [p4f-slotty-core/src/view/present-feature-win-view.js#L13](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/view/present-feature-win-view.js#L13) |
|
||||
Loading…
x
Reference in New Issue
Block a user