defines.h

Go to the documentation of this file.

/*
All original material Copyright (C) 2002-2010 UFO: Alien Invasion.

Copyright (C) 1997-2001 Id Software, Inc.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#ifndef SHARED_DEFINES_H
#define SHARED_DEFINES_H

/* if a brush just barely pokes onto the other side, let it slide by without chopping */
#define PLANESIDE_EPSILON   0.001

/* if you increase this, you also have to change the aircraft buy/sell menu scripts */
#define MAX_ACTIVETEAM  8

#define LEAFNODE -1
#define PLANENUM_LEAF -1

/* bsp constants */
#define TEXINFO_NODE        -1      /* side is already on a node */
#define MAXEDGES        20

#define TEAM_DEFAULT 1

#define DEBUG_ALL       0x07FE
#define DEBUG_SHARED    0x02
#define DEBUG_ENGINE    0x04
#define DEBUG_SYSTEM    0x08
#define DEBUG_COMMANDS  0x10
#define DEBUG_CLIENT    0x20
#define DEBUG_SERVER    0x40
#define DEBUG_GAME      0x80
#define DEBUG_RENDERER  0x0100
#define DEBUG_SOUND     0x0200
#define DEBUG_EVENTSYS  0x0400
/* note that pathing and routing are not included in DEBUG_ALL (too much output) */
#define DEBUG_PATHING   0x0800
#define DEBUG_ROUTING   0x1000

#define NONE        -1
#define NONE_AMMO   0

/* Move/Routing values */
#define MAX_ROUTE       33
#define MAX_MOVELENGTH  60

/* Timeunits for the various actions. */
#define TU_CROUCH           3   
#define TU_TURN             1   
#define TU_MOVE_STRAIGHT    2   
#define TU_MOVE_DIAGONAL    3   
#define TU_MOVE_CLIMB       4   
#define TU_MOVE_FALL        0   
#define TU_DOOR_ACTION      1   
#define TU_CROUCH_MOVING_FACTOR 1.5 
#define TU_FLYING_MOVING_FACTOR 2   
#define TU_GET_RELOAD(containerOut, containerIn, weapon) (csi.ids[(containerOut)].out + (weapon)->reload + csi.ids[(containerIn)].in)

/* door states */
#define STATE_OPENED        0
#define STATE_CLOSED        1

#define MAX_STRING_CHARS    1024    /* max length of a string passed to Cmd_TokenizeString */
/* common/cmd.c */
#define MAX_STRING_TOKENS   80  /* max tokens resulting from Cmd_TokenizeString */

/* ALL */
#define MAX_TEXPATH         32  
/* per-level limits */
/* 25 - bases are 5*5 - see BASE_SIZE*/
#define MAX_TILESTRINGS     25
#define MAX_TEAMS           8
#define MAX_CLIENTS         256 /* absolute limit */
#define MAX_EDICTS          1024    /* must change protocol to increase more */
#define MAX_MODELS          256 /* these are sent over the net as bytes */
#define MAX_GENERAL         (MAX_CLIENTS*2) /* general config strings */

/* not really max hp - but an initial value */
#define MAX_HP 100

/* game print flags */
#define PRINT_NONE      -1  /* suppress printing */
#define PRINT_CHAT      0   /* chat messages */
#define PRINT_HUD       1   /* translated hud strings */
#define PRINT_CONSOLE   2   /* critical messages goes to the game console */

#define ERR_FATAL           0   /* exit the entire game with a popup window */
#define ERR_DROP            1   /* print to console and disconnect from game */
#define ERR_DISCONNECT      2   /* don't kill server */

/* substract this from the ent->pos[z] to get the ground position */
#define GROUND_DELTA    28

/* important units */
#define UNIT_SIZE   32
#define UNIT_HEIGHT 64
/* player height - 12 to be able to walk trough doors
 * UNIT_HEIGHT is the height of one level */
#define PLAYER_HEIGHT       (UNIT_HEIGHT - 16)
#define QUANT   4
/* WALL_SIZE is the distance a wall may protrude from the edge of a cell without interfeeting with an actor entering the cell */
#define WALL_SIZE 5

#define MAX_MAP_MODELS      1024
#define MAX_MAP_BRUSHES     16384
#define MAX_MAP_ENTITIES    2048
#define MAX_MAP_ENTSTRING   0x40000
#define MAX_MAP_TEXINFO     16384
#define MAX_MAP_PLANES      65536
#define MAX_MAP_NODES       65536
#define MAX_MAP_BRUSHSIDES  65536
#define MAX_MAP_LEAFS       65536
#define MAX_MAP_VERTS       65536
#define MAX_MAP_FACES       65536
#define MAX_MAP_LEAFBRUSHES 65536
#define MAX_MAP_EDGES       128000
#define MAX_MAP_SURFEDGES   256000
#define MAX_MAP_LIGHTING    0x1000000
/* WIDTH * WIDTH * 4 */
#define MAX_MAP_ROUTING     0x100000

