63 lines
3.8 KiB
Markdown
63 lines
3.8 KiB
Markdown
---
|
|
sidebar_position: 7
|
|
---
|
|
|
|
# Item Description
|
|
|
|
## Overview
|
|
The **Item Description** system provides detailed information about game items, including payouts and descriptions.
|
|
|
|

|
|
|
|
## Asset Preparation
|
|
| Assets | Description |
|
|
|--------|-------------|
|
|
|  | Background setup. |
|
|
|  | Static symbol setup. |
|
|
|  | Animation symbol setup. |
|
|
|  | Payout or description text setup. |
|
|
|
|
## Setup
|
|
1. **Locate Template Prefabs**:
|
|
- Search for the `template-item-description` prefab.
|
|
- 
|
|
2. **Clone Assets**:
|
|
- Copy and paste to the game assets location, removing unnecessary prefixes.
|
|
- 
|
|
|
|
### Prefab Configurations
|
|
- **item-description-small** (Items with win payout only):
|
|
- 
|
|
- Steps:
|
|
| Step | Action | Image Reference |
|
|
|------|--------|-----------------|
|
|
| 1 | Set **Sprite Frame** in `background` using prepared assets. |  |
|
|
| 2 | Name prefab as `item-description-<name>` and set **Animation Name** in **Animation Provider**. |  |
|
|
| 3 | Set **Sprite Frame** in `sprite-item` using prepared assets. |  |
|
|
| 4 | Adjust **Color**, **Font**, and **Font Size** in `multi-x...` and `odds-x...`. Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) if needed. |  |
|
|
|
|
- **item-description-no-odds** (Items with description only):
|
|
- 
|
|
- Steps:
|
|
| Step | Action | Image Reference |
|
|
|------|--------|-----------------|
|
|
| 1 | Set **Sprite Frame** in `background` using prepared assets. |  |
|
|
| 2 | Name prefab as `item-description-<name>` and set **Animation Name** in **Animation Provider**. |  |
|
|
| 3 | Set **Sprite Frame** in `sprite-item` using prepared assets. |  |
|
|
| 4 | Set **String**, **Color**, **Font**, and **Font Size** in `description`. Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) if needed. |  |
|
|
|
|
- **item-description-big** (Items with both payout and description):
|
|
- 
|
|
- Steps:
|
|
| Step | Action | Image Reference |
|
|
|------|--------|-----------------|
|
|
| 1 | Set **Sprite Frame** in `background` using prepared assets. |  |
|
|
| 2 | Follow **Step 4** of `item-description-small` for payout setup. | [See Small Setup](#prefab-configurations) |
|
|
| 3 | Follow **Step 4** of `item-description-no-odds` for description setup. | [See No-Odds Setup](#prefab-configurations) |
|
|
**Tip**:
|
|
- Use the helper tool to configure:
|
|
1. Set **Content Size** and **Cell Item Size** per game design.
|
|
2. Use prepared bitmap fonts for **Labels**.
|
|
3. Click **Set Size** to run the helper.
|
|
4. Configure **Background**, **Sprite Frame**, **Animation**, **Payout**, and **Description** using prepared assets.
|
|
-  |