gzdoom/code/P_mobj.h

// Emacs style mode select	 -*- C++ -*- 
//-----------------------------------------------------------------------------
//
// $Id:$
//
// Copyright (C) 1993-1996 by id Software, Inc.
//
// This source is available for distribution and/or modification
// only under the terms of the DOOM Source Code License as
// published by id Software. All rights reserved.
//
// The source is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// FITNESS FOR A PARTICULAR PURPOSE. See the DOOM Source Code License
// for more details.
//
// DESCRIPTION:
//		Map Objects, MObj, definition and handling.
//
//-----------------------------------------------------------------------------


#ifndef __P_MOBJ__
#define __P_MOBJ__

// Basics.
#include "tables.h"
#include "m_fixed.h"

// We need the thinker_t stuff.
#include "d_think.h"

// We need the WAD data structure for Map things,
// from the THINGS lump.
#include "doomdata.h"

// States are tied to finite states are
//	tied to animation frames.
// Needs precompiled tables/data structures.
#include "info.h"





//
// NOTES: mobj_t
//
// mobj_ts are used to tell the refresh where to draw an image,
// tell the world simulation when objects are contacted,
// and tell the sound driver how to position a sound.
//
// The refresh uses the next and prev links to follow
// lists of things in sectors as they are being drawn.
// The sprite, frame, and angle elements determine which patch_t
// is used to draw the sprite if it is visible.
// The sprite and frame values are allmost allways set
// from state_t structures.
// The statescr.exe utility generates the states.h and states.c
// files that contain the sprite/frame numbers from the
// statescr.txt source file.
// The xyz origin point represents a point at the bottom middle
// of the sprite (between the feet of a biped).
// This is the default origin position for patch_ts grabbed
// with lumpy.exe.
// A walking creature will have its z equal to the floor
// it is standing on.
//
// The sound code uses the x,y, and subsector fields
// to do stereo positioning of any sound effited by the mobj_t.
//
// The play simulation uses the blocklinks, x,y,z, radius, height
// to determine when mobj_ts are touching each other,
// touching lines in the map, or hit by trace lines (gunshots,
// lines of sight, etc).
// The mobj_t->flags element has various bit flags
// used by the simulation.
//
// Every mobj_t is linked into a single sector
// based on its origin coordinates.
// The subsector_t is found with R_PointInSubsector(x,y),
// and the sector_t can be found with subsector->sector.
// The sector links are only used by the rendering code,
// the play simulation does not care about them at all.
//
// Any mobj_t that needs to be acted upon by something else
// in the play world (block movement, be shot, etc) will also
// need to be linked into the blockmap.
// If the thing has the MF_NOBLOCK flag set, it will not use
// the block links. It can still interact with other things,
// but only as the instigator (missiles will run into other
// things, but nothing can run into a missile).
// Each block in the grid is 128*128 units, and knows about
// every line_t that it contains a piece of, and every
// interactable mobj_t that has its origin contained.  
//
// A valid mobj_t is a mobj_t that has the proper subsector_t
// filled in for its xy coordinates and is linked into the
// sector from which the subsector was made, or has the
// MF_NOSECTOR flag set (the subsector_t needs to be valid
// even if MF_NOSECTOR is set), and is linked into a blockmap
// block or has the MF_NOBLOCKMAP flag set.
// Links should only be modified by the P_[Un]SetThingPosition()
// functions.
// Do not change the MF_NO? flags while a thing is valid.
//
// Any questions?
//