#define MAX_LEAFS       1024

#if defined(COMPILE_MAP)
  #define MAX_MAPTILES  1
#elif defined(COMPILE_UFO)
  #define MAX_MAPTILES  64
#endif

#define MAX_MOD_KNOWN   512

#define MAX_KEY     32
#define MAX_VALUE   1024

#define LUMP_ENTITIES       0
#define LUMP_PLANES         1
#define LUMP_VERTEXES       2
#define LUMP_ROUTING        3
#define LUMP_NODES          4
#define LUMP_TEXINFO        5
#define LUMP_FACES          6
#define LUMP_LIGHTING_NIGHT 7
#define LUMP_LIGHTING_DAY   8
#define LUMP_LEAFS          9
#define LUMP_LEAFBRUSHES    10
#define LUMP_EDGES          11
#define LUMP_SURFEDGES      12
#define LUMP_MODELS         13
#define LUMP_BRUSHES        14
#define LUMP_BRUSHSIDES     15
#define LUMP_NORMALS        16
#define HEADER_LUMPS        17

#define SIDE_FRONT      0
#define SIDE_ON         2
#define SIDE_BACK       1

#define PLANE_X         0
#define PLANE_Y         1
#define PLANE_Z         2

#define PLANE_ANYX      3
#define PLANE_ANYY      4
#define PLANE_ANYZ      5
#define PLANE_NONE      6

#define AXIAL(p) ((p)->type < PLANE_ANYX)

#define ANGLE_UP    -1
#define ANGLE_DOWN  -2

/*
==============================================================
COLLISION DETECTION
==============================================================
*/

#define CONTENTS_SOLID  0x0001 
#define CONTENTS_WINDOW 0x0002 
#define CONTENTS_LADDER 0x0004
#define CONTENTS_WATER  0x0020

/* ufo2map/map.c, ufo2map/portals.c */
#define LAST_VISIBLE_CONTENTS   0x80

#define CONTENTS_LEVEL_ALL  0xFF00
#define CONTENTS_LEVEL_1    0x0100
#define CONTENTS_LEVEL_2    0x0200
#define CONTENTS_LEVEL_3    0x0400
#define CONTENTS_LEVEL_4    0x0800
#define CONTENTS_LEVEL_5    0x1000
#define CONTENTS_LEVEL_6    0x2000
#define CONTENTS_LEVEL_7    0x4000
#define CONTENTS_LEVEL_8    0x8000

#define CONTENTS_ACTORCLIP      0x00010000
#define CONTENTS_PASSABLE       0x00020000
#define CONTENTS_TERRAIN        0x00040000 
#define CONTENTS_LIGHTCLIP      0x00080000 
#define CONTENTS_ACTOR          0x00800000 
#define CONTENTS_ORIGIN         0x01000000 
#define CONTENTS_WEAPONCLIP     0x02000000 
#define CONTENTS_DEADACTOR      0x04000000
#define CONTENTS_DETAIL         0x08000000 
#define CONTENTS_TRANSLUCENT    0x10000000 
#define SURF_LIGHT      0x00000001 
#define SURF_SLICK      0x00000002 
#define SURF_WARP       0x00000008 
#define SURF_BLEND33    0x00000010 
#define SURF_BLEND66    0x00000020 
#define SURF_FLOWING    0x00000040 
#define SURF_NODRAW     0x00000080 
#define SURF_HINT       0x00000100 
#define SURF_SKIP       0x00000200 
#define SURF_PHONG      0x00000400 
#define SURF_BURN       0x00000800 
#define SURF_FOOTSTEP   0x00001000 
#define SURF_ORIGIN     0x00002000 
#define SURF_ALPHATEST  0x02000000 
/* content masks */
#define MASK_ALL            (-1)
#define MASK_SOLID          (CONTENTS_SOLID | CONTENTS_WINDOW)
#define MASK_IMPASSABLE     (MASK_SOLID | CONTENTS_ACTORCLIP)
#define MASK_PASSABLE       (CONTENTS_PASSABLE | CONTENTS_WATER)
#define MASK_SHOT           (CONTENTS_SOLID | CONTENTS_ACTOR | CONTENTS_WEAPONCLIP | CONTENTS_WINDOW | CONTENTS_DEADACTOR)
#define MASK_VISIBILILITY   (CONTENTS_SOLID | CONTENTS_WATER)
#define MASK_CLIP           (CONTENTS_ACTORCLIP | CONTENTS_WEAPONCLIP | CONTENTS_LIGHTCLIP)

