Entropy : Zero Uprising Episode 2 Health Vial Backpack

[1upD]

This is a feature intended for Entropy : Zero Uprising Episode 2. This pull request for Entropy : Zero 2 is a placeholder until such a time as we decide we want to implement this feature for workshop content or for other Entropy : Zero mods.

Description

The health vial backpack is a feature that allows the player to store health vials they find. With the backpack enabled, contacting a health vial will add it as an ammo type instead of doing the normal interaction. The number of health vials currently in your inventory will be displayed on a new HUD element.

Pressing a key bound to the command "impulse 28" will consume one health vial from the inventory and restore the normal number of hitpoints.

How to use

To use the health vial backpack, you must set the ConVars and make a few configuration changes to display the backpack on the HUD.

ConVars

This pull request adds two ConVars.

sk_healthvial_backpack 0
sk_healthvial_max 0

To use the health vial backpack, set sk_healthvial_backpack to 1. The player may hold health vials up to sk_healthvial_max. Please note that the HUD is only set up to handle a maximum of 8 healthvials.

Key binding to consume health vial

Bind the command "impulse 28" to a key in order to use the "consume health vial" function. Please look at how "impulse 36" is handled in Entropy : Zero 2's configuration files to figure out the best way to set up a binding in the menu. For debug purposes, you can also type bind b "impulse 28" to bind impulse 28 to the B key.

HUD config files

healthvial_backpack_scripts.zip

hudlayout.res

Add the following configurations:

HudHealthVialStatus	[!$DECK]
{
  "fieldName"	"HudHealthVialStatus"
  "visible"	"1"
  "enabled" "1"
  "xpos"	"16"
  "ypos"	"394"
  "wide"	"104"
  "tall"	"32"
  "xpos_default"	"120"
  "wide_default"	"104"
  "HealthVialIconColor"	"255 244 244 160"
  "LastHealthVialColor"	"255 244 244 160"
  "IconInsetX"	"8"
  "IconInsetY"	"4"
  "IconGap"		"24"
  "IconFont"		"HudNumbersSmall"
  
  "PaintBackgroundType"	"2"
}

HudHealthVialStatus	[$DECK]
{
  "fieldName"	"HudHealthVialStatus"
  "visible"	"1"
  "enabled" "1"
  "xpos"	"16"
  "ypos"	"386"
  "wide"	"104"
  "tall"	"32"
  "xpos_default"	"120"
  "wide_default"	"104"
  "HealthVialIconColor"	"255 244 244 160"
  "LastHealthVialColor"	"255 244 244 160"
  "IconInsetX"	"8"
  "IconInsetY"	"4"
  "IconGap"		"24"
  "IconFont"		"HudNumbersSmall_Deck"
  
  "PaintBackgroundType"	"2"
}

hudanimations_ezu.txt

In a hudanimations file, add these events. (You could create new file hudanimations_ezu.txt and add it to the hudanimations_manifest.txt file)

event HealthVialStatusShow
{
	Animate HudHealthVialStatus Alpha	"255" Linear 0.0 0.4
	Animate HudHealthVialStatus		FgColor		"BrightFg"		Linear	0.4		0.1
	Animate HudHealthVialStatus		FgColor		"FgColor"		Linear	0.5		1.6
}

event HealthVialStatusHide
{
	Animate HudHealthVialStatus Alpha	"0" Linear 0.0 0.4
}

event HealthVialAdded
{
	StopEvent	HealthVialConsumed		0.0
	StopEvent	HealthVialDied		0.0
	StopEvent	HealthVialLeft		0.0

	// add in the squad member, brighter then normal color
	Animate HudHealthVialStatus LastHealthVialColor	"255 255 255 255" Linear 0.0 0.1
	Animate HudHealthVialStatus LastHealthVialColor	"255 244 244 160" Linear 0.3 0.3
}

event HealthVialLeft
{
	StopEvent	HealthVialConsumed		0.0
	StopEvent	HealthVialDied		0.0
	StopEvent	HealthVialAdded	0.0

	// fade out the icon
	Animate HudHealthVialStatus LastHealthVialColor	"255 244 244 0"	Linear 0.0 0.5
}

event HealthVialConsumed
{
	StopEvent	HealthVialDied		0.0
	StopEvent	HealthVialAdded	0.0
	StopEvent	HealthVialLeft	0.0

	// Flash orange while fading out the icon
	Animate HudHealthVialStatus	LastHealthVialColor	"255 192 0 255"	Linear 0.0 0.15
	Animate HudHealthVialStatus	LastHealthVialColor	"255 192 0 0"	Linear 0.3 0.15
}

event HealthVialDied
{
	StopEvent	HealthVialAdded	0.0
	StopEvent	HealthVialConsumed		0.0
	StopEvent	HealthVialLeft		0.0

	// flash red, hold, then disappear
	Animate HudHealthVialStatus	LastHealthVialColor	"255 0 0 255"	Linear 0.0 0.5
	Animate HudHealthVialStatus	LastHealthVialColor	"255 0 0 0"		Linear 1.0 1.0
}

// Blixibon couldn't figure out how to do this in code. 1upD never even tried :(
event HealthVialElementSizeOne
{
	Animate HudHealthVialStatus		Wide	"29"	Deaccel	0.0		0.3
}

event HealthVialElementSizeTwo
{
	Animate HudHealthVialStatus		Wide	"53"	Deaccel	0.0		0.3
}

event HealthVialElementSizeThree
{
	Animate HudHealthVialStatus		Wide	"77"	Deaccel	0.0		0.3
}

event HealthVialElementSizeFour
{
	Animate HudHealthVialStatus		Wide	"101"	Deaccel	0.0		0.3
}

event HealthVialElementSizeFive
{
	Animate HudHealthVialStatus		Wide	"125"	Deaccel	0.0		0.3
}

event HealthVialElementSizeSix
{
	Animate HudHealthVialStatus		Wide	"149"	Deaccel	0.0		0.3
}

event HealthVialElementSizeSeven
{
	Animate HudHealthVialStatus		Wide	"173"	Deaccel	0.0		0.3
}

event HealthVialElementSizeEight
{
	Animate HudHealthVialStatus		Wide	"197"	Deaccel	0.0		0.3
}

event HealthVialElementSizeMax
{
	Animate HudHealthVialStatus		FgColor		"255 0 0 128"		Linear	0.0		0.5
	Animate HudHealthVialStatus		FgColor		"FgColor"		Linear	0.5		1.6
}

[Blixibon]

It seems odd to have an ammo type name exactly match an existing classname, but I can't think of any specific case in which it would cause an issue (aside from being confusing)

[Blixibon]

This precaches whether sv_healthvial_backpack is enabled or not. I'm assuming that's intentional

[1upD]

That's a good point, but if it did check sv_healthvial_backpack then the sound wouldn't be cached if the value gets changed at any point after the map has loaded