Item suitcharger: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Fix "offical" -> "official" (second occurence. First was fixed in the ' "entity" -> "input" ' revision))
m (Classifying as model entity)
 
(45 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:item_suitcharger}}
{{LanguageBar}}
[[Image:item_suitcharger.jpg|thumb|200px|right|Suit Charger]]
{{tabsBar|main=Item_suitcharger}}
{{hl2 point|item_suitcharger}}
{{CD|CNewRecharge|file1=hl2/func_recharge.cpp}}
[[File: item_suitcharger.png | right | 200px]]


== Entity description ==
{{for|about=the point entity|the brush entity|<tt>[[func_recharge]]</tt>}}
Gradually charges up [[item_suit|HEV suit]] energy on use, until empty.  
{{this is a|model entity|name=item_suitcharger|game=Half-Life 2 series}} This is the [[HEV suit]] charger which gradually replenishes suit power on use, until empty or the suit is at full power.
{{ModernPlacementTip|{{clr}}
*Chargers are best placed with a height of around 48 units between the floor and the center of the recharger entity.
*To ensure that the player will gain battery rather than lose it, place them in areas occluded from immediate danger, like constant enemy fire from helicopters or tanks. Consider however that, since the player is required to stare at the wall while they are using the charger, they can be used to create tension by placing them where an enemy might still reach the player. Note that chargers could also add good or bad stress to the player if they have to exterminate a load of enemies in a room which a health charger is placed before using it.}}


A suit charger will contain the same total charge regardless of the difficulty setting.
{{Note|{{clr}}
* A normal suit charger (without any flags checked or cvars changed) will be able to discharge a total of 75 Suit points (30 in HL2DM).
*A suit charger will contain the same total charge regardless of the difficulty setting.
* A Citadel recharger will be able to discharge a total of 500 Suit points (200 in HL2DM), overcharging the HEV suit to a maximum of 200 Suit points, and while recharging it will also heal Health for free.
*A normal suit charger (without any flags checked or cvars changed) will be able to discharge a total of 75 power points (30 in HL2DM).
* Kleiner's recharger will be able to discharge a total of 25 Suit points, regardless of cvar settings.
*A Citadel recharger will be able to discharge a total of 500 power points (200 in HL2DM), overcharging the HEV suit to a maximum of 200 power points, and while recharging it will also heal health.
* A Citadel/Kleiner's recharger combo (with both flags checked) will be able to discharge a total of 30 Suit points (since Kleiner's recharger is set to 25 suit points no matter what, and a Citadel recharger rounds it up to the nearest 10), overcharging the HEV suit to a maximum of 200 Suit points, and while recharging it will also heal (a total of 15) Health for free.
*Kleiner's recharger will be able to discharge a total of 25 power points, regardless of cvar settings.
{{Placement Tip|
*A Citadel/Kleiner recharger combo (with both flags checked) will be able to discharge a total of 30 power points (since Kleiner's recharger is set to 25 power points no matter what, and a Citadel recharger rounds it up to the nearest 10), overcharging the HEV suit to a maximum of 200 power points, and while recharging it will also heal (a total of 15) health for free.
* Re-chargers are best placed with a height of around 48 units between the floor and the center of the recharger entity.  
*Players can change weapons while charging. Confirmed with {{hl2dm|4}}.
* To ensure that the player will gain battery rather than lose it, place them in areas occluded from immediate danger, like constant enemy fire from helicopters or tanks. Consider however that, since the player is required to stare at the wall while they are using the charger, they can be used to create tension by placing them where an enemy might still reach the player. Note that chargers could also add good or bad stress to the player if they have to exterminate a load of enemies in a room which a health charger is placed before using it.}}
*Players can fire any weapon while charging. Confirmed with {{hl2dm|4}}.
*Players can reload weapons while charging. Confirmed with {{hl2dm|4}}.
*Players can't use it without the suit. ''Deny.'' Confirmed with {{hl2|4}}.
*Players can't use it past the limit. ''Deny.'' Confirmed with {{hl2|4}}.
}}