/*============================================================== */

#define ROUTING_NOT_REACHABLE   0xFF    
#define ROUTING_UNREACHABLE     -1      
/* Battlescape map dimensions (WIDTH*WIDTH*HEIGHT) */

#define MAX_WORLD_WIDTH 4096

#define GRID_WIDTH (MAX_WORLD_WIDTH / UNIT_SIZE)

#define PATHFINDING_WIDTH (GRID_WIDTH * 2)

#define PATHFINDING_HEIGHT 8

#define CELL_HEIGHT (UNIT_HEIGHT / QUANT)

/* NOTE: this only allows quadratic units */
#define ACTOR_SIZE_INVALID 0
#define ACTOR_SIZE_NORMAL 1
#define ACTOR_SIZE_2x2 2
#define ACTOR_MAX_SIZE  (ACTOR_SIZE_2x2)

/* Maximum falling distance in QUANT units (model units / QUANT) */
#define PATHFINDING_MAX_FALL    16
/* The height of the box where we don't need the full actor's torso width */
#define PATHFINDING_LEGROOMHEIGHT   4
/* Minimum step-up height in QUANT units (model units/QUANT)
 * Note that 4 is the minimum to rise one cell every 4 moved horizontally. */
#define PATHFINDING_MIN_STEPUP      2
/* Minimum step-up height in QUANT units (model units/QUANT)
 * Note that 4 is the minimum to rise one cell every 4 moved horizontally. */
#define PATHFINDING_MAX_STEPUP      4
/* A stepup value indicating that there is no way to enter the cell. */
#define PATHFINDING_NO_STEPUP       (2 * CELL_HEIGHT)
/* A special bit mask indicating that the stepup causes the actor to rise a cell. */
#define PATHFINDING_BIG_STEPUP      0x80
/* A special bit mask indicating that the stepup causes the actor to walk down a cell. */
#define PATHFINDING_BIG_STEPDOWN        0x40
/* Minimum height for an opening to be an opening in step units (model units/QUANT)
 * Must be larger than PATHFINDING_MAX_STEPUP!!
 */
#define PATHFINDING_MIN_OPENING 6

#define PATHFINDING_MICROSTEP_SIZE  4

#define PATHFINDING_MICROSTEP_SKIP  2

/* DIRECTION constants- define "odd" directions */
#define DIRECTION_FALL          13
#define DIRECTION_CLIMB_UP      8
#define DIRECTION_CLIMB_DOWN    9
#define DIRECTION_STAND_UP      10
#define DIRECTION_CROUCH        11


#define ACTOR_MAX_STATES        2

#define LEVEL_LASTVISIBLE       255
#define LEVEL_LIGHTCLIP         256
#define LEVEL_LASTLIGHTBLOCKING 256
#define LEVEL_WEAPONCLIP        257
#define LEVEL_ACTORCLIP         258
#define LEVEL_MAX               259
#define NUM_REGULAR_MODELS      (LEVEL_ACTORCLIP + 1)

/* TestLine level masks */
#define TL_FLAG_NONE            0x0000
#define TL_FLAG_REGULAR_LEVELS  0x00FF
#define TL_FLAG_ACTORCLIP       0x0100
#define TL_FLAG_WEAPONCLIP      0x0200
#define TL_FLAG_ALL             0x0300

#define LIGHTMAP_NIGHT  0
#define LIGHTMAP_DAY    1
#define LIGHTMAP_MAX    2

#define PSIDE_FRONT         1
#define PSIDE_BACK          2
#define PSIDE_BOTH          (PSIDE_FRONT|PSIDE_BACK)
#define PSIDE_FACING        4

#define MAX_TOKEN_CHARS     256 /* max length of an individual token */

#define ON_EPSILON  0.1

/* 1/32 epsilon to keep floating point happy */
#define DIST_EPSILON    (0.03125)
#define DIST_EPSILON2   (0.0625125) /* DIST_EPSILON * 2 + small bit more */

#define MAP_DIST_EPSILON    0.01
#define NORMAL_EPSILON  0.00001

#define MAX_MAP_SIDES (MAX_MAP_BRUSHES*6)
#define MAX_MAP_TEXTURES    1024

#define MAX_MAP_LIGHTMAP    (512 * 512)

#define MAP_SIZE_OFFSET 100

#endif /* SHARED_DEFINES_H */