T4 Modules Howto Guide/Objects - Revision history

BDota at 14:57, 29 September 2013

2013-09-29T14:57:44Z

Ibanix: Ibanix moved page Objects to T4 Modules Howto Guide/Objects: namespace collision prevention

2013-07-08T18:36:48Z

Ibanix moved page Objects to T4 Modules Howto Guide/Objects: namespace collision prevention

Ibanix at 21:11, 6 July 2013

2013-07-06T21:11:50Z

66.225.111.10 at 05:04, 29 May 2013

2013-05-29T05:04:08Z

66.225.111.10 at 05:03, 29 May 2013

2013-05-29T05:03:02Z

66.225.111.10 at 05:00, 29 May 2013

2013-05-29T05:00:40Z

66.225.111.10 at 00:01, 29 May 2013

2013-05-29T00:01:28Z

66.225.111.10 at 00:01, 29 May 2013

2013-05-29T00:01:00Z

66.225.111.10: Created page with "

Objects: Loot and Equipment

Editing the Example Module to use ActorInventory

If your module will make use of objects and equipment, s..."

2013-05-29T00:00:34Z

Created page with "<h1 id="toc0">Objects: Loot and Equipment</h1> <h2 id="toc1">Editing the Example Module to use ActorInventory</h2> <p>If your module will make use of objects and equipment, s..."

New page

<h1 id="toc0">Objects: Loot and Equipment</h1>

<h2 id="toc1">Editing the Example Module to use ActorInventory</h2>
<p>If your module will make use of objects and equipment, some changes are needed to the code since the example module does not by default use the ActorInventory class.</p>

<p>In your load.lua you should call at the top of the file <br />

<pre><code>local ActorInventory = require "engine.interface.ActorInventory"</code></pre>

<br />
You can then define slots through the command:<br />

<pre><code>ActorInventory:defineInventory("SLOT", "slot name", IS_WORN, "slot desc")</code></pre>

<br />
with SLOT being the slot's codeside identifier, "slot name" being the display name of the slot, IS_WORN being a boolean that determines if its a worn slot or a container slot and "slot_desc" is the description of the slot.</p>

<p>You will also then have to edit the module's /class/Actor.lua file.<br />
Add<br />

<pre><code>require "engine.interface.ActorInventory"</code></pre>

<br />
to the requires at the top of the file and add the <a href="/web/20120511160109/http://engine.interface.actorinventory/">engine.interface.ActorInventory</a> to its inheritances:<br />

<pre>module(..., package.seeall, class.inherit(
engine.Actor,
engine.interface.ActorInventory, -- Add this line to whatever is already there!
engine.interface.ActorTemporaryEffects,
engine.interface.ActorLife,
engine.interface.ActorProject,
engine.interface.ActorLevel,
engine.interface.ActorStats,
engine.interface.ActorTalents,
engine.interface.ActorResource,
engine.interface.ActorFOV,
mod.class.interface.Combat
))</pre>

</p>

<p>THEN, in the _M:init(t, no_default) function add:<br />

<pre>engine.interface.ActorInventory.init(self, t)</pre>

</p>

<p>Now you need to tell the game what slots each specific Actor can use. Say you used the defineInventory function to add the "MAINHAND", "OFFHAND", "HEAD", and "BODY" slots to the game. You should put the following table into the [[t4modules t4modules:4emodule_2|birth descriptor]] for your player:<br />

<pre> body = { INVEN = 10, MAINHAND = 1, OFFHAND = 1, BODY = 1, HEAD = 1 },</pre>

<br />
Your player can know carry 10 items (the INVEN slots) and have one piece of equipment in each of the other slots. NPCs work the same way, by adding a body table to their <a class="" style="" href="/web/20120511160109/http://te4.org/wiki/t4modules-t4modules-npcs">newentity definition</a>. For example a headless horseman would use this code:<br />

<pre> body = { INVEN = 10, MAINHAND = 1, OFFHAND = 1, BODY = 1 },</pre>

<br />
Notice the missing HEAD slot, which tells the game that this NPC cannot use any equipment marked for the HEAD slot!</p>

<h2 id="toc2">Adding objects</h2>
<p>Now that the game has an inventory system implemented you can start making objects. For now let us put the objects into the "data/zones/dungeon/objects.lua" file. How about adding some weapons to the Example module? Let us start with a two-handed battleaxe:</p>

<pre>newEntity{
define_as = "BASE_BATTLEAXE",
slot = "MAINHAND",
slot_forbid = "OFFHAND",
type = "weapon", subtype="battleaxe",
display = "/", color=colors.SLATE,
encumber = 3,
rarity = 5,
combat = { sound = "actions/melee", sound_miss = "actions/melee_miss", },
name = "a generic battleaxe",
desc = [[t4modules massive two-handed battleaxes.]],
}

newEntity{ base = "BASE_BATTLEAXE",
name = "iron battleaxe",
level_range = {1, 10},
require = { stat = { str=11 }, },
cost = 5,
combat = {
dam = 10,
},
}</pre>