== Dedicated Console Variables ==
{{note|This entity is also available in {{portal2|4}} and even can charge the suit (you need to change some cvars values). However, it does not function properly{{elaborate}}.}}
;sk_suitcharger <[[int]]>
==Flags==
: Changes the total charge of suit points of the normal charger (Default: 75 for HL2, 30 for HL2:DM).
{{fl|8192|Citadel recharger}}
{{fl|16384|Kleiner's recharger|Only gives 25 health}}


;sk_suitcharger_citadel <[[int]]>
{{Bug|[[Kill|Killing]] a charger while it is being used will make the charging sound loop indefinitely.|hidetested=1}}
: Changes the total charge of suit points of the citadel charger (Default: 500 for HL2, 200 for HL2:DM.)


;sk_suitcharger_citadel_maxarmor <[[int]]>
==Keyvalues==
: Changes the amount of Suit points you can hold when recharging with a citadel charger (Default: 200).
 
== Keyvalues ==
{{KV Targetname}}
{{KV Targetname}}
{{KV Angles}}
{{KV|Deathmatch recharge delay|intn=dmdelay|integer}}
{{KV|_minlight|float|Defines the minimum light level.}}


== Flags ==
==Inputs==
* 8192 : Citadel recharger
{{I|SetCharge|Set ''charge'' and ''total charge'' to a specific amount.|param=float|nofgd=1}}
: Changes charge amount to Citadel recharger amounts (see Entity description).
:{{note|Float values cause the model to change, but charge received is rounded down.}}
* 16384 : Kleiner's recharger
:{{note|Despite this input not being in the stock FGD, it is used once by Valve, in {{ent|ep1_citadel_03}}.}}
: Changes charge amount to Kleiner's recharger amounts (see Entity description).
{{I|Recharge|Sets charge to maximum.}}


== Inputs ==
==Outputs==
{{I Targetname}}
{{O|OutRemainingCharge|Fired once for every single point of power given to the suit. This means it will not fire when the charger is depleted or when the suit is at full power.}}
{{IO|SetCharge|Set total charge and charge to a specific amount.|param=float|nofgd=1}}
{{O|OnHalfEmpty|Fired when the "charge left" reaches 50% of its max.}}
{{Note|Float values cause the model to change, but charge received is rounded down.}}
{{O|OnEmpty|Fired when the charger is empty.}}
{{Note|Despite this input not being in the official FGD files, it is used once in an official map, in episodic, map <code>ep1_citadel_03</code>.}}
{{O|OnFull|Fired when player gets recharged to the max.}}
{{IO|Recharge|Sets charge to maximum}}
{{O|OnPlayerUse|Fired when the player tries to {{ent|+use}} the charger.}}


== Outputs ==
==Cvars/Commands==
{{O Targetname}}
{{varcom|start}}
{{IO|OutRemainingCharge|}}
{{varcom|sk_suitcharger|75 (HL2), 30 {{hl2dm}}|Arbitrary number|Total charge of suit points on a normal charger.}}
{{IO|OnHalfEmpty|Executed when the "charge left" reaches 50% of its max.}}
{{varcom|sk_suitcharger_citadel|500 (HL2), 200 {{hl2dm}}|Arbitrary number|Total charge of suit points on a citadel charger.}}
{{IO|OnEmpty|Executed when the Charger is empty.}}
{{varcom|sk_suitcharger_citadel_maxarmor|200|Arbitrary number|Maximum suit charge obtainable from a citadel charger.}}
{{IO|OnFull|Executed when player gets recharged to the max.}}
{{varcom|end}}
{{IO|OnPlayerUse|Executed when a player uses the entity (Def. E).}}


== See also ==
==See also==
* [[func_recharge]] - an entity similar to <code>item_suitcharger</code>.
*{{ent|func_recharge}}, a brush-based version of this entity.
*{{ent|item_healthcharger}}, a version of this entity meant for health.


[[Category:Items]]
[[Category:Items]]

Latest revision as of 04:32, 19 May 2025

English (en)Translate (Translate)
edit
C++ Class hierarchy
CNewRecharge
↳CBaseAnimating
↳CBaseEntity
C++ func_recharge.cpp
Item suitcharger.png
This article is about the point entity. For the brush entity, see func_recharge.

item_suitcharger is a model entity available in Half-Life 2 series Half-Life 2 series. This is the HEV suit charger which gradually replenishes suit power on use, until empty or the suit is at full power.

PlacementTip.gifPlacement Tip:
  • Chargers are best placed with a height of around 48 units between the floor and the center of the recharger entity.
  • To ensure that the player will gain battery rather than lose it, place them in areas occluded from immediate danger, like constant enemy fire from helicopters or tanks. Consider however that, since the player is required to stare at the wall while they are using the charger, they can be used to create tension by placing them where an enemy might still reach the player. Note that chargers could also add good or bad stress to the player if they have to exterminate a load of enemies in a room which a health charger is placed before using it.
Note.pngNote:
  • A suit charger will contain the same total charge regardless of the difficulty setting.
  • A normal suit charger (without any flags checked or cvars changed) will be able to discharge a total of 75 power points (30 in HL2DM).
  • A Citadel recharger will be able to discharge a total of 500 power points (200 in HL2DM), overcharging the HEV suit to a maximum of 200 power points, and while recharging it will also heal health.
  • Kleiner's recharger will be able to discharge a total of 25 power points, regardless of cvar settings.
  • A Citadel/Kleiner recharger combo (with both flags checked) will be able to discharge a total of 30 power points (since Kleiner's recharger is set to 25 power points no matter what, and a Citadel recharger rounds it up to the nearest 10), overcharging the HEV suit to a maximum of 200 power points, and while recharging it will also heal (a total of 15) health for free.
  • Players can change weapons while charging. Confirmed with Half-Life 2: Deathmatch Half-Life 2: Deathmatch.
  • Players can fire any weapon while charging. Confirmed with Half-Life 2: Deathmatch Half-Life 2: Deathmatch.
  • Players can reload weapons while charging. Confirmed with Half-Life 2: Deathmatch Half-Life 2: Deathmatch.
  • Players can't use it without the suit. Deny. Confirmed with Half-Life 2 Half-Life 2.
  • Players can't use it past the limit. Deny. Confirmed with Half-Life 2 Half-Life 2.
Note.pngNote:This entity is also available in Portal 2 Portal 2 and even can charge the suit (you need to change some cvars values). However, it does not function properly[Elaborate?].

Flags

Citadel recharger : [8192]
Kleiner's recharger : [16384]
Only gives 25 health
Icon-Bug.pngBug:Killing a charger while it is being used will make the charging sound loop indefinitely.

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Deathmatch recharge delay (dmdelay) <integer>

Inputs

SetCharge <floatRedirectInput/float> !FGD
Set charge and total charge to a specific amount.
Note.pngNote:Float values cause the model to change, but charge received is rounded down.
Note.pngNote:Despite this input not being in the stock FGD, it is used once by Valve, in ep1_citadel_03.
Recharge
Sets charge to maximum.

Outputs

OutRemainingCharge
Fired once for every single point of power given to the suit. This means it will not fire when the charger is depleted or when the suit is at full power.
OnHalfEmpty
Fired when the "charge left" reaches 50% of its max.
OnEmpty
Fired when the charger is empty.
OnFull
Fired when player gets recharged to the max.
OnPlayerUse
Fired when the player tries to +use the charger.

Cvars/Commands

Cvar/Command Parameters or default value Descriptor Effect
sk_suitcharger 75 (HL2), 30 Half-Life 2: Deathmatch Arbitrary number Total charge of suit points on a normal charger.
sk_suitcharger_citadel 500 (HL2), 200 Half-Life 2: Deathmatch Arbitrary number Total charge of suit points on a citadel charger.
sk_suitcharger_citadel_maxarmor 200 Arbitrary number Maximum suit charge obtainable from a citadel charger.

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Item_suitcharger&oldid=477906"