76 lines
4.8 KiB
Markdown

---
sidebar_position: 7
---
# Item Description
Provides players with detailed information about each item of the game.
---
## Overview
![Item Description Overview](./img/07-item-description/overview.png)
## Prepare the assets
| Assets | Description |
|--------|-------------|
| ![Info Page Prepare Assets](./img/07-item-description/prepare-assets-1.png) | Used to setup background. |
| ![Info Page Prepare Assets](./img/07-item-description/prepare-assets-2.png) | Used to setup for static symbol. |
| ![Info Page Prepare Assets](./img/07-item-description/prepare-assets-3.png) | Used to setup for animation symbol. |
| ![Info Page Prepare Assets](./img/07-item-description/prepare-assets-4.png) | Used to setup Payout/Description. |
## Setup Prefabs Item Description
| Step | Action | Description | Image Reference |
| :--: | :----- | :---------- | :-------------: |
| 1 | Locate all template prefabs need for **Item Description** | Search for the `template-item-description` prefab. | ![Locate Prefabs](./img/07-item-description/prepare-prefabs-1.png) |
| 2 | Clone assets| Copy/Pase to game assets location, then rename the copied prefabs by removing unnecessary prefixes. | ![Locate Prefabs](./img/07-item-description/prepare-prefabs-2.png) |
### item-description-small
Setup prefab `item-description-small` for item have win payout:
![Locate Prefabs](./img/07-item-description/setup-item-small-overview.png)
| Step | Action | Image Reference |
| :--: | :----- | :-------------: |
| 1 | - Setup **Sprite Frame** in `background` from prepared assets. | <img width="1000"/>![Locate Prefabs](./img/07-item-description/setup-item-small-1.png) |
| 2 | - Setup Item with prefab name follow format item-description-**name**".<br/> - Setup **Animation Name** with animation name of item in **Animation Provider**.| ![Locate Prefabs](./img/07-item-description/setup-item-small-2.png) |
| 3 | - Setup **Sprite Frame** in `sprite-item` same name with item from prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-small-3.png) |
| 4 | - Change **Color**, **Font** and **Font Size** in `multi-x...` and `oods-x...` follow the game design.<br/> - Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) to create Font Bitmap if you need it.| ![Locate Prefabs](./img/07-item-description/setup-item-small-4.png) |
### item-description-no-odds
Setup prefab `item-description-no-odds` for item have description without win payout:
![Locate Prefabs](./img/07-item-description/setup-item-no-odds-overview.png)
| Step | Action | Image Reference |
| :--: | :----- | :-------------: |
| 1 | - Setup **Sprite Frame** in `background` from prepared assets. | <img width="1000"/>![Locate Prefabs](./img/07-item-description/setup-item-no-odds-1.png) |
| 2 | - Setup Item with prefab name follow format item-description-**name**".<br/> - Setup **Animation Name** with animation name of item in **Animation Provider**.| ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-2.png) |
| 3 | - Setup **Sprite Frame** in `sprite-item` same name with item from prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-3.png) |
| 4 | - Setup **String**, change **Color**, **Font** and **Font Size** in `description` follow the game design.<br/> - Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) to create Font Bitmap if you need it.| ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-4.png) |
### item-description-big
Setup prefab `item-description-big` for item have win payout and description:
![Locate Prefabs](./img/07-item-description/setup-item-big-overview.png)
| Step | Action | Image Reference |
| :--: | :----- | :-------------: |
| 1 | - Setup **Sprite Frame** in `background` from prepared assets. | <img width="1000"/>![Locate Prefabs](./img/07-item-description/setup-item-big-1.png) |
| 2 | - Setup Payout for item, we do **Step 4** in **Setup prefab `item-description-small`** | [Configure Item Description Small](./item-description#item-description-small) | |
| 3 | - Setup Payout for item, we do **Step 4** in **Setup prefab `item-description-no-odds`** | [Configure Item Description No Odds](./item-description#item-description-no-odds) | |
:::tip
Use Helper to setup:
1. Setup **Content Size** and **Cell Item Size** follow game design.
2. Use prepared fonts (Bitmap) to setup **Labels** font.
3. Click **Set Size** to run helper.
4. Setup **Background**, **Sprite Frame**, **Animation**, **Payout**, **Description** of item from prepared assets.
![Locate Prefabs](./img/07-item-description/setup-item-helper.png)
:::