Modding:Tutorial/The Infinite Arena - Revision history

Epyon at 12:29, 11 August 2025

2025-08-11T12:29:27Z

Game Hunter: /* Review */ new link

2012-04-08T16:49:57Z

‎Review: new link

Game Hunter: revised for 0996

2012-04-08T16:47:36Z

revised for 0996

Game Hunter: more debugging and links

2011-10-08T02:09:09Z

Game Hunter: /* Engine Hooks */ debugging

2011-10-08T02:02:26Z

‎Engine Hooks: debugging

Game Hunter: minor details

2011-10-06T20:34:36Z

minor details

Show changes

Game Hunter: small array-of-arrays fix

2011-10-04T01:43:08Z

small array-of-arrays fix

Game Hunter: finished explanations

2011-10-03T18:04:30Z

finished explanations

Game Hunter: /* Initialization Code */ added explanations

2011-10-03T16:55:50Z

‎Initialization Code: added explanations

Show changes

Game Hunter: added source template

2011-10-01T22:54:28Z

added source template

@@ Line 1: / Line 1: @@
 (NOTE: if you are unfamiliar with the general structure of the Hell's Arena module, it is suggested that you [[Modding:Tutorial/Recreating_Hell's_Arena|read the tutorial]] before proceeding, as many of the topics found there also are here, and will only be touched upon in this tutorial.)
-[[Hell's Arena]] is a fun little level, as it can be fairly difficult to complete without some grasp on DoomRL's mechanics, but pillar and monster placement aside, it is still a fairly static map. The following tutorial is a generalized version of Hell's Arena, coined the Infinite Arena, which has been reconstructed based on [[User:Yaflhdztioxo|yaflhdztioxo's]] design from v0.9.9.1. A fair number of seemingly-superfluous tools have also been created as a means to provide easy customization possibilities for those who want to quickly change the settings of the Arena. If nothing else, you will discover a variety of helper tools in this tutorial that may prove to be useful in your own modules.
+[[Hell's Arena]] is a fun little level, as it can be fairly difficult to complete without some grasp on DRL's mechanics, but pillar and monster placement aside, it is still a fairly static map. The following tutorial is a generalized version of Hell's Arena, coined the Infinite Arena, which has been reconstructed based on [[User:Yaflhdztioxo|yaflhdztioxo's]] design from v0.9.9.1. A fair number of seemingly-superfluous tools have also been created as a means to provide easy customization possibilities for those who want to quickly change the settings of the Arena. If nothing else, you will discover a variety of helper tools in this tutorial that may prove to be useful in your own modules.
 ==Special Concept: Custom Tables and Functions==

@@ Line 601: / Line 601: @@
 {{:Modding:Tutorial/The_Infinite_Arena/Source}}
