All content in this course uses:

Customize your game

This tutorial is a reference guide for further customization of the Creator Kit: Beginner Code game.

It provides guidance to help you use script templates to create:

Usable items with Usage Effects (like the health potion in the final tutorial)

It provides guidance on script templates which will help you create:

Usable Items with Usage Effects (like the health potion in the final tutorial)

This guide is a tool to help you consolidate your understanding  and experiment with the game, rather than a step-by-step guide. It might also be a useful environment to apply what you have learnt in other Unity tutorials!

This guide has the following structure:

 How to create an item type in Unity Editor

 How to create the custom effect script for that item, and basic guidance on using it

You’ve finished the Creator Kit: Beginner Code tutorial, but you’re not alone on your learning journey. If you have a question, or want to find out what other learners are doing with the game, why not join the 

Customizing the game

A Usable Item is an item that the player can 

 by double-clicking on it in their inventory (for example, a health potion). 

How do I create a Usable Item in Unity Editor?

Assets/Creator Kit - Beginner Code/Prefabs/InGameItem

  Right-click in the Project window and select 

 from the contextual menu. Alternatively, you can access this menu from 

This creates a new Asset for the Usable Item.

 In the Project window, right-click the new Usable Item and select 

Make sure that your Usable Item is still selected. In the Inspector, you will see the following fields (exposed variables):

 The Sprite that will be used in the inventory for the item. It will also be used to display the object in the world if no World Object Prefab is set (see below).

 The name of the item that will appear above it in the game, and in the tooltip in the player’s inventory.

 The description of the item that will be displayed in the tooltip in the player’s inventory.

 The 3D GameObject that will be created to show the Usable Item in the game world when it is spawned. If this is left empty (null), the item Sprite will be used instead.

 you have written. When you write a new effect, it will appear here. Select a Usage Effect to add it to your Usable Item. 



In the next step, you’ll learn how to write a Usage Effect script and apply it to your Usable Item.

Create a Usable Item

A Usage Effect script specifies what happens when a Usable Item is double-clicked in the player’s inventory. It is added to a Usable Item Asset in the Editor.


How do I create a new Usage Effect script?

To create a new Usage Effect script from the Creator Kit: Beginner Code template:

In the NameWindow dialog box that opens, give the Usage Effect script a name and select 

 In the Project window, double-click the script to open it in your code editor. We’ve provided a template script to help you write a Usage Effect for items:

 is a placeholder for your Usage Effect script name.

To customize the Usage Effect, you need to add instructions to the 

 of the character that used the item. In this game, there is only one character which can use items (the moose). You can use this parameter to access stats, inventory and equipment items to modify them. 

How do I find out more about the custom CharacterData class?

  In the top menu bar of the local documentation guide, select 

