shared_defs.qc

/*
	shared/shared_defs.qc

	shared definitions

	Copyright (C) 2021-2024 NZ:P Team

	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:

		Free Software Foundation, Inc.
		59 Temple Place - Suite 330
		Boston, MA  02111-1307, USA

*/

//
// CSQC Particle Types
//
#define CSQC_PART_MUZZLEFLASH			0 	// View Entity Muzzleflashes.
#define CSQC_PART_EXPLOSION 			1	// Explosion effect.
#define CSQC_PART_BLOODIMPACT			2 	// Blood Impact effect.
#define CSQC_PART_ZOMBIEGIB				3	// Zombie Gib effect.
#define CSQC_PART_FIRE					4 	// Fire/flame effect.

//
// CSQC Broadcast Messages
//
#define CSQC_BROADCAST_NONE					0 	// ""
#define CSQC_BROADCAST_PLAYERDOWNED			1	// "$ needs to be revived"
#define CSQC_BROADCAST_BEINGREVIVED			2	// "$ is reviving you"
#define CSQC_BROADCAST_REVIVINGPLAYER		3	// "Reviving $"
#define CSQC_BROADCAST_GUNGAMEADVANCEMENT	4 	// "$ ADVANCED!"
#define CSQC_BROADCAST_GUNGAMEWINNER		5 	// "$ can Activate the Nuke!"

//
// CSQC Event Types
//
#define CSQC_EVENT_PARTICLE				10	// <byte> particle_type
											// <coord> pos_x
											// <coord> pos_y
											// <coord> pos_z
											// <byte> optional_field
											// <entity> optional_entity

#define CSQC_EVENT_USEPRINT				11	// <byte> useprint_type
											// <short> useprint_cost
											// <byte> useprint_weapon

#define CSQC_EVENT_ROUNDCHANGE			12	// <byte> round

#define CSQC_EVENT_BROADCASTMESSAGE		13	// <byte> broadcast_message_type
											// <byte> broadcast_time
											// <byte> player_number

#define CSQC_EVENT_POWERUPTOAST			14	// NO DATA.

#define CSQC_EVENT_MUSICSTREAM			15	// <string> track_name

#define CSQC_EVENT_GIVEACHIEVEMENT		16 	// <byte> achievement_index

#define CSQC_EVENT_PLAYERNAME			17 	// <string> player_name

#define CSQC_EVENT_SCREENFLASH			18 	// <byte> screenflash_color
											// <byte> screenflash_duration
											// <byte> screenflash_type

#define CSQC_EVENT_RUMBLE				19 	// <short> low_frequency
											// <short> high_frequency
											// <short> duration

#define CSQC_EVENT_SETGAMEMODE			20 	// <byte> gamemode

#define CSQC_EVENT_SETROUNDCOLOR		21  // <byte> red
											// <byte> green
											// <byte> blue

#define CSQC_EVENT_SETPERKMODE			22 	// <byte> orientation

#define EVENT_UPDATE 					23
#define EVENT_BLACKOUT 					24
#define EVENT_WORLDDATA 				25
#define EVENT_PLAYERUPDATE 				26
#define EVENT_REVIVEON 					27
#define EVENT_REVIVEOFF 				28
#define EVENT_REVIVECHANGE 				29
#define EVENT_WEAPONRECOIL 				30
#define EVENT_GRENADEPULSE 				31
#define EVENT_BETTYPROMPT 				32
#define EVENT_CHATMESSAGE				33
#define EVENT_DOUBLETAPUPDATE 			34
#define EVENT_ENDGAME					35
#define EVENT_MAPTYPE					36

//
// Perk-A-Cola draw presets
//

#define HUD_PERK_ORI_DEFAULT			0
#define HUD_PERK_ORI_CW					1

//
// Types of screen-flashes, global.
//

// Colors
#define SCREENFLASH_COLOR_WHITE			0
#define SCREENFLASH_COLOR_BLACK			1

// Types
#define SCREENFLASH_FADE_INANDOUT		0
#define SCREENFLASH_FADE_IN 			1
#define SCREENFLASH_FADE_OUT 			2

// Player Hull Sizes
// 32x32x72
#define PLAYER_MINS_STANDING 	'-16 -16 -32'
#define PLAYER_MAXS_STANDING 	'16 16 40'

// 32x32x56
#define PLAYER_MINS_QUAKE 		'-16 -16 -24'
#define PLAYER_MAXS_QUAKE 		'16 16 32'

// 32x32x36
#define PLAYER_MINS_CROUCHING	'-16 -16 -32'
#define PLAYER_MAXS_CROUCHING 	'16 16 4'

#define PLAYER_STANCE_STAND		2
#define PLAYER_STANCE_CROUCH	1
#define PLAYER_STANCE_PRONE		0

// map compatibility
#define MAP_COMPAT_BETA     1
float 	map_compatibility_mode;

//
// Power-Up IDs
//