-Source data: [http://dl.dropbox.com/u/33336094/inf_arena.module.zip inf_arena.module]
+Source data: [http://dl.dropbox.com/u/54818507/inf_arena.module.zip inf_arena.module]
-−
-WAD file: [http://dl.dropbox.com/u/33336094/inf_arena.wad inf_arena.wad]

@@ Line 132: / Line 132: @@
 ====mobGenStats====
 <source lang="lua">
---customize minLev/maxLev/weight of each enemy (defaults given)
+--customize min_lev/max_lev/weight of each enemy (defaults given)
 --for names of beings, check Object IDs in the modding documentation
 --be aware that JC auto-ends the game unless modified directly
 local mobGenStats = {
-     { being = "former",         minLev = 0,   maxLev = 12,  weight = 10 },
+     { being = "former",         min_lev = 0,   max_lev = 12,  weight = 10 },
-     { being = "sergeant",       minLev = 2,   maxLev = 15,  weight = 10 },
+     { being = "sergeant",       min_lev = 2,   max_lev = 15,  weight = 10 },
-     { being = "captain",        minLev = 8,   maxLev = 15,  weight = 10 },
+     { being = "captain",        min_lev = 8,   max_lev = 15,  weight = 10 },
      ....
+}
 </source>
-''mobGenStats'' is an array of tables: each table contains four fields relating to the being prototype. In each case, a being's identifier ''being'' is given, followed by a ''minLev'', ''maxLev'', and ''weight'' (all generation parameters). The purpose of ''mobGenStats'' is to switch particular values for others in the being prototypes that already exist. Normally this can be done for a particular enemy with the following line:
+''mobGenStats'' is an array of tables: each table contains four fields relating to the being prototype. In each case, a being's identifier ''being'' is given, followed by a ''min_lev'', ''max_lev'', and ''weight'' (all generation parameters). The purpose of ''mobGenStats'' is to switch particular values for others in the being prototypes that already exist. Normally this can be done for a particular enemy with the following line:
 <source lang="lua">
@@ Line 154: / Line 154: @@
 --changes the generation stats of enemies based on mobGenStats
 for _,v in ipairs(mobGenStats) do
-     beings[v.being].minLev = v.minLev
+     beings[v.being].min_lev = v.min_lev
-     beings[v.being].maxLev = v.maxLev
+     beings[v.being].max_lev = v.max_lev
      beings[v.being].weight = v.weight
 end
@@ Line 167: / Line 167: @@
 *''array'' is the array in question
-In this particular case, the loop iterates through each array and sets the being's ''minLev'', ''maxLev'', and ''weight'' (as found in the being prototype) to the values as determined by ''mobGenStats''. ''v.being'' is the same as a being's identifier from ''mobGenStats'', which is how the loop iterates through all being prototypes. In this way all of the beings in the prototype array can be changed quickly without a bunch of lines specifying each key and value.
+In this particular case, the loop iterates through each array and sets the being's ''min_lev'', ''max_lev'', and ''weight'' (as found in the being prototype) to the values as determined by ''mobGenStats''. ''v.being'' is the same as a being's identifier from ''mobGenStats'', which is how the loop iterates through all being prototypes. In this way all of the beings in the prototype array can be changed quickly without a bunch of lines specifying each key and value.
 <source lang="lua">
@@ Line 330: / Line 330: @@
 **finally, add the ammo stack to the player's inventory (and this process repeats as necessary)
 *if the item's ''type'' is not ITEMTYPE_AMMO:
-**a new foor loop is run, iterating as many times as items should be added for the particular item in question
+**a new for loop is run, iterating as many times as items should be added for the particular item in question
 **the item(s) are then added to the player's inventory, one by one
@@ Line 397: / Line 397: @@
      Level.name = "Infinite Arena"
      Level.name_number = 0
-     Level.fill("prwall")
+     Level.fill("rwall")
      local translation = {
      ["."] = "floor",
-     ["#"] = "prwall",
+     ["#"] = {"rwall", LFPERMANENT = true},
-     ["X"] = "pwall",
+     ["X"] = "rwall",
      [","] = "blood",
      [">"] = "stairs",

@@ Line 584: / Line 584: @@
 ===.OnMortem()===
 <source lang="lua">
-function arena.OnMortem()
+function inf_arena.OnMortem()
      local kill = player.killedby --calls kill descriptions from beings
-     if inf_arena.result then kill = arena.result end
+     if inf_arena.result then kill = inf_arena.result end
          player:mortem_print( " "..player.name..", level "..player.explevel.." "
                               .." "..klasses[player.klass].name..", "..kill )
@@ Line 599: / Line 599: @@
 The following is the entire source code for the Infinite Arena.
 {{:Modding:Tutorial/The_Infinite_Arena/Source}}

@@ Line 576: / Line 576: @@
      end
      --used in .OnMortem()
-     arena.result = "had enough of the gauntlet at wave "..Level.result()
+     inf_arena.result = "had enough of the gauntlet at wave "..Level.result()
 end
 </source>
@@ Line 586: / Line 586: @@
 function arena.OnMortem()
      local kill = player.killedby --calls kill descriptions from beings
-     if arena.result then kill = arena.result end
+     if inf_arena.result then kill = arena.result end
          player:mortem_print( " "..player.name..", level "..player.explevel.." "
                               .." "..klasses[player.klass].name..", "..kill )

@@ Line 79: / Line 79: @@
 big_table.small_table1[key1]  --identical to above
 big_table[small_table1].key1  --identical to above
-big_table[small_table1[key1]] --identical to above
+big_table[small_table1][key1] --identical to above
 big_array.1     --returns the contents of the first array in big_array
@@ Line 87: / Line 87: @@
 big_array.2[2]  --identical to above
 big_array[2].2  --identical to above
-big_array[2[2]] --identical to above
+big_array[2][2] --identical to above
 </source>

@@ Line 304: / Line 304: @@
                      --filled (and/or multiple) stacks
                      pack.ammo = pack.ammomax
                  end
                  player.inv:add(pack)
@@ Line 317: / Line 318: @@
 </source>
-build_pack() is another helper function, this time clearing the inventory of the player and adding in new items there. The input requires an array of tables, although the format is rather simple. Here is an example of an input for build_pack():
+build_pack() is another helper function, this time clearing the inventory of the player and adding in new items there. It uses the ''in ipairs()'' iteration method to check all variables in an array in the following way:
 <source lang="lua">
@@ Line 323: / Line 339: @@
      {name = "chaingun", amt = 1  }
      {name = "ammo",     amt = 360}
-     {name = "smed",     amt = 5}
+     {name = "smed",     amt = 5  }
+}
 </source>
@@ Line 329: / Line 345: @@
 Each table in the array requires only two fields: "name", which corresponds to the item's identifier, and "amt", which specifies how many of that item should be added. In the case of ammunition, the amount of ammo should be specified instead, as it is handled uniquely in order to produce an ideal number of stacks. The above example would add one chaingun, three 9mm ammo (x100) stacks, one 9mm ammo (x60) stack, and five small med-packs to the player's inventory. Keep in mind that the player can only hold 22 items, and any items added after 22 items have been added to the inventory will be disregarded.
-====build_announcement()====
+====build_announcerMsg()====
 <source lang="lua">
 local function build_announcerMsg(MSG)
@@ Line 338: / Line 354: @@
 </source>
-The build_announcement() function iterates through an array and selects a random index from a table within the array. The purpose of this simple function is to loop through a series of arrayed strings from anncrMsg and randomly pick strings from those arrays. build_announcement(anncrMsg.success) sets up three random messages from each array in its array, and build_announcement(anncrMsg.choose) sets up two random messages from each array in its array. (Setting up a lot of tables within tables can be confusing, but it becomes relatively simple as a means to organize variables together when compared to keeping track of each variable separately.)
+The build_announcerMsg() function iterates through an array and selects a random index from a table within the array. The purpose of this simple function is to loop through a series of arrayed strings from anncrMsg and randomly pick strings from those arrays. build_announcerMsg(anncrMsg.success) sets up three random messages from each array in its array, and build_announcerMsg(anncrMsg.choose) sets up two random messages from each array in its array. (Setting up a lot of tables within tables can be confusing, but it becomes relatively simple as a means to organize variables together when compared to keeping track of each variable separately.)
 ====get_corpses() and clear_corpses()====
@@ Line 355: / Line 371: @@
 end
 </source>
 get_corpses() is a quick function that creates a table, "corpseCells", and loops through all cells in the cell prototype array, selecting only those that contain the CF_CORPSE flag (indicating that the cell acts like a corpse) and adding it to corpseCells. This is often the most effective way to create a selective table of objects.
 <source lang="lua">
@@ Line 443: / Line 460: @@
 end
 </source>
 ===.OnEnter()===
@@ Line 467: / Line 486: @@
 end
 </source>
 ===.OnKill()===
@@ Line 475: / Line 498: @@
 end
 </source>
 ===.OnKillAll()===
@@ Line 494: / Line 519: @@
          build_announcerMsg(anncrMsg.success)
      end
+     ....
      local choice = ui.msg_confirm("Round " .. Level.result() + 1 .. " awaits. " ..
                                    "Do you want to continue the fight?")
@@ Line 507: / Line 537: @@
          --spawn enemies for next wave
          Level.flood_monsters(Generator.being_weight()*mob_scale_factor)
+     ....
      else --quitting
          if Level.result() == 1 then
@@ Line 529: / Line 564: @@
 end
 </source>
 ===.OnExit()===
@@ Line 543: / Line 579: @@
 end
 </source>
 ===.OnMortem()===
@@ Line 555: / Line 593: @@
 end
 </source>
 ==Review==
 {{:Modding:Tutorial/The_Infinite_Arena/Source}}

← Older revision		Revision as of 22:54, 1 October 2011
Line 637:		Line 637:

	==Review==		==Review==
−	{{Modding:Tutorial/The_Infinite_Arena/Source}}	+	{{:Modding:Tutorial/The_Infinite_Arena/Source}}