//
// Misc. mobj flags
//
typedef enum
{
	// Call P_SpecialThing when touched.
	MF_SPECIAL			= 0x00000001,
	// Blocks.
	MF_SOLID			= 0x00000002,
	// Can be hit.
	MF_SHOOTABLE		= 0x00000004,
	// Don't use the sector links (invisible but touchable).
	MF_NOSECTOR 		= 0x00000008,
	// Don't use the blocklinks (inert but displayable)
	MF_NOBLOCKMAP		= 0x00000010,					 

	// Not to be activated by sound, deaf monster.
	MF_AMBUSH			= 0x00000020,
	// Will try to attack right back.
	MF_JUSTHIT			= 0x00000040,
	// Will take at least one step before attacking.
	MF_JUSTATTACKED 	= 0x00000080,
	// On level spawning (initial position),
	//	hang from ceiling instead of stand on floor.
	MF_SPAWNCEILING 	= 0x00000100,
	// Don't apply gravity (every tic),
	//	that is, object will float, keeping current height
	//	or changing it actively.
	MF_NOGRAVITY		= 0x00000200,

	// Movement flags.
	// This allows jumps from high places.
	MF_DROPOFF			= 0x00000400,
	// For players, will pick up items.
	MF_PICKUP			= 0x00000800,
	// Player cheat. ???
	MF_NOCLIP			= 0x00001000,
	// Player: keep info about sliding along walls.
	MF_SLIDE			= 0x00002000,
	// Allow moves to any height, no gravity.
	// For active floaters, e.g. cacodemons, pain elementals.
	MF_FLOAT			= 0x00004000,
	// Don't cross lines
	//	 ??? or look at heights on teleport.
	MF_TELEPORT 		= 0x00008000,
	// Don't hit same species, explode on block.
	// Player missiles as well as fireballs of various kinds.
	MF_MISSILE			= 0x00010000,		
	// Dropped by a demon, not level spawned.
	// E.g. ammo clips dropped by dying former humans.
	MF_DROPPED			= 0x00020000,
	// Use fuzzy draw (shadow demons or spectres),
	//	temporary player invisibility powerup.
	MF_SHADOW			= 0x00040000,
	// Flag: don't bleed when shot (use puff),
	//	barrels and shootable furniture shall not bleed.
	MF_NOBLOOD			= 0x00080000,
	// Don't stop moving halfway off a step,
	//	that is, have dead bodies slide down all the way.
	MF_CORPSE			= 0x00100000,
	// Floating to a height for a move, ???
	//	don't auto float to target's height.
	MF_INFLOAT			= 0x00200000,

	// On kill, count this enemy object
	//	towards intermission kill total.
	// Happy gathering.
	MF_COUNTKILL		= 0x00400000,
	
	// On picking up, count this item object
	//	towards intermission item total.
	MF_COUNTITEM		= 0x00800000,

	// Special handling: skull in flight.
	// Neither a cacodemon nor a missile.
	MF_SKULLFLY 		= 0x01000000,

	// Don't spawn this object
	//	in death match mode (e.g. key cards).
	MF_NOTDMATCH		= 0x02000000,

	// Player sprites in multiplayer modes are modified
	//	using an internal color lookup table for re-indexing.
	// If 0x4 0x8 or 0xc,
	//	use a translation table for player colormaps
	MF_TRANSLATION		= 0x0c000000,
	// Hmm ???.
	MF_TRANSSHIFT		= 26,

	// [RH] Andy Baker's stealth monsters
	//Stealth Mode - Creatures that dissappear and reappear.
	MF_STEALTH			= 0x10000000,

	// [RH] 3 (4 counting opaque) levels of translucency
	MF_TRANSLUCSHIFT	= 29,
	MF_TRANSLUCBITS		= 0x60000000,
	MF_TRANSLUC25		= 0x20000000,
	MF_TRANSLUC50		= 0x40000000,
	MF_TRANSLUC75		= 0x60000000,

} mobjflag_t;

// [RH] These are all from Hexen. Very few are used.
#define MF2_LOGRAV			0x00000001	// alternate gravity setting
#define MF2_WINDTHRUST		0x00000002	// gets pushed around by the wind specials
#define MF2_FLOORBOUNCE		0x00000004	// bounces off the floor
#define MF2_BLASTED			0x00000008	// missile will pass through ghosts
#define MF2_FLY				0x00000010	// fly mode is active
#define MF2_FLOORCLIP		0x00000020	// if feet are allowed to be clipped
#define MF2_SPAWNFLOAT		0x00000040	// spawn random float z
#define MF2_NOTELEPORT		0x00000080	// does not teleport
#define MF2_RIP				0x00000100	// missile rips through solid targets
#define MF2_PUSHABLE		0x00000200	// can be pushed by other moving mobjs
#define MF2_SLIDE			0x00000400	// slides against walls
#define MF2_ONMOBJ			0x00000800	// mobj is resting on top of another mobj
#define MF2_PASSMOBJ		0x00001000	// Enable z block checking.  If on,
										// this flag will allow the mobj to
										// pass over/under other mobjs.
