2025-05-21 11:03:59 +07:00

5.0 KiB

Raw Blame History

sidebar_position

sidebar_position
7

Item Description

Provides players with detailed information about each item in the game.

Overview

Implementation

Prepare Assets

Assets	Description
	Used to Setup the background.
	Used to Setup the static symbol.
	Used to Setup the animation symbol.
	Used to Setup the payout/description.

Setup

Step	Action	Description	Image Reference
1	Locate all template prefabs needed for the Item Description	Search for the `template-item-description` prefab.
2	Clone assets	Copy and paste them to the game assets location, then rename the copied prefabs by removing unnecessary prefixes.

item-description-small

 Setup the `item-description-small` prefab for items have only win payout:
 
    ![Locate Prefabs](./img/07-item-description/setup-item-small-overview.png) 

    | Step | Action | Image Reference |
    | :--: | :----- | :-------------: |
    | 1 | - Setup the **Sprite Frame** in the `background` using the prepared assets. | <img width="1000"/>![Locate Prefabs](./img/07-item-description/setup-item-small-1.png) |
    | 2 | - Name the item prefab following the format item-description-**name**".<br/> - Setup the **Animation Name** to match the item's name in the **Animation Provider**.| ![Locate Prefabs](./img/07-item-description/setup-item-small-2.png) |
    | 3 | - Setup the **Sprite Frame** in the `sprite-item` using the same name as the item from the prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-small-3.png) |
    | 4 | - Adjust **Color**, **Font** and **Font Size** in `multi-x...` and `oods-x...` according to the game design.<br/> - Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) if you need to create a Bitmap Font.| ![Locate Prefabs](./img/07-item-description/setup-item-small-4.png) |

item-description-no-odds

Setup the `item-description-no-odds` prefab for items that have a description but no win payout:
 
    ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-overview.png) 

    | Step | Action | Image Reference |
    | :--: | :----- | :-------------: |
    | 1 | - Setup the **Sprite Frame** in the `background` using the prepared assets. | <img width="1000"/>![Locate Prefabs](./img/07-item-description/setup-item-no-odds-1.png) |
    | 2 | - Name the item prefab following the format item-description-**name**".<br/> - Setup **Animation Name** to match the item's name in the **Animation Provider**.| ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-2.png) |
    | 3 | - Setup the **Sprite Frame** in the `sprite-item` using the same name as the item from the prepared assets. | ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-3.png) |
    | 4 | - Set the **String** and adjust **Color**, **Font** and **Font Size** in the `description` according to the game design.<br/> - Use [Bitmap Font Creator](http://localhost:3000/docs/category/game-asset-structure) if you need to create a Bitmap Font. | ![Locate Prefabs](./img/07-item-description/setup-item-no-odds-4.png) |

item-description-big

Setup the `item-description-big` prefab for items that include both a win payout and a description:
 
    ![Locate Prefabs](./img/07-item-description/setup-item-big-overview.png) 

    | Step | Action | Image Reference |
    | :--: | :----- | :-------------: |
    | 1 | - Setup the **Sprite Frame** in the `background` using the prepared assets. | <img width="1000"/>![Locate Prefabs](./img/07-item-description/setup-item-big-1.png) |
    | 2 | - Setup the payout by following **Step 4** in **Setup prefab `item-description-small`** | [Configure Item Description Small](./item-description#item-description-small) | |
    | 3 | - Setup the description by following **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 according to the game design. 2. Use prepared bitmap fonts to Setup the Labels font. 3. Click Set Size to run the helper. 4. Setup the Background, Sprite Frame, Animation, Payout, Description of the item using the prepared assets.

![Locate Prefabs](./img/07-item-description/setup-item-helper.png)

:::

5.0 KiB Raw Blame History