Source:NetHack 3.4.3/include/obj.h - Revision history

Umbire the Phantom: potholes

2026-04-06T09:49:47Z

potholes

Umbire the Phantom: potholes et. al.

2025-01-29T15:39:26Z

potholes et. al.

Furey: Link to 3.4.3 source files, not 3.6.1 source files.

2024-06-26T20:47:49Z

Link to 3.4.3 source files, not 3.6.1 source files.

Furey: Fix instructions for linking to a particular line. Current instructions incorrectly link to a different version of NetHack.

2024-06-22T17:28:00Z

Fix instructions for linking to a particular line. Current instructions incorrectly link to a different version of NetHack.

Furey: /* useful macros */ delete fluff words "in an appropriate way for the platform". Deletes a redlink.

2024-06-17T07:04:08Z

‎useful macros: delete fluff words "in an appropriate way for the platform". Deletes a redlink.

Furey: /* Items from dragons, dwarves, elves, gnomes */ fix typo. fixes redlink.

2024-06-17T06:50:20Z

‎Items from dragons, dwarves, elves, gnomes: fix typo. fixes redlink.

Furey: /* struct obj */ elvish dagger -> elven dagger. Fixes a redlink. As always, this is in our annotations, not in the code.

2024-06-16T22:45:47Z

‎struct obj: elvish dagger -> elven dagger. Fixes a redlink. As always, this is in our annotations, not in the code.

Furey: Delinkify "bitfields". This is source code commentary.

2024-06-16T20:31:29Z

Delinkify "bitfields". This is source code commentary.

Furey: Delinkify "bit mask". This is in source code commentary. Fixes a red link.

2024-06-16T20:30:04Z

Delinkify "bit mask". This is in source code commentary. Fixes a red link.

Paxedbot: moved Source:Obj.h to Source:NetHack 3.4.3/include/obj.h: Moving src to subdirs

2011-01-31T19:19:04Z

moved Source:Obj.h to Source:NetHack 3.4.3/include/obj.h: Moving src to subdirs

@@ Line 150: / Line 150: @@
 Here are some more boolean bits.
 * Even though an object might erode two ways, there is exactly one "erodeproof" flag - setting it prevents both types of erosion. This is why using the [[scroll of enchant weapon]] while [[confused]] will erodeproof any weapon. If <tt>obj->rknown</tt> is true than the code in [[Source:NetHack 3.4.3/src/objnam.c|objnam.c]] will refer to an erodeproof object as "fixed" if it is a [[crysknife]], else rustproof if the metal would normally rust, else corrodeproof if the metal would normally corrode, else fireproof if the object would be flammable. For example, an erodeproof [[dragon scale mail]] would never be marked as such in your [[inventory]], because dragon scales are neither crysknives nor rustprone nor corrodeable nor flammable.
-* <tt>thing->olocked</tt> is set if an object such a [[chest]] or [[box]] is [[locked]]; <tt>thing->obroken</tt> if the lock is broken (though [[you]] could fix it with [[wizard lock]]).
+* <tt>thing->olocked</tt> is set if an object such a [[chest]] or [[large box]] is [[locked]]; <tt>thing->obroken</tt> if the lock is broken (though [[you]] could fix it with [[wizard lock]]).
-* <tt>thing->otrapped</tt> (or synonym <tt>thing->opoisoned</tt>) indicates that a weapon is [[poison]]ed or that the [[chest]] or [[box]] contains a trap (which might be a flame or poison needle when you open it).
+* <tt>thing->otrapped</tt> (or synonym <tt>thing->opoisoned</tt>) indicates that a weapon is [[poison]]ed or that the [[chest]] or [[large box]] contains a trap (which might be a flame or poison needle when you open it).
   <span id="line80">80.   	Bitfield(recharged,3);	/* number of times it's been recharged */</span>

@@ Line 273: / Line 273: @@
 These macros act as functions to test various properties of weapons. Some of these work by querying the class of the object, others look in the <tt>objects</tt> global array for more information about objects of that type.
-For example, a "launcher" (<tt>is_launcher(thing)</tt>) is any weapon that needs [[you]]r "bow" or "crossbow" [[skill]]. That is, if you can use your bow or crossbow skill with the object, then the object qualifies as a bow or crossbow for the purposes of the game. So [[wield]] it, quiver those [[arrow]]s or [[crossbow bolt]]s, and [[fire]]!
+For example, a "launcher" (<tt>is_launcher(thing)</tt>) is any weapon that needs [[you]]r "bow" or "crossbow" [[skill]]. That is, if you can use your bow or crossbow skill with the object, then the object qualifies as a bow or crossbow for the purposes of the game. So [[wield]] it, quiver those [[arrow]]s or [[crossbow bolt]]s, and start [[firing]]!
 ==== armor ====