#define MF2_CANNOTPUSH		0x00002000	// cannot push other pushable mobjs
#define MF2_DROPPED			0x00004000	// dropped by a demon
#define MF2_BOSS			0x00008000	// mobj is a major boss
#define MF2_FIREDAMAGE		0x00010000	// does fire damage
#define MF2_NODMGTHRUST		0x00020000	// does not thrust target when damaging
#define MF2_TELESTOMP		0x00040000	// mobj can stomp another
#define MF2_FLOATBOB		0x00080000	// use float bobbing z movement
#define MF2_DONTDRAW		0x00100000	// don't generate a vissprite
#define MF2_IMPACT			0x00200000 	// an MF_MISSILE mobj can activate SPAC_IMPACT
#define MF2_PUSHWALL		0x00400000 	// mobj can push walls
#define MF2_MCROSS			0x00800000	// can activate monster cross lines
#define MF2_PCROSS			0x01000000	// can activate projectile cross lines
#define MF2_CANTLEAVEFLOORPIC 0x02000000 // stay within a certain floor type
#define MF2_NONSHOOTABLE	0x04000000	// mobj is totally non-shootable, 
										// but still considered solid
#define MF2_INVULNERABLE	0x08000000	// mobj is invulnerable
#define MF2_DORMANT			0x10000000	// thing is dormant
#define MF2_ICEDAMAGE		0x20000000  // does ice damage
#define MF2_SEEKERMISSILE	0x40000000	// is a seeker (for reflection)
#define MF2_REFLECTIVE		0x80000000	// reflects missiles


// Map Object definition.
typedef struct mobj_s
{
	thinker_t		thinker;			// thinker node

// info for drawing
	fixed_t	 		x,y,z;
	struct mobj_s	*snext, *sprev;		// links in sector (if needed)
	angle_t			angle;
	spritenum_t		sprite;				// used to find patch_t and flip value
	int				frame;				// might be ord with FF_FULLBRIGHT
	int				effects;			// [RH] see p_effect.h

// interaction info
	fixed_t			pitch, roll;
	struct mobj_s	*bnext, *bprev;		// links in blocks (if needed)
	struct subsector_s	*subsector;
	fixed_t			floorz, ceilingz;	// closest together of contacted secs
//	fixed_t			floorpic;			// contacted sec floorpic
	fixed_t			radius, height;		// for movement checking
	fixed_t			momx, momy, momz;	// momentums
	int				validcount;			// if == validcount, already checked
	mobjtype_t		type;
	mobjinfo_t		*info;				// &mobjinfo[mobj->type]
	int				tics;				// state tic counter
	state_t			*state;
	int				damage;			// For missiles
	int				flags;
	int				flags2;			// Heretic flags
	int				special1;		// Special info
	int				special2;		// Special info
	int 			health;
	int				movedir;		// 0-7
	int				movecount;		// when 0, select a new dir
	struct mobj_s	*target;		// thing being chased/attacked (or NULL)
									// also the originator for missiles
	struct mobj_s	*lastenemy;		// Last known enemy -- killogh 2/15/98
	int				reactiontime;	// if non 0, don't attack yet
									// used by player to freeze a bit after
									// teleporting
	int				threshold;		// if > 0, the target will be chased
									// no matter what (even if shot)
	struct player_s	*player;		// only valid if type == MT_PLAYER
	int				lastlook;		// player number last looked for
	mapthing2_t		spawnpoint; 	// For nightmare respawn
	struct mobj_s	*tracer;		// Thing being chased/attacked for tracers
//	fixed_t			floorclip;		// value to use for floor clipping
//	int				archiveNum;		// Identity during archive
	short			tid;			// thing identifier
	byte			special;		// special
	byte			args[5];		// special arguments

	struct mobj_s	*inext, *iprev;	// Links to other mobjs in same bucket
	struct mobj_s	*goal;			// Monster's goal if not chasing anything
	unsigned		targettic;		// Avoid missiles blowing up in your face
	byte			*translation;	// Translation table (or NULL)

	// a linked list of sectors where this object appears
	struct msecnode_s	*touching_sectorlist;				// phares 3/14/98
} mobj_t;



#endif
//-----------------------------------------------------------------------------
//
// $Log:$
//
//-----------------------------------------------------------------------------