Merge pull request 'add doc info' (#120) from feature/add-doc-info into develop
Reviewed-on: #120 Reviewed-by: Pham Huynh Duc Huy <huy.pham@mercurystudiogroup.com>
This commit is contained in:
commit
42579ec363
@ -5,8 +5,7 @@ sidebar_position: 3
|
||||
# Freerounds View
|
||||
|
||||
## Overview
|
||||
|
||||
FreeroundsView 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.
|
||||
The `FreeroundsView` component manages the user interface for free rounds in the slot machine game. It is responsible for displaying relevant visuals, handling UI transitions, and triggering animations when the game enters or exits Free Round mode.
|
||||
|
||||
## Description
|
||||
|
||||
|
18
api-doc/slot-machine/info/_category_.json
Normal file
18
api-doc/slot-machine/info/_category_.json
Normal file
@ -0,0 +1,18 @@
|
||||
{
|
||||
"position": 23,
|
||||
"label": "Info",
|
||||
"collapsible": true,
|
||||
"collapsed": true,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"title": "Info",
|
||||
"description": "This section provides information about the Info Game.",
|
||||
"keywords": [
|
||||
"controller",
|
||||
"project",
|
||||
"repository",
|
||||
"model",
|
||||
"info-game"
|
||||
]
|
||||
}
|
||||
}
|
33
api-doc/slot-machine/info/info-controller.md
Normal file
33
api-doc/slot-machine/info/info-controller.md
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Info Controller
|
||||
|
||||
## Index
|
||||
|
||||
## Properties
|
||||
|
||||
## Methods
|
||||
|
||||
* [onPaytableInitialized](#onpaytableinitialized) Handles the `PaytableInitialized` event by setting the total number of paytable pages.
|
||||
|
||||
## Details
|
||||
|
||||
## Properties
|
||||
|
||||
## Methods
|
||||
|
||||
### onPaytableInitialized
|
||||
|
||||
Handles the `PaytableInitialized` event by setting the total number of paytable pages.
|
||||
|
||||
| meta | description |
|
||||
|------|-------------|
|
||||
| Defined in | [p4f-slotty-core/src/controller/info-controller.js#L14](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/controller/info-controller.js#L14) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
* `totalPages` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
</p>
|
62
api-doc/slot-machine/info/info-model.md
Normal file
62
api-doc/slot-machine/info/info-model.md
Normal file
@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Info Model
|
||||
|
||||
## Index
|
||||
|
||||
### Properties
|
||||
|
||||
- [totalPages](#totalpages) `Number` Tracks total number of info pages.
|
||||
|
||||
### Methods
|
||||
|
||||
- [GetTotalPages](#gettotalpages) Returns total number of paytable pages.
|
||||
- [SetTotalPages](#settotalpages) Sets the total number of paytable pages.
|
||||
|
||||
---
|
||||
|
||||
## Details
|
||||
|
||||
### Properties
|
||||
|
||||
#### totalPages
|
||||
|
||||
> Tracks the total number of paytable pages.
|
||||
|
||||
| meta | description |
|
||||
|------|-------------|
|
||||
| Type | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
|
||||
| Defined in | [p4f-slotty-core/src/model/info-model.js#L6](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/info-model.js#L6) |
|
||||
|
||||
---
|
||||
|
||||
## Methods
|
||||
|
||||
### GetTotalPages
|
||||
|
||||
Returns the total number of pages currently stored.
|
||||
|
||||
| meta | description |
|
||||
|------|-------------|
|
||||
| Returns | [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) |
|
||||
| Defined in | [p4f-slotty-core/src/model/info-model.js#L12](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/info-model.js#L12) |
|
||||
|
||||
---
|
||||
|
||||
### SetTotalPages
|
||||
|
||||
Sets the total number of paytable pages.
|
||||
|
||||
**Returns:** `void`
|
||||
|
||||
| meta | description |
|
||||
|------|-------------|
|
||||
| Defined in | [p4f-slotty-core/src/model/info-model.js#L17](https://gitea.plp19.com/cocos-core/p4f-slotty-core/src/commit/7fbf58bf2ad8edec4258757b353151b638c96652/src/model/info-model.js#L17) |
|
||||
|
||||
<p style={{ color: 'gray', fontSize: '1.0em' }}>
|
||||
|
||||
**Parameters**
|
||||
* `totalPages` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
|
||||
</p>
|
15
api-doc/slot-machine/info/info-view.md
Normal file
15
api-doc/slot-machine/info/info-view.md
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Info View
|
||||
|
||||
## Overview
|
||||
|
||||
`InfoView` is a user interface component responsible for displaying end-of-round visuals in the slot machine game. It manages UI transitions and animations, particularly when the game enters Free Round mode, ensuring a smooth and engaging player experience during these state changes.
|
||||
|
||||
## Description
|
||||
|
||||
* Constructs a new InfoView 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/info-view.js#L5)
|
Loading…
x
Reference in New Issue
Block a user