#define PU_NUKE				0
#define PU_INSTAKILL		1
#define PU_DOUBLEPTS		2
#define PU_CARPENTER		3
#define PU_MAXAMMO			4
#define PU_FREEPERK			5
#define PU_UPGRADEWEAPON	6
#define PU_BONUSPOINTS		7

// Weapon Firetype definitions
#define FIRETYPE_FULLAUTO	0
#define FIRETYPE_SEMIAUTO	1
#define FIRETYPE_ROCKET		2
#define FIRETYPE_GRENADE	3
#define FIRETYPE_RAYBEAM	4
#define FIRETYPE_TESLA		5
#define FIRETYPE_FLAME		6
#define FIRETYPE_BLADE		7
#define FIRETYPE_RAYLASER	8

//nzp weapon defines
//id list
#define W_NOWEP        0
#define W_COLT 		   1
#define W_KAR 		   2
#define W_THOMPSON 	   3
#define W_357		   4
#define W_BAR		   5
#define W_BK		   6
#define W_BROWNING	   7
#define W_DB		   8
#define W_FG		   9
#define W_GEWEHR	   10
#define W_KAR_SCOPE	   11
#define W_M1		   12
#define W_M1A1		   13
#define W_M2		   14
#define W_MP40		   15
#define W_MG		   16
#define W_PANZER	   17
#define W_PPSH		   18
#define W_PTRS		   19
#define W_RAY		   20
#define W_SAWNOFF	   21
#define W_STG		   22
#define W_TRENCH	   23
#define W_TYPE		   24
#define W_BOWIE		   25
#define W_GRENADE      26
#define W_BETTY   	   27
#define W_BIATCH       28
#define W_KILLU        29 //357
#define W_COMPRESSOR   30 // Gewehr
#define W_M1000        31 //garand
#define W_KOLLIDER     32
#define W_PORTER       33 // Ray
#define W_WIDDER       34 // M1A1
#define W_FIW          35 //upgraded flamethrower
#define W_ARMAGEDDON   36 //Kar
#define W_RESERVED     37
#define W_GIBS         38 // thompson
#define W_SAMURAI      39 //Type
#define W_AFTERBURNER  40 //mp40
#define W_SPATZ        41 // stg
#define W_SNUFF        42 // sawn off
#define W_BORE         43 // double barrel
#define W_IMPELLER     44 //fg
#define W_BARRACUDA    45 //mg42
#define W_ACCELERATOR  46 //M1919 browning
#define W_GUT          47 //trench
#define W_REAPER       48 //ppsh
#define W_HEADCRACKER  49 //scoped kar
#define W_LONGINUS     50 //panzer
#define W_PENETRATOR   51 //ptrs
#define W_WIDOW        52 //bar
#define W_KRAUS        53 //ballistic
#define W_MP5K         54
#define W_RESERVED2    55
#define W_TESLA  	   56
#define W_DG3    	   57
#define W_SPRING       58
#define W_PULVERIZER   59
#define W_RAYMK2	   60
#define W_PORTERMK2	   61

//Custom Weapons
//FIXME - use array?
#define W_CUSTOM1 	   70
#define W_CUSTOM2	   71
#define W_CUSTOM3 	   72
#define W_CUSTOM4 	   73


#define BASE_FRAME			1	// The frame the Weapon idles at
#define FIRE_START 			2	// Start of firing animation
#define FIRE_HOLD 			3	// Stay on this frame while holding fire
#define FIRE_END 			4	// End of firing animation
#define RELOAD_START 		5	// Start of normal (one-way) reloads
#define RELOAD_END 			6	// End of normal (one-way) reloads
#define RELOAD_EMPTY_START	7	// Start of empty reloading
#define RELOAD_EMPTY_END	8	// End of empty reloading
#define RELOAD_PART_START	9	// Start of partial full reloading
#define RELOAD_PART_END 	10	// End of partial full reloading
#define SPRINT_IN_START		11	// Start of preparation to sprint
#define SPRINT_IN_END 		12	// End of preparation to sprint
#define SPRINT_START		13	// Start of sprint loop
#define SPRINT_END 			14	// End of sprint loop
#define SPRINT_OUT_START 	15	// Start of sprint stop
#define SPRINT_OUT_END 		16	// End of sprint stop
#define TAKE_OUT_START		17	// Start of taking out weapon
#define TAKE_OUT_END 		18	// End of taking out weapon
#define FIRST_TAKE_START	19  // The "first raise" (first time weapon is taken)
#define FIRST_TAKE_END 		20	// End of "first raise"
#define PUT_OUT_START 		21	// Start of putting away weapon
#define PUT_OUT_END 		22	// End of putting away weapon
#define RELOAD_CANCEL 		23	// Frame where mag variable is filled
#define AIM_IN        		24	// Frame to snap to when in ADS (optional)
#define AIM_FIRE_START      25	// Start of firing while ADS (optional)
#define AIM_FIRE_END        26	// End of firing while ADS (optional)
#define MELEE_NORMAL_START	27 	// Start of normal (non-lunged) melee frame, for melee weapons
#define MELEE_NORMAL_END	28 	// End of normal (non-lunged) melee frame, for melee weapons
#define MELEE_LUNGED_START	29 	// Start of lunged melee frame, for melee weapons
#define MELEE_LUNGED_END	30 	// End of lunged melee frame, for melee weapons