<p>There is a lot going on in there. First, notice we define a "BASE_BATTLEAXE" that specific types of battleaxes can inherit from. This stores things like which slots the battleaxe can be equipped in (this is what we set up above), which slots this will stop us from using, and some other properties like encumbrance, rarity and description. Second, we make a specific type of iron battleaxe that inherits using the "base" variable. The resulting entity will have all of the properties of the base entity except when there is an explicit conflict. An example of this is the "name" variable. The name variable from the iron battleaxe will overwrite the "a generic battleaxe" name from the base entity. Tables will not overwrite each other, instead they will merge. This can be seen in the "combat" variable, which in the iron battleaxe will be a table with the "sound" and "sound_miss" from the base class and the "dam" from the child class.</p>

<h2 id="toc3">Adding objects to a Zone</h2>
<p>The "objects.lua" file for the dungeon zone now has some objects in it, but we need to tell T-Engine how many objects to add to the zone and where to put them. This is handled by a generator, and we tell T-Engine which generator to use in the "zone.lua" file. If you open up zone.lua you see that there are already generator entries for the map and the actors:<br />

<pre> generator = {
map = {
class = "engine.generator.map.Roomer",
nb_rooms = 10,
rooms = {"simple", "pilar"},
lite_room_chance = 100,
['.'] = "FLOOR",
['#'] = "WALL",
up = "UP",
down = "DOWN",
door = "DOOR",
},
actor = {
class = "engine.generator.actor.Random",
nb_npc = {20, 30},
},
},</pre>

<br />
Well we need to add a generator for objects, too! This code will do the trick if added right after the actor = {...} line:<br />

<pre> object = {
class = "engine.generator.object.Random",
nb_object = {20, 30},
},</pre>

<br />
Now T-Engine will randomly generate and drop 20-30 objects. Give it a try!</p>

<p><strong>The next step is to implement [[Inventory Dialogs]]</p>

Go back to [[T4modules-module-howto-guides]]

← Older revision		Revision as of 14:57, 29 September 2013
Line 124:		Line 124:

	Go back to [[T4 Modules Howto Guide]]		Go back to [[T4 Modules Howto Guide]]
		+
		+	{{Module Guides}}

← Older revision		Revision as of 21:11, 6 July 2013
Line 123:		Line 123:
	<p>The next step is to implement [[Inventory Dialogs]]</p>		<p>The next step is to implement [[Inventory Dialogs]]</p>

−	Go back to [[~~T4modules-module-howto-guides~~]]	+	Go back to [[T4 Modules Howto Guide]]

@@ Line 46: / Line 46: @@
 </p>
-<p>Now you need to tell the game what slots each specific Actor can use.  Say you used the defineInventory function to add the &quot;MAINHAND&quot;, &quot;OFFHAND&quot;, &quot;HEAD&quot;, and &quot;BODY&quot; slots to the game.  You should put the following table into the [[t4modules t4modules:4emodule_2|birth descriptor]] for your player:<br />
+<p>Now you need to tell the game what slots each specific Actor can use.  Say you used the defineInventory function to add the &quot;MAINHAND&quot;, &quot;OFFHAND&quot;, &quot;HEAD&quot;, and &quot;BODY&quot; slots to the game.  You should put the following table into the birth descriptor for your player:<br />
 <pre>    body = { INVEN = 10, MAINHAND = 1, OFFHAND = 1, BODY = 1, HEAD = 1 },</pre>
 <br />
-Your player can know carry 10 items (the INVEN slots) and have one piece of equipment in each of the other slots.  NPCs work the same way, by adding a body table to their [[NPCS]] newentity definition. For example a headless horseman would use this code:<br />
+Your player can know carry 10 items (the INVEN slots) and have one piece of equipment in each of the other slots.  NPCs work the same way, by adding a body table to their [[NPCs]] newEntity definition. For example a headless horseman would use this code:<br />
 <pre>    body = { INVEN = 10, MAINHAND = 1, OFFHAND = 1, BODY = 1 },</pre>

@@ Line 6: / Line 6: @@
 <p>In your load.lua you should call at the top of the file <br />
-<pre><code>local ActorInventory = require &quot;engine.interface.ActorInventory&quot;</code></pre>
+<pre>local ActorInventory = require &quot;engine.interface.ActorInventory&quot;</pre>
 <br />
 You can then define slots through the command:<br />
-<pre><code>ActorInventory:defineInventory(&quot;SLOT&quot;, &quot;slot name&quot;, IS_WORN, &quot;slot desc&quot;)</code></pre>
+<pre>ActorInventory:defineInventory(&quot;SLOT&quot;, &quot;slot name&quot;, IS_WORN, &quot;slot desc&quot;)</pre>
 <br />
@@ Line 19: / Line 19: @@
 Add<br />
-<pre><code>require &quot;engine.interface.ActorInventory&quot;</code></pre>
+<pre>require &quot;engine.interface.ActorInventory&quot;</pre>
 <br />

← Older revision	Revision as of 18:36, 8 July 2013
(No difference)

@@ Line 22: / Line 22: @@
 <br />
-to the requires at the top of the file and add the <a href="/web/20120511160109/http://engine.interface.actorinventory/">engine.interface.ActorInventory</a> to its inheritances:<br />
+to the requires at the top of the file and add the engine.interface.ActorInventory to its inheritances:<br />
 <pre>module(..., package.seeall, class.inherit(

@@ Line 121: / Line 121: @@
 Now T-Engine will randomly generate and drop 20-30 objects.  Give it a try!</p>
-<p><strong>The next step is to implement [[Inventory Dialogs]]</p>
+<p>The next step is to implement [[Inventory Dialogs]]</p>
 Go back to [[T4modules-module-howto-guides]]