@@ Line 64: / Line 64: @@
 * <tt>thing->ox</tt> and <tt>thing->oy</tt> are object coordinates on the map.
 * <tt>thing->otyp</tt> is the object type from onames.h. Those definitions are generated when compiling, each object definition in objects.c gets one.
-* <tt>thing->owt</tt> is the total weight of this object. use <tt>weight()</tt> in [[mkobj.c]] to calculate this.
+* <tt>thing->owt</tt> is the total weight of this object. use <tt>weight()</tt> in [[Source:NetHack 3.4.3/src/mkobj.c|mkobj.c]] to calculate this.
 Some items [[stack]]. That is when multiple items take only one spot in your [[inventory]] or other lists, for example, "2 [[dagger]]s" or "7 [[candle]]s". If <tt>thing->quan</tt> is 2 or 7, then 2 or 7 of those things are stacked.
@@ Line 90: / Line 90: @@
   <span id="line44">44.   </span>
-* <tt>thing->oclass</tt> is one of the <tt>_CLASS</tt> definitions from [[objclass.h]], eg. WEAPON_CLASS or POTION_CLASS, and is the class that represents the object on the screen.
+* <tt>thing->oclass</tt> is one of the <tt>_CLASS</tt> definitions from [[Source:NetHack 3.4.3/include/objclass.h|objclass.h]], eg. WEAPON_CLASS or POTION_CLASS, and is the class that represents the object on the screen.
 * An object in your [[inventory]] will have a letter [a-zA-Z], stored for example at <tt>thing->invlet</tt>. Even after an object is dropped, the object will try to remember its old inventory letter. Suppose [[you]] drop a [[spellbook]] which was inventory letter "B". If [[you]] retake the spellbook, the [[fixinv]] option is on, and the letter "B" is available, then the spellbook will again be letter "B" in your inventory.
 * NetHack has a separate array for [[artifact]]s, defined in artilist.h
@@ Line 112: / Line 112: @@
   <span id="line56">56.   </span>
-Timers are for rotting eggs and corpses, for example. Do not change this by hand, rather use the code in [[timeout.c]], see <tt>start_timer()</tt>
+Timers are for rotting eggs and corpses, for example. Do not change this by hand, rather use the code in [[Source:NetHack 3.4.3/src/timeout.c|timeout.c]], see <tt>start_timer()</tt>
   <span id="line57">57.   	Bitfield(cursed,1);</span>
@@ Line 149: / Line 149: @@
 Here are some more boolean bits.
-* Even though an object might erode two ways, there is exactly one "erodeproof" flag - setting it prevents both types of erosion. This is why using the [[scroll of enchant weapon]] while [[confused]] will erodeproof any weapon. If <tt>obj->rknown</tt> is true than the code in [[objnam.c]] will refer to an erodeproof object as "fixed" if it is a [[crysknife]], else rustproof if the metal would normally rust, else corrodeproof if the metal would normally corrode, else fireproof if the object would be flammable. For example, an erodeproof [[dragon scale mail]] would never be marked as such in your [[inventory]], because dragon scales are neither crysknives nor rustprone nor corrodeable nor flammable.
+* Even though an object might erode two ways, there is exactly one "erodeproof" flag - setting it prevents both types of erosion. This is why using the [[scroll of enchant weapon]] while [[confused]] will erodeproof any weapon. If <tt>obj->rknown</tt> is true than the code in [[Source:NetHack 3.4.3/src/objnam.c|objnam.c]] will refer to an erodeproof object as "fixed" if it is a [[crysknife]], else rustproof if the metal would normally rust, else corrodeproof if the metal would normally corrode, else fireproof if the object would be flammable. For example, an erodeproof [[dragon scale mail]] would never be marked as such in your [[inventory]], because dragon scales are neither crysknives nor rustprone nor corrodeable nor flammable.
 * <tt>thing->olocked</tt> is set if an object such a [[chest]] or [[box]] is [[locked]]; <tt>thing->obroken</tt> if the lock is broken (though [[you]] could fix it with [[wizard lock]]).
 * <tt>thing->otrapped</tt> (or synonym <tt>thing->opoisoned</tt>) indicates that a weapon is [[poison]]ed or that the [[chest]] or [[box]] contains a trap (which might be a flame or poison needle when you open it).
@@ Line 355: / Line 355: @@
 These macros facilitate code that needs to know about [[dragon scales]], [[dragon scale mail]] and their matching [[dragon]]s. It assumes that the range of dragon colors starts with gray and ends with yellow. The <tt>obj</tt> parameter is a pointer to an object, but these macros only examine the object type.