//Animation types
#define RELOAD			1
#define GRENADE			2
#define FIRE			3
#define SWITCHWEP		4
#define KNIFE			5
#define ZOOM			6
#define SPRINT			7
#define PERK			8
#define KNIFE2			9
#define REVIVE			10
#define RELOAD_EMP 		11
#define RELOAD_PAR 		12
#define PUTOUT 			13
#define TAKEOUT 		14
#define MELEE_NORMAL	15
#define MELEE_LUNGED 	16

#define DMG_TYPE_HEADSHOT		1  		// Player-inflicted: Headshot
#define DMG_TYPE_MELEE			2  		// Player-inflicted: Melee
#define DMG_TYPE_UPPERTORSO		3  		// Player-inflicted: Upper torso shot
#define DMG_TYPE_LOWERTORSO		4   	// Player-inflicted: Lower torso shot
#define DMG_TYPE_EXPLOSIVE		5       // Player-inflicted: Non-grenade explosive weapon
#define DMG_TYPE_FLAMETHROWER	6  		// Player-inflicted: Flamethrower
#define DMG_TYPE_GRENADE 		7  		// Player-inflicted: Grenade-based weapons (includes Ray Gun)
#define DMG_TYPE_TESLA 			8   	// Player-inflicted: Wunderwaffe
#define DMG_TYPE_ZOMBIESWIPE	9  		// Zombie-inflicted: Any attack on Player
#define DMG_TYPE_ELECTRICTRAP	10 		// Trap-inflicted: Electric trap damage
#define DMG_TYPE_OTHER 			11 		// For use with misc. damage infliction
#define DMG_TYPE_FLOPPER		12		// Player-inflicted: PhD Flopper explosion

//Perk types
#define 	P_JUG		1
#define 	P_DOUBLE	2
#define 	P_SPEED		4
#define 	P_REVIVE	8
#define 	P_FLOP		16
#define 	P_STAMIN	32
#define 	P_DEAD 		64
#define 	P_MULE 		128

// all perks
#define     P_ALL            (P_JUG | P_DOUBLE | P_SPEED | P_REVIVE | P_FLOP | P_STAMIN | P_DEAD | P_MULE)
// all perks useful in Gun Game (all but no mule kick)
#define     P_ALL_GUNGAME    (P_JUG | P_DOUBLE | P_SPEED | P_REVIVE | P_FLOP | P_STAMIN | P_DEAD)

#define STAT_VIEWZOOM 			21

#define STAT_CURRENTMAG         50
#define STAT_CURRENTMAG2        51
#define STAT_POINTS             52
#define STAT_WEAPON2FRAME       53
#define STAT_WEAPON2MODELI      54
#define STAT_GRENADES   	    55
#define STAT_SECGRENADES    	56
#define STAT_PROGRESSBAR   	    57
#define STAT_WEAPONDURATION   	58
#define STAT_WEAPON2DURATION   	59
#define STAT_WEAPONZOOM        	60
#define STAT_INSTA	        	61
#define STAT_X2		        	62
#define STAT_SPECTATING			63
#define STAT_PLAYERNUM			64
#define STAT_PLAYERSTANCE 		65
#define STAT_FACINGENEMY 		66
#define STAT_MAXHEALTH 			67
#define STAT_WEAPONSKIN 		68
#define STAT_PERKS				69
#define STAT_TOTALSCORE			70
#define STAT_WEAPONNAME			71
#define STAT_WEAPONNAMETOUCH	72
#define STAT_WEAPONTIER			73
#define STAT_VIEWMODEL_EFFECTS  74
#define STAT_VIEWMODEL2_EFFECTS 75

#define STAT_GUNGAME_IDX		76
#define STAT_GUNGAME_SCOREGOAL	77

// Game Modes
#define GAMEMODE_CLASSIC        0
#define GAMEMODE_GRIEF          1
#define GAMEMODE_GUNGAME        2
#define GAMEMODE_HARDCORE       3
#define GAMEMODE_WILDWEST       4
#define GAMEMODE_STICKSNSTONES  5
#define GAMEMODE_FESTIVE 		6

// Misc. player statistics
.float playernum;
.float is_spectator;
.float ping;
.float kills;
.float headshots;
.float downs;
.float revives;
.float points;

float in_endgame_sequence;

#ifdef FTE
.float is_in_menu;
.float is_using_gamepad;
#endif // FTE

//
// invert float takes in float value between 0 and 1, inverts position
// eg: 0.1 returns 0.9, 0.34 returns 0.66
float invertfloat(float input) {
    if (input < 0)
        return 0; // adjust to lower boundary
    else if (input > 1)
        return 1; // adjust to upper boundary
    else
        return (1 - input);
}