Files
nethack/include/monst.h
nhmall 0c3b9642e4 pmnames mons gender naming plus a window port interface change
add MALE, FEMALE, and gender-neutral names for individual monster species
to the mons array. The gender-neutral name (NEUTRAL) is mandatory, the
MALE and FEMALE versions are not.

replace code uses of the mname field of permonst with one of the three
potentially-available gender-specific names.

consolidate some separate mons entries that differed only by species into a
single mons entry (caveman, cavewoman and priest,priestess etc.)

consolidate several "* lord" and "* queen/* king" monst entries into
their single species, and allow both genders on some where it makes some
sense (there is probably more work and cleanup to come out of this at some
point, and the chosen gender-neutral name variations are not cast in stone
if someone has better suggestions).

related function or macro additions:
    pmname(pm, gender) to get the gender variation of the permonst name. It
    guards against monsters that haven't got anything except NEUTRAL naming
    and falls back to the NEUTRAL version if FEMALE and MALE versions are
    missing.

    Ugender to obtain the current hero gender.
    Mgender(mtmp) to obtain the gender of a monster

While the code can safely refer directly to pmnames[NEUTRAL] safely in the
code because it always exists, the other two (pmnames[MALE] and
pmnames[FEMALE] may not exist so use:
    pmname(ptr, gidx)
      where -ptr is a permonst *
            -gidx is an index into the pmnames array field of the
             permonst struct
pmname() checks for a valid index and checks for null-pointers for
pmnames[MALE] and pmnames[FEMALE], and will fall back to pmnames[NEUTRAL] if
the pointer requested if the requested variation is unavailable, or if the
gidx is out-of-range.

Allow code to specify makemon flags to request female or male (via MM_MALE
and MM_FEMALE flags respectively)to makedefs, since the species alone doesn't
distinguish male/female anymore. Specifying MM_MALE or MM_FEMALE won't
override the pm M2_MALE and M2_FEMALE flags on a mons[] entry.

male and female tiles have been added to win/share/monsters.txt.
The majority are duplicated placeholders except for those that were
separate mons entries before. Perhaps someone will contribute artwork in the
future to make the male and female variations visually distinguishable.

tilemapping via has the MALE tile indexes in the glyph2tile[]
array produced at build time. If a window port has information that the
FEMALE tile is required, it just has to increment the index returned
from the glyph2tile[] array by 1.

statues already preserved gender of the monster through STATUE_FEMALE
and STATUE_MALE, so ensure that pmnames takes that into consideration.

I expect some refinement will be required after broad play-testing puts it to
the test.

    consolidate caveman,cavewoman and priest,priestess monst.c entries etc

This commit will require a bump of editlevel in patchlevel.h because it alters
the index numbers of the monsters due to the consolidation of some. Those
index numbers are saved in some other structures, even though the mons[] array
itself is not part of the savefile.

Window Port Interface Change

Also add a parameter to print_glyph to convey additional information beyond
the glyph to the window ports. Every single window port was calling back to
mapglyph for the information anyway, so just included it in the interface and
produce the information right in the display core.

The mapglyph() function uses will be eliminated, although there are still some
in the code yet to be dealt with.

win32, tty, x11, Qt, msdos window ports have all had adjustments done to
utilize the new parameter instead of calling mapglyph, but some of those
window ports have not been thoroughly tested since the changes.

Interface change additional info:

    print_glyph(window, x, y, glyph, bkglyph, *glyphmod)
            -- Print the glyph at (x,y) on the given window.  Glyphs are
               integers at the interface, mapped to whatever the window-
               port wants (symbol, font, color, attributes, ...there's
               a 1-1 map between glyphs and distinct things on the map).
            -- bkglyph is a background glyph for potential use by some
               graphical or tiled environments to allow the depiction
               to fall against a background consistent with the grid
               around x,y. If bkglyph is NO_GLYPH, then the parameter
               should be ignored (do nothing with it).
                -- glyphmod provides extended information about the glyph
               that window ports can use to enhance the display in
               various ways.
                    unsigned int glyphmod[NUM_GLYPHMOD]
               where:
                    glyphmod[GM_TTYCHAR]  is the text characters associated
                                          with the original NetHack display.

                    glyphmod[GM_FLAGS]    are the special flags that denote
                                          additional information that window
                                          ports can use.

                    glyphmod[GM_COLOR] is the text character
                                       color associated with the original
                                       NetHack display.

Support for including the glyphmod info in the display glyph buffer
alongside the glyph itself was added and is the default operation.
That can be turned off by defining UNBUFFERED_GLYPHMOD at compile time.
With UNBUFFERED_GLYPHMOD operation, a call will be placed to map_glyphmod()
immediately prior to every print_glyph() call.
2020-12-26 11:23:23 -05:00

228 lines
9.5 KiB
C

/* NetHack 3.7 monst.h $NHDT-Date: 1596498550 2020/08/03 23:49:10 $ $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.42 $ */
/* Copyright (c) Stichting Mathematisch Centrum, Amsterdam, 1985. */
/*-Copyright (c) Robert Patrick Rankin, 2016. */
/* NetHack may be freely redistributed. See license for details. */
#ifndef MONST_H
#define MONST_H
#ifndef MEXTRA_H
#include "mextra.h"
#endif
/* The weapon_check flag is used two ways:
* 1) When calling mon_wield_item, is 2-6 depending on what is desired.
* 2) Between calls to mon_wield_item, is 0 or 1 depending on whether or not
* the weapon is known by the monster to be cursed (so it shouldn't bother
* trying for another weapon).
* I originally planned to also use 0 if the monster already had its best
* weapon, to avoid the overhead of a call to mon_wield_item, but it turns out
* that there are enough situations which might make a monster change its
* weapon that this is impractical. --KAA
*/
enum wpn_chk_flags {
NO_WEAPON_WANTED = 0,
NEED_WEAPON = 1,
NEED_RANGED_WEAPON = 2,
NEED_HTH_WEAPON = 3,
NEED_PICK_AXE = 4,
NEED_AXE = 5,
NEED_PICK_OR_AXE = 6
};
/* The following flags are used for the second argument to display_minventory
* in invent.c:
*
* PICK_NONE, PICK_ONE, PICK_ANY (wintype.h) 0, 1, 2
* MINV_NOLET If set, don't display inventory letters on monster's inventory.
* MINV_ALL If set, display all items in monster's inventory, otherwise
* just display wielded weapons and worn items.
*/
#define MINV_PICKMASK 0x03 /* 1|2 */
#define MINV_NOLET 0x04
#define MINV_ALL 0x08
/* monster appearance types */
enum m_ap_types {
M_AP_NOTHING = 0, /* mappearance unused--monster appears as itself */
M_AP_FURNITURE = 1, /* stairs, a door, an altar, etc. */
M_AP_OBJECT = 2, /* an object */
M_AP_MONSTER = 3 /* a monster; mostly used for cloned Wizard */
};
#define MON_FLOOR 0x00
#define MON_OFFMAP 0x01
#define MON_DETACH 0x02
#define MON_MIGRATING 0x04
#define MON_LIMBO 0x08
#define MON_BUBBLEMOVE 0x10
#define MON_ENDGAME_FREE 0x20
#define MON_ENDGAME_MIGR 0x40
#define MON_OBLITERATE 0x80
#define MSTATE_MASK 0xFF
#define M_AP_TYPMASK 0x7
#define M_AP_F_DKNOWN 0x8
#define U_AP_TYPE (g.youmonst.m_ap_type & M_AP_TYPMASK)
#define U_AP_FLAG (g.youmonst.m_ap_type & ~M_AP_TYPMASK)
#define M_AP_TYPE(m) ((m)->m_ap_type & M_AP_TYPMASK)
#define M_AP_FLAG(m) ((m)->m_ap_type & ~M_AP_TYPMASK)
struct monst {
struct monst *nmon;
struct permonst *data;
unsigned m_id;
short mnum; /* permanent monster index number */
short cham; /* if shapeshifter, orig mons[] idx goes here */
short movement; /* movement points (derived from permonst definition
and added effects */
uchar m_lev; /* adjusted difficulty level of monster */
aligntyp malign; /* alignment of this monster, relative to the
player (positive = good to kill) */
xchar mx, my;
xchar mux, muy; /* where the monster thinks you are */
#define MTSZ 4
/* mtrack[0..2] is used to keep extra data when migrating the monster */
coord mtrack[MTSZ]; /* monster track */
int mhp, mhpmax;
unsigned mappearance; /* for undetected mimics and the wiz */
uchar m_ap_type; /* what mappearance is describing, m_ap_types */
schar mtame; /* level of tameness, implies peaceful */
unsigned short mextrinsics; /* low 8 correspond to mresists */
int mspec_used; /* monster's special ability attack timeout */
Bitfield(female, 1); /* is female */
Bitfield(minvis, 1); /* currently invisible */
Bitfield(invis_blkd, 1); /* invisibility blocked */
Bitfield(perminvis, 1); /* intrinsic minvis value */
Bitfield(mcan, 1); /* has been cancelled */
Bitfield(mburied, 1); /* has been buried */
Bitfield(mundetected, 1); /* not seen in present hiding place;
* implies one of M1_CONCEAL or M1_HIDE,
* but not mimic (that is, snake, spider,
* trapper, piercer, eel) */
Bitfield(mcansee, 1); /* cansee 1, temp.blinded 0, blind 0 */
Bitfield(mspeed, 2); /* current speed */
Bitfield(permspeed, 2); /* intrinsic mspeed value */
Bitfield(mrevived, 1); /* has been revived from the dead */
Bitfield(mcloned, 1); /* has been cloned from another */
Bitfield(mavenge, 1); /* did something to deserve retaliation */
Bitfield(mflee, 1); /* fleeing */
Bitfield(mfleetim, 7); /* timeout for mflee */
Bitfield(msleeping, 1); /* asleep until woken */
Bitfield(mblinded, 7); /* cansee 0, temp.blinded n, blind 0 */
Bitfield(mstun, 1); /* stunned (off balance) */
Bitfield(mfrozen, 7);
Bitfield(mcanmove, 1); /* paralysis, similar to mblinded */
Bitfield(mconf, 1); /* confused */
Bitfield(mpeaceful, 1); /* does not attack unprovoked */
Bitfield(mtrapped, 1); /* trapped in a pit, web or bear trap */
Bitfield(mleashed, 1); /* monster is on a leash */
Bitfield(isshk, 1); /* is shopkeeper */
Bitfield(isminion, 1); /* is a minion */
Bitfield(isgd, 1); /* is guard */
Bitfield(ispriest, 1); /* is an aligned priest or high priest */
Bitfield(iswiz, 1); /* is the Wizard of Yendor */
Bitfield(wormno, 5); /* at most 31 worms on any level */
Bitfield(mtemplit, 1); /* temporarily seen; only valid during bhit() */
/* 1 free bit */
#define MAX_NUM_WORMS 32 /* should be 2^(wormno bitfield size) */
unsigned long mstrategy; /* for monsters with mflag3: current strategy */
#ifdef NHSTDC
#define STRAT_APPEARMSG 0x80000000UL
#else
#define STRAT_APPEARMSG 0x80000000L
#endif
#define STRAT_ARRIVE 0x40000000L /* just arrived on current level */
#define STRAT_WAITFORU 0x20000000L
#define STRAT_CLOSE 0x10000000L
#define STRAT_WAITMASK (STRAT_CLOSE | STRAT_WAITFORU)
#define STRAT_HEAL 0x08000000L
#define STRAT_GROUND 0x04000000L
#define STRAT_MONSTR 0x02000000L
#define STRAT_PLAYER 0x01000000L
#define STRAT_NONE 0x00000000L
#define STRAT_STRATMASK 0x0f000000L
#define STRAT_XMASK 0x00ff0000L
#define STRAT_YMASK 0x0000ff00L
#define STRAT_GOAL 0x000000ffL
#define STRAT_GOALX(s) ((xchar) ((s & STRAT_XMASK) >> 16))
#define STRAT_GOALY(s) ((xchar) ((s & STRAT_YMASK) >> 8))
long mtrapseen; /* bitmap of traps we've been trapped in */
long mlstmv; /* for catching up with lost time */
long mstate; /* debugging info on monsters stored here */
long migflags; /* migrating flags */
long mspare1;
struct obj *minvent; /* mon's inventory */
struct obj *mw; /* mon's weapon */
long misc_worn_check; /* mon's wornmask */
xchar weapon_check; /* flag for whether to try switching weapons */
int meating; /* monster is eating timeout */
struct mextra *mextra; /* point to mextra struct */
};
#define newmonst() (struct monst *) alloc(sizeof (struct monst))
/* these are in mspeed */
#define MSLOW 1 /* slowed monster */
#define MFAST 2 /* speeded monster */
#define MON_WEP(mon) ((mon)->mw)
#define MON_NOWEP(mon) ((mon)->mw = (struct obj *) 0)
#define DEADMONSTER(mon) ((mon)->mhp < 1)
#define is_starting_pet(mon) ((mon)->m_id == g.context.startingpet_mid)
#define is_vampshifter(mon) \
((mon)->cham == PM_VAMPIRE || (mon)->cham == PM_VAMPIRE_LEADER \
|| (mon)->cham == PM_VLAD_THE_IMPALER)
#define vampshifted(mon) (is_vampshifter((mon)) && !is_vampire((mon)->data))
/* monsters which cannot be displaced: priests, shopkeepers, vault guards,
Oracle, quest leader */
#define mundisplaceable(mon) ((mon)->ispriest \
|| (mon)->isshk \
|| (mon)->isgd \
|| (mon)->data == &mons[PM_ORACLE] \
|| (mon)->m_id == g.quest_status.leader_m_id)
/* mimic appearances that block vision/light */
#define is_lightblocker_mappear(mon) \
(is_obj_mappear(mon, BOULDER) \
|| (M_AP_TYPE(mon) == M_AP_FURNITURE \
&& ((mon)->mappearance == S_hcdoor \
|| (mon)->mappearance == S_vcdoor \
|| (mon)->mappearance < S_ndoor /* = walls */ \
|| (mon)->mappearance == S_tree)))
#define is_door_mappear(mon) (M_AP_TYPE(mon) == M_AP_FURNITURE \
&& ((mon)->mappearance == S_hcdoor \
|| (mon)->mappearance == S_vcdoor))
#define is_obj_mappear(mon,otyp) (M_AP_TYPE(mon) == M_AP_OBJECT \
&& (mon)->mappearance == (otyp))
/* Get the maximum difficulty monsters that can currently be generated,
given the current level difficulty and the hero's level. */
#define monmax_difficulty(levdif) (((levdif) + u.ulevel) / 2)
#define monmin_difficulty(levdif) ((levdif) / 6)
#define monmax_difficulty_lev() (monmax_difficulty(level_difficulty()))
/* Macros for whether a type of monster is too strong for a specific level. */
#define montoostrong(monindx, lev) (mons[monindx].difficulty > lev)
#define montooweak(monindx, lev) (mons[monindx].difficulty < lev)
#ifdef PMNAME_MACROS
#define Mgender(mon) ((mon)->female ? FEMALE : MALE)
#endif
#endif /* MONST_H */