-If a monster does [[polymorph]] while wearing dragon scales or dragon scale mail, the code uses <tt>Dragon_scales_to_pm</tt> or <tt>Dragon_mail_to_pm</tt> to polymorph you into the matching dragon: [[mon.c#line2351]], [[muse.c#line1684]]. Then the game disables the message that the dragon would break out of its armor: [[worn.c#line605]]. (The code in [[polyself.c]] uses a separate function called [[polyself.c#armor_to_dragon |<tt>armor_to_dragon</tt>]].)
+If a monster does [[polymorph]] while wearing dragon scales or dragon scale mail, the code uses <tt>Dragon_scales_to_pm</tt> or <tt>Dragon_mail_to_pm</tt> to polymorph you into the matching dragon: [[Source:NetHack 3.4.3/src/mon.c#line2351|mon.c#line2351]], [[Source:NetHack 3.4.3/src/muse.c#line1684|muse.c#line1684]]. Then the game disables the message that the dragon would break out of its armor: [[Source:NetHack 3.4.3/src/worn.c#line605|worn.c#line605]]. (The code in [[Source:NetHack 3.4.3/src/polyself.c|polyself.c]] uses a separate function called [[Source:NetHack 3.4.3/src/polyself.c#armor_to_dragon |<tt>armor_to_dragon</tt>]].)
   <span id="line235">235.  #define Dragon_to_scales(pm)	(GRAY_DRAGON_SCALES + (pm - mons))</span>
   <span id="line236">236.  </span>
-Do not use the <tt>Dragon_to_scales</tt> macro! The [[DevTeam]] left this broken and incorrect definition of a macro, but never called this macro from the NetHack source code. If <tt>pm</tt> is a monster type (an index into the <tt>mons</tt> array), then the correct version of the macro would expand to <tt>(GRAY_DRAGON_SCALES + (pm - PM_GRAY_DRAGON))</tt>. NetHack uses the correct formula at [[mon.c#line194]] to pick the correct scales for the [[death drop]] of a dragon.
+Do not use the <tt>Dragon_to_scales</tt> macro! The [[DevTeam]] left this broken and incorrect definition of a macro, but never called this macro from the NetHack source code. If <tt>pm</tt> is a monster type (an index into the <tt>mons</tt> array), then the correct version of the macro would expand to <tt>(GRAY_DRAGON_SCALES + (pm - PM_GRAY_DRAGON))</tt>. NetHack uses the correct formula at [[Source:NetHack 3.4.3/src/mon.c#line194|mon.c#line194]] to pick the correct scales for the [[death drop]] of a dragon.
   <span id="line237">237.  /* Elven gear */</span>
@@ Line 389: / Line 389: @@
   <span id="line262">262.  </span>
-These macros tests if an object is elven, orcish, dwarvish or gnomish. (How is this important, and where are the definitions of the is_''foo''_armor macros?) These macros are boolean expressions that check if the object is of one type or another; the macro for is_elven_weapon literally checks the object against the macro's list of six known elven weapons. If you added a new elven weapon to [[objects.c]], then you would also have to add it to this macro.
+These macros tests if an object is elven, orcish, dwarvish or gnomish. (How is this important, and where are the definitions of the is_''foo''_armor macros?) These macros are boolean expressions that check if the object is of one type or another; the macro for is_elven_weapon literally checks the object against the macro's list of six known elven weapons. If you added a new elven weapon to [[Source:NetHack 3.4.3/src/objects.c|src/objects.c]], then you would also have to add it to this macro.
-One may consider refactoring this, so that <tt>struct objclass</tt> in [[objclass.h]] contains new bitfields oc_elven, oc_orcish, oc_dwarvish, oc_gnomish. Then one would have macros like so,
+One may consider refactoring this, so that <tt>struct objclass</tt> in [[Source:NetHack 3.4.3/include/objclass.h|objclass.h]] contains new bitfields oc_elven, oc_orcish, oc_dwarvish, oc_gnomish. Then one would have macros like so,
   /* not part of NetHack */
@@ Line 397: / Line 397: @@
   #define is_elven_object(otmp) (objects[otmp->otyp].oc_elven)
-Then we could adjust the macros in [[objects.c]] to clear the oc_orcish on most objects, but to set the flag on orcish objects. The advantage is that it slightly easier for a [[variant]] to add a new type of orcish object to the game. The disadvantage is that the vast majority of object types are neither elven nor orcish nor dwarvish nor gnomish, so we would be allocating four extra zero bits (negligible with yesterday's computers) for each object type.
+Then we could adjust the macros in [[Source:NetHack 3.4.3/src/objects.c|objects.c]] to clear the oc_orcish on most objects, but to set the flag on orcish objects. The advantage is that it slightly easier for a [[variant]] to add a new type of orcish object to the game. The disadvantage is that the vast majority of object types are neither elven nor orcish nor dwarvish nor gnomish, so we would be allocating four extra zero bits (negligible with yesterday's computers) for each object type.
 ==== Candles, lamps ====

@@ Line 1: / Line 1: @@
 __MIXEDSYNTAXHIGHLIGHT__
-Below is the full text to include/obj.h from NetHack 3.4.3. To link to a particular line, write [[obj.h#line123|<nowiki>[[obj.h#line123]]</nowiki>]], for example.
+Below is the full text to include/obj.h from NetHack 3.4.3. To link to a particular line, write [[Source:NetHack 3.4.3/include/obj.h#line123]], for example.
 This particular file contains C-language declarations for [[object]]s. In particular, it declares <tt>struct obj</tt>, the data structure representing an [[object]] in the dungeon. This data structure contains many fields about the object, such as the type of the object, the [[BUC]] status, the number of charges, the erosion, the quantity of this object in a stack, the pointer to the [[monster]] presently carrying it, the flag indicating whether the player has [[identify|identified]] the object, and many other fields.

@@ Line 208: / Line 208: @@
   <span id="line114">114.  </span>
-* <tt>newobj</tt> uses the <tt>alloc</tt> function of NetHack to dynamically allocate memory in an appropriate way for the [[platform]]. For example, <tt>thing = newobj(10)</tt> allocates an object with 10 extra bytes, and stores a pointer to that object in <tt>thing</tt>.
+* <tt>newobj</tt> uses the <tt>alloc</tt> function of NetHack to dynamically allocate memory. For example, <tt>thing = newobj(10)</tt> allocates an object with 10 extra bytes, and stores a pointer to that object in <tt>thing</tt>.
 * <tt>ONAME(thing)</tt> returns a character pointer to text that NetHack can store in the extra memory after an object. Recall that <tt>thing->oextra[0]</tt> is the "long int" defined at the end of the struct, thus <tt>thing->oextra</tt> is a pointer into the end of the struct. Either <tt>thing->oxlth</tt> is zero, or there is extra information before the text that we need to skip.

@@ Line 80: / Line 80: @@
 This gives a ''spe''cial statistic for certain types of items.
-* If <tt>thing</tt> was a +1 [[elvish dagger]], then <tt>thing->spe</tt> is 1.
+* If <tt>thing</tt> was a +1 [[elven dagger]], then <tt>thing->spe</tt> is 1.
 * If it is a [[wand of wishing]] (0:3), a wand with three charges, then <tt>thing->spe</tt> is 3.
 * This statistic also provides certain information about [[egg]]s, [[spinach]], [[fruit]], [[iron ball]]s (?), and [[amulet]]s.

@@ Line 124: / Line 124: @@
   <span id="line65">65.   </span>
-[[Bitfield]]s use less than one byte in a struct. Most of these are obvious, like [[cursed]] or [[blessed]]. Four of these indicate what the adventurer knows about this object. In a game with more than one adventurer, these fields could not be stored in the object. Programming multiplayer [[NetHack]] would require many changes.
+Bitfields use less than one byte in a struct. Most of these are obvious, like [[cursed]] or [[blessed]]. Four of these indicate what the adventurer knows about this object. In a game with more than one adventurer, these fields could not be stored in the object. Programming multiplayer [[NetHack]] would require many changes.
   <span id="line66">66.   	Bitfield(oeroded,2);	/* rusted/burnt weapon/armor */</span>

@@ Line 83: / Line 83: @@
 * If it is a [[wand of wishing]] (0:3), a wand with three charges, then <tt>thing->spe</tt> is 3.
 * This statistic also provides certain information about [[egg]]s, [[spinach]], [[fruit]], [[iron ball]]s (?), and [[amulet]]s.
-* For [[statue]]s, this field is a [[bit mask]]. If <tt>thing->spe & STATUE_HISTORIC</tt>, then the statue is [[historic]]. Likewise, a statue can be [[male]] or [[female]]. It can be simultaneously historic, male, and female, though the last two might not combine well.
+* For [[statue]]s, this field is a bit mask. If <tt>thing->spe & STATUE_HISTORIC</tt>, then the statue is [[historic]]. Likewise, a statue can be [[male]] or [[female]]. It can be simultaneously historic, male, and female, though the last two might not combine well.
   <span id="line41">41.   	char	oclass;		/* object class */</span>

← Older revision	Revision as of 19:19, 31 January 2011
(No difference)