How do I set the return value for the Usable Item?

 function returns a Boolean value (true or false). Set it to:

 if the object is used and removed from the player’s inventory (if it's a stack of objects, the count will be reduced by one).

 if the object can’t be used (for example, you can test if health is already at maximum before adding health, and return false if it is so that a health potion won’t be wasted).

Write a Usage Effect script

When you’ve modified your Usage Effect script, you can add it to the Usable Item in the Editor:



  In the Project window, select the Usable Item you have created (filepath: 

field. Select your Usage Effect from the drop-down menu.



 If you want to remove the Usage Effect, select the minus button (

Apply the Usage Effect script to the Usable Item

 is an item that gives the player character particular attributes when equipped. (Weapons are a special kind of Equipment Item with additional functionality; this is explored separately later in this guide.)

You can give an Equipment Item:

A minimum stat requirement, which stops it from being equipped until the player achieves the minimum (for example, an item which can only be equipped when the player has over 5 HP).

An Equipped Effect, which adds an effect to the player character whilst the item is equipped (for example, raising their stats).

How do I create an Equipment Item in Unity Editor?

To create an Equipment Item in the Editor:

This creates a new Asset for the Equipment Item.

 In the Project window, right-click the new Equipment Item and select 

Make sure that your Equipment Item is still selected. In the Inspector, you will see the following fields (exposed variables):

The Equipment Slot on which the Equipment Item can be worn (for example, Head).

 status values required to equip the item. If the player doesn’t meet the minimum values for these stats, double-clicking the item in their inventory won’t do anything.

 you have written. When you write a new effect, it will appear here. Select an Equipped Effect to add it to your Equipment Item. 


In the next step, you’ll learn how to write an Equipped Effect script and apply it to your Equipment Item.

Create an Equipment Item

enables a custom effect when the player equips an item. It is added to an Equipment Item or Weapon in the Editor.

How do I create a new Equipped Effect script?

To create a new Equipped Effect script from the Creator Kit: Beginner Code template:

In the NameWindow dialog box that opens, give the Equipped Effect script a name and select 

 In the Project window, double-click the script to open it in your code editor. We’ve provided a template script to help you write an Equipped Effect:

 is a placeholder for your Equipped Effect script name.

you can customize in the Equipped Effect script:





This function is called when the player (user) 

. Use the function to add the effect — for example, to give the character a +1 Strength stat modifier.  



 You can use a private variable to store your chosen modifier.

This function is called when the player (user) 

. Use this function to remove the effect on the player character.

Write an Equipped Effect script

When you’ve modified your Equipped Effect script, you can add it to the Equipment Item in the Editor:

  In the Project window, select the Equipment Item you have created (go to 

field. Select your Equipped Effect from the drop-down menu.



 If you want to remove the Equipped Effect, select the minus button (

Apply the Equipped Effect script to an Equipment Item

 is a special Equipment Item that you can equip on the character Weapon Slot. 

In addition to the features of an ordinary Equipment Item, you can also give a Weapon:

, which enables you to customize what happens when the weapon damages an enemy character.

How do I create a Weapon in Unity Editor?

 In the Project window, right-click the new Weapon and select 

Make sure that the Weapon is still selected. In the Inspector, you will see the following fields (exposed variables) in addition to those available for all Equipped Items.

 How fast the Weapon attacks. This is the cooldown time between two attacks — the lower the value, the faster the next attack. If the value is 0, the next attack will be performed as soon as the first animation is finished.

 The minimum amount of damage the Weapon can do, before adding any character modifiers. 

 is a random value between the Minimum and Maximum Damage.

 The maximum amount of damage the Weapon can do, before adding any character modifiers. 

The distance at which the Weapon can damage an enemy character. If the target character is past the Range when the attack should connect, it won't do any damage.


 you have written. When you write a new effect, it will appear here. Select a Weapon Attack Effect to add it to your Weapon. 


In the next step, you’ll learn how to write a Weapon Attack Effect script and apply it to your Weapon.

 Create a Weapon

 script enables a customized effect when the Weapon hits a target. It is added to a Weapon.

How do I create a new Weapon Attack Effect script?

To create a new Weapon Attack Effect script from the Creator Kit: Beginner Code template:

Beginner Code > Create Weapon Attack Effect

In the NameWindow dialog box that opens, give the Weapon Effect script a name and select 

 In the Project window, double-click the script to open it in your code editor. We’ve provided a template script to help you write a Weapon Attack Effect for items:

 is a placeholder for your Weapon Attack Effect script name.

How do I customize the Weapon Attack Effect?

you can customize in the Weapon Attack Effect script:

1.  OnAttack(CharacterData target, CharacterData user, ref Weapon.AttackData attackData)

This function is for instructions which control what happens when the Weapon hits an enemy.  You can add damage or apply elemental effects to the target using the 

2.  void OnPostAttack(CharacterData target, CharacterData user, Weapon.AttackData data)

This function is called after all the OnAttack function instructions are executed. This enables you to customize things that happen in reaction to the 

 the target receives after all OnAttack effects are applied. 

For example, you could use this function to convert a percentage of damage to the enemy back into health for the player character. 

How do I find out more about the custom Weapon.AttackData class?

 enables you to query the amount of damage an enemy has received. To find out more about the 

Write a Weapon Attack Effect script

When you’ve modified your Weapon Attack Effect script, you can add it to the Weapon in the Editor:

Unity Version 2022.3