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))
(redid header and description, fixed TODO, added more to See Also)
Line 1: Line 1:
{{DISPLAYTITLE:item_suitcharger}}
{{DISPLAYTITLE:item_suitcharger}}
[[Image:item_suitcharger.jpg|thumb|200px|right|Suit Charger]]
[[Image:item_suitcharger.jpg|thumb|200px|right|Suit Charger]]
{{hl2 point|item_suitcharger}}
{{hl2 point|item_suitcharger}} This is the [[HEV suit]] charger which gradually replenishes suit power on use, until empty or the suit is at full power.
 
{{Placement Tip|
== Entity description ==
* Chargers are best placed with a height of around 48 units between the floor and the center of the recharger entity.
Gradually charges up [[item_suit|HEV suit]] energy on use, until empty.  
* 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.}}


==Notes==
A suit charger will contain the same total charge regardless of the difficulty setting.
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 Suit points (30 in HL2DM).
* 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 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 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 for free.
* Kleiner's recharger will be able to discharge a total of 25 Suit points, regardless of cvar settings.
* Kleiner's recharger will be able to discharge a total of 25 power points, regardless of cvar settings.
* 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.
* A Citadel/Kleiner's 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.
{{Placement Tip|
* Re-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.}}


== Dedicated Console Variables ==
==Dedicated Console Variables==
;sk_suitcharger <[[int]]>
;sk_suitcharger <[[int]]>
: Changes the total charge of suit points of the normal charger (Default: 75 for HL2, 30 for HL2:DM).
: Changes the total charge of suit points of the normal charger (Default: 75 for HL2, 30 for HL2:DM).
Line 25: Line 23:
: Changes the amount of Suit points you can hold when recharging with a citadel charger (Default: 200).
: Changes the amount of Suit points you can hold when recharging with a citadel charger (Default: 200).


== Keyvalues ==
==Keyvalues==
{{KV Targetname}}
{{KV Targetname}}
{{KV Angles}}
{{KV Angles}}
{{KV|_minlight|float|Defines the minimum light level.}}
{{KV|_minlight|float|Defines the minimum light level.}}


== Flags ==
==Flags==
* 8192 : Citadel recharger
* 8192 : Citadel recharger
: Changes charge amount to Citadel recharger amounts (see Entity description).
: Changes charge amount to Citadel recharger amounts (see Entity description).
Line 36: Line 34:
: Changes charge amount to Kleiner's recharger amounts (see Entity description).
: Changes charge amount to Kleiner's recharger amounts (see Entity description).


== Inputs ==
==Inputs==
{{I Targetname}}
{{I Targetname}}
{{IO|SetCharge|Set total charge and charge to a specific amount.|param=float|nofgd=1}}
{{IO|SetCharge|Set total charge and charge to a specific amount.|param=float|nofgd=1}}
Line 43: Line 41:
{{IO|Recharge|Sets charge to maximum}}
{{IO|Recharge|Sets charge to maximum}}


== Outputs ==
==Outputs==
{{O Targetname}}
{{IO|OutRemainingCharge|Fires 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|OutRemainingCharge|}}
{{IO|OnHalfEmpty|Executed when the "charge left" reaches 50% of its max.}}
{{IO|OnHalfEmpty|Executed when the "charge left" reaches 50% of its max.}}
{{IO|OnEmpty|Executed when the Charger is empty.}}
{{IO|OnEmpty|Executed when the Charger is empty.}}
{{IO|OnFull|Executed when player gets recharged to the max.}}
{{IO|OnFull|Executed when player gets recharged to the max.}}
{{IO|OnPlayerUse|Executed when a player uses the entity (Def. E).}}
{{IO|OnPlayerUse|Fired when the player tries to +USE the charger.}}
{{O Targetname}}


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


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

Revision as of 16:24, 14 June 2018

Suit Charger

Template:Hl2 point 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.

Notes

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 for free.
  • Kleiner's recharger will be able to discharge a total of 25 power points, regardless of cvar settings.
  • A Citadel/Kleiner's 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.

Dedicated Console Variables

sk_suitcharger <int>
Changes the total charge of suit points of the normal charger (Default: 75 for HL2, 30 for HL2:DM).
sk_suitcharger_citadel <int>
Changes the total charge of suit points of the citadel charger (Default: 500 for HL2, 200 for HL2:DM.)
sk_suitcharger_citadel_maxarmor <int>
Changes the amount of Suit points you can hold when recharging with a citadel charger (Default: 200).

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

Pitch Yaw Roll (Y Z X) (angles) <QAngle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
_minlight ([todo internal name (i)]) <float>
Defines the minimum light level.

Flags

  • 8192 : Citadel recharger
Changes charge amount to Citadel recharger amounts (see Entity description).
  • 16384 : Kleiner's recharger
Changes charge amount to Kleiner's recharger amounts (see Entity description).

Inputs

SetCharge <floatRedirectInput/float> !FGD
Set total charge and 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 official FGD files, it is used once in an official map, in episodic, map ep1_citadel_03.
Recharge
Sets charge to maximum

Outputs

OutRemainingCharge
Fires 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
Executed when the "charge left" reaches 50% of its max.
OnEmpty
Executed when the Charger is empty.
OnFull
Executed when player gets recharged to the max.
OnPlayerUse
Fired when the player tries to +USE the charger.


See also

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