Differences

This shows you the differences between two versions of the page.

--- item_container_tutorial [2017/12/06 08:41] – justin
+++ item_container_tutorial [2017/12/06 13:51] (current) – justin
@@ Line 2: / Line 2: @@
 ----
-This tutorial demonstrates how to add an item container to a map. For this walk-through, we will add a treasure chest to our main map that will contain some items for the player to retrieve.
+This tutorial demonstrates how to add an [[item container]] to a [[map]]. For this walk-through, we will add a treasure chest to our main [[map]] that will contain some [[item|items]] for the [[player_character|player]] to retrieve.
-To begin, open the map that you want to add an item container to in the Map Editor and switch to Place Mode.
+**Note:** This tutorial assumes that you already understand the basics of navigating around the [[Map Editor]].
+To begin, open the [[map]] that you want to add an [[item container]] to in the [[Map Editor]] and switch to "Place" mode.
 {{:wiki:place_mode_button.png?nolink|}}
-Select the object that you want to be an item container from the resource selection sidebar and place it into the map in the desired location. For this example, I will be placing a treasure chest.
+Select the [[object]] that you want to be an [[item container]] from the resource selection panel on the right and place it into the [[map]] in the desired location. For this example, I will be placing a treasure chest.
 {{:wiki:item_container_place_chest.gif?nolink|}}
-Next, switch the Map Editor into Edit Mode so the necessary modifications can be made to the object.
+Next, switch the [[Map Editor]] into "Edit" mode so the necessary modifications can be made to the [[object]].
 {{:wiki:edit_mode_button.png?nolink|}}
-Right-click on your object and select Properties from the context menu.
+Right-click on your [[object]] and select "Properties" from the context menu.
 {{:wiki:item_container_popup_menu.png?nolink|}}
-In the Properties dialog, check the Item Container checkbox to indicate that you want to allow this object to contain items. Double-click any items that you wish to initially be within the item container - this will add them to the box on the right labelled Items in Container. Click the Close button once you are finished. It is not required to add any items initially, as you may just want the object to act as an item container without having anything in it at the start of the game.
+In the Properties dialog, check the [[Item Container]] checkbox to indicate that you want this [[object]] to behave as a container. Double-click any [[item|items]] that you wish to initially be included in the [[item container]] - this will add them to the box on the right labelled "Items in Container". Click the OK button once you are finished. It is not required to add any [[item|items]] initially, as you may just want the [[object]] to act as an [[item container]] but initially be empty at the start of the game.
-Note: You can also added a script to the object if you would like an event to occur when the player opens the item container. For example, you could play an opening animation for the object:
-play_animation(self, "open")
 {{:wiki:item_container_properties.png?nolink|}}
-If markers are enabled in the Map Editor, an item container marker (a "box" icon) will appear over the object to indicate that the object is now an item container.
+**Note:** You can also add a [[script]] to the [[object]] to have an event occur when the [[player_character|player]] opens the [[item container]] and an "On Close" [[script]] for when the [[player_character|player]] closes the container window or steps away from it. For example, you could play an opening [[animation]] for the [[object|object's]] main [[script]]:
+<code lua>
+play_animation(self, "open")
+</code>
+And a closing [[animation]] for the "On Close" [[script]]
+<code lua>
+play_animation(self, "close")
+</code>
+If markers are enabled in the [[Map Editor]], an [[item container]] marker ({{:wiki:box.png?nolink|}}) will appear over the object to indicate that the object is now an item container once you've closed the Properties dialog. You'll also see a [[script]] marker if you assigned a [[script]] to the [[object]].
 {{:wiki:item_container_markers.png?nolink|}}
-There is one more step to ensure that the player can interact with the item container. When I placed the treasure chest, the Map Editor removed any navigation/interaction paths to the tile that the chest sits on because the object is not designated as "walkable". First, decide which adjacent tiles the player should be able to interact with the item container from. In this case, there are two adjacent tiles from which the player should be able to access the chest. For each one, select the tile that the item container is on and the adjacent tile, then right-click to bring up the context menu. Go to the Navigation/Interaction sub-menu and select Interact Only. This will allow the player to open the item container from the adjacent tile.
+There is one more step to ensure that the [[player_character|player]] can interact with the [[item container]]. When I placed the treasure chest, the [[Map Editor]] removed any [[navigation_and_interaction|navigation paths]] to the [[tile]] that the chest is located on because the [[object]] is configured as being not passable. First, decide which adjacent [[tile|tiles]] the [[player_character|player]] should be able to interact with the [[item container]] from. In this case, there are two adjacent [[tile|tiles]] from which the [[player_character|player]] should be able to access the chest.
+To do so, switch the [[Map Editor]] into "Connect" mode.
 {{:wiki:connect_mode_button.png?nolink|}}
-s shown below, I have set the tile in front of the chest and to the left of the chest as Interact Only (displayed as orange lines by default).
+Select "Interact Only" (colored orange by default) from the Navigation Palette in the top left corner, then click and drag from each adjacent [[tile]] to either the treasure chest or the [[tile]] it's located on. This will allow the [[player_character|player]] to open the [[item container]] from these [[tile|tiles]]
 {{:wiki:item_container_connect_nav.gif?nolink|}}
-Save the map and then try out the item container in your exported game!
+Save the [[map]], [[exporting_your_game|export the game]], then try out the [[item container]] you've created!
+{{:wiki:item_container_in_game.gif?nolink|}}

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Differences

Page Tools

RPG in a Box
Official Documentation