FGD documentation updates (#283)

Author: pivotman319-owo

CREDITS.md

@@ -3,3 +3,4 @@
 - [ZPS: Supplemental Hammer Icons](http://www.necrotalesgames.com/tools/index.php) (some icons)
 - [ts2do's HL2 FGDs](http://halflife2.filefront.com/file/HalfLife_2_Upgraded_Base_FGDs;48139) (some more icons)
 - [Ficool2's FGD pack](https://tf2maps.net/downloads/ficool2s-overhauled-fgd-all-entities-documentated-icons.7209/) (several icons)
+- [Ash](https://github.com/ashanderite) (icons for gamerules, point_changelevel)

fgd/bases/BaseLogicalNPC.fgd

@@ -4,7 +4,7 @@
 = BaseLogicalNPC
 	[
 	health(integer): "Health" : : "Overrides the NPC's default health. Cannot be higher than Max Health."
-	max_health(integer): "Max Health" : : "Overrides the NPC's max health. Health cannot exceed this amount."
+	max_health(integer): "Max Health" : : "Overrides the NPC's maximum health. Health will not be able to exceed this amount."
 	squadname(string) : "Squad Name" : : "NPCs that are in the same squad (i.e. have matching squad names) will share information about enemies, and will take turns attacking and covering each other."
 	hintgroup(string) : "Hint Group" : : "Hint groups are used by NPCs to restrict their hint-node searching to a subset of the map's hint nodes. Only hint nodes with matching hint group names will be considered by this NPC."
 	hintlimiting(boolean) : "Hint Limit Nav" : 0 : "Limits NPC to using specified hint group for navigation requests, but does not limit local navigation."
@@ -18,19 +18,19 @@
 
 	spawnflags(flags) : "spawnflags" =
 		[
-		1: "Wait Till Seen" : 0
+		1: "Wait till seen" : 0
 		2: "Gag (No IDLE sounds until angry)" : 0
 		4: "Fall to ground (unchecked means *teleport* to ground)" : 1
-		8: "Drop Healthkit" : 0
+		8: "Drop a health kit" : 0
 		16: "Efficient - Don't acquire enemies or avoid obstacles" : 0
-		128: "Wait For Script" : 0
+		128: "Wait for script" : 0
 		256: "Long Visibility/Shoot" : 0
 		512: "Fade Corpse" : 1
 		1024: "Think outside PVS" : 0
-		2048: "Template NPC (used by npc_maker, will not spawn)" : 0
-		4096: "Do Alternate collision/player avoidance for this NPC (largely obsolete, use Start/StopScripting)" : 0
+		2048: "Template NPC (used by npc_template_maker, will not spawn)" : 0
+		4096: "Do alternate collision/player avoidance for this NPC (largely obsolete, use Start/StopScripting)" : 0
 		8192: "Don't drop weapons" : 0
-		16384: "Ignore player push (dont give way to player)" : 0
+		16384: "Ignore player push (don't give way to player)" : 0
 		]
 
 	sleepstate(choices) : "Sleep State" : "0" : "Holds the NPC in stasis until specified condition. See also 'Wake Radius' and 'Wake Squad'." =

fgd/bases/RappelNPC.fgd

@@ -1,10 +1,11 @@
 @BaseClass base(BaseNPC) = RappelNPC
 	[
-	waitingtorappel(boolean) : "Waiting to Rappel?" : 0 : "If yes, this NPC spawns suspended in air and awaits a BeginRappel input. It will then spawn a zipline and slide down. When it hi" + "ts the ground, NPC will cut away the line and try to move forward a few feet to make room for the next NPC. The NPC will not att" + "empt to clear its landing space if it cannot do so by taking a few steps forward"
+	waitingtorappel(boolean) : "Waiting to Rappel?" : 0 : "If yes, this NPC spawns suspended in air and awaits a BeginRappel input. It will then spawn a zipline and slide down.\n\n" +
+	"When this NPC hits the ground, it will cut the zipline and try to move forward a few feet to make room for the next NPC. The NPC will not attempt to clear its landing space if it cannot do so by taking a few steps forward."
 
 	// Inputs
-	input BeginRappel(void) : "BeginRappel"
+	input BeginRappel(void) : "Start rappeling."
 
 	// Outputs
-	output OnRappelTouchdown(void) : "Fires when done rappeling"
+	output OnRappelTouchdown(void) : "Fires when this NPC has finished rappeling."
 	]

fgd/bases/prop_dynamic_base.fgd

@@ -25,15 +25,15 @@
 
 
 	// Inputs
-	input SetAnimation(string) : "Force the prop to play an animation. The parameter should be the name of the animation."
+	input SetAnimation(string) : "Make this prop play an animation. The parameter should be the name of the animation."
 	input SetDefaultAnimation(string) : "Set the Default Animation to the one specified in the parameter."
 	input SetPlaybackRate(float) : "Set the playback rate for the animation."
 	input SetBodyGroup(integer) : "Set the visible bodygroup, by index."
 	input TurnOn(void) : "Make the prop visible."
 	input TurnOff(void) : "Make the prop invisible."
 	input EnableCollision(void) : "Enable collision on the prop."
 	input DisableCollision(void) : "Disable collision on the prop."
-	input SetAnimationNoReset(string) : "Force the prop to play an animation unless the prop is already playing the animation. The parameter should be the name of the animation."
+	input SetAnimationNoReset(string) : "Make this prop play an animation unless it is already playing one. The parameter should be the name of the animation."
 	input BecomeRagdoll(void) : "Change into a ragdoll immediately."
 	input FadeAndKill(void) : "Fade out then remove this prop."
 

fgd/brush/npc/npc_heli_avoidbox.fgd

@@ -1,11 +1,10 @@
 @SolidClass base(BaseEntityBrush) 
 	appliesto(+HL2_ENTITIES, +USE_AI) 
 	color(255 255 0) 
-= npc_heli_avoidbox: "Helicopter avoidance box"
+= npc_heli_avoidbox: "Makes Combine helicopters and gunships avoid this area."
 	[
 	spawnflags(flags) : "spawnflags" =
 		[
 		65536: "Avoid the box above and below" : 0
 		]
-
 	]

fgd/brush/npc/npc_heli_nobomb.fgd

@@ -1,6 +1,6 @@
 @SolidClass base(BaseEntityBrush) 
 	appliesto(+HL2_ENTITIES, +USE_AI) 
 	color(255 255 0) 
-= npc_heli_nobomb: "Helicopter bombing suppressor"
+= npc_heli_nobomb: "Prevents Combine helicopters from carpet bombing if their bounding boxes intersect with this brush."
 	[
 	]

fgd/engine/spraycan.fgd

@@ -1,35 +1,35 @@
 @PointClass base(BaseEntityPoint)
 	color(200 0 0) 
 	iconsprite("editor/env_global.vmt")
-= env_global: "An entity to control a game-specific global states."
+= env_global: "An entity that controls game-specific global states."
 	[
 
 	globalstate[engine](string) : "Global State to Set"
-	globalstate(string) : "Global State to Set"
+	globalstate(string) : "Global State to Set" : : "The global condition to set in this map. This will influence the behavior of specific entities."
 
-	globalstate[P2CE](choices) : "Global State to Set" =
+	globalstate[P2CE](choices) : "Global State to Set" : : "The global condition to set in this map. This will influence the behavior of specific entities." =
 		[
-		"no_pinging_blue": "Prevent Pinging ATLAS"
-		"no_pinging_orange": "Prevent Pinging P-Body"
-		"no_taunting_blue": "Prevent Taunting ATLAS"
-		"no_taunting_orange": "Prevent Taunting P-Body"
-		"player_regenerates_health": "Prevent player health regen from turrets"
+		"no_pinging_blue": "Disable Atlas's ping tool (Co-op)"
+		"no_pinging_orange": "Disable P-body's ping tool (Co-op)"
+		"no_taunting_blue": "Disable Atlas gestures (Co-op)"
+		"no_taunting_orange": "Disable P-body gestures (Co-op)"
+		"player_regenerates_health": "Disable player health regeneration"
 		"slowtime_enabled": "Enable player usage of +slowtime"
-		"gordon_precriminal": "Gordon is pre-criminal"
-		"antlion_allied": "Antlions are player allies"
+		"gordon_precriminal": "Police neutrality towards player/citizens"
+		"citizens_passive": "Citizen neutrality towards player/Combine NPCs"
+		"gordon_invulnerable": "Player is invincible"
 		"suit_no_sprint": "HEV suit sprint disabled"
-		"super_phys_gun": "Super gravity gun enabled"
-		"citizens_passive": "Citizens are neutral to Gordon & combine"
-		"gordon_invulnerable": "Gordon is invulnerable"
+		"friendly_encounter": "Lower player weapons"
 		"no_seagulls_on_jeep": "Don't spawn seagulls on jeep"
-		"friendly_encounter": "Lower HL2 weapons"
-		"ep2_alyx_injured": "Alyx injured behavior from EP2"
-		"ep_alyx_darknessmode": "Alyx darkness behavior from EP1"
-		"hunters_to_run_over": "Amount of hunters to run over before they dodge"
+		"antlion_allied": "Friendly antlions"
+		"super_phys_gun": "Supercharged gravity gun enabled"
+		"ep_alyx_darknessmode": "Lowlife \"darkness mode\" (Ep1)"
+		"ep2_alyx_injured": "Debuffed Alyx Gun/\"Alyx Injured Mode\" (Ep2)"
+		"hunters_to_run_over": "Hunter roadkills to dodge counter (Ep2)"
 		]
 
 	initialstate[engine](integer) : "Initial State" : 0
-	initialstate(choices) : "Initial State" : 0 =
+	initialstate(choices) : "Initial State" : 0 : "Controls the active state for this global. Setting this to \"Dead\" permanently disables this global, and will not persist during level transitions." =
 		[
 		0: "Off"
 		1: "On"
@@ -44,10 +44,10 @@
 
 
 	// Inputs
-	input TurnOn(void) : "Set state of global to ON."
-	input TurnOff(void) : "Set state of global to OFF."
+	input TurnOn(void) : "Turns on this global."
+	input TurnOff(void) : "Turns off this global."
 	input Toggle(void) : "Toggles state of global between ON and OFF."
-	input Remove(void) : "Set state of global to DEAD."
+	input Remove(void) : "Permanently disables this global and prevents it from persisting during level transitions."
 	input SetCounter(integer) : "Sets the counter value of this global."
 	input AddToCounter(integer) : "Adds to the counter value of this global. Negative numbers subtract."
 	input GetCounter(void) : "Causes the Counter output to be fired, passing the current counter value for this global. This doesn't work properly."

fgd/point/env/env_global.fgd

@@ -1,6 +1,6 @@
 @FilterClass base(filter_base)
 	iconsprite("editor/filter_class.vmt")
-= filter_activator_class: "A filter that filters by the class name of the activator."
+= filter_activator_class: "A filter that checks for the class name of the activator."
 	[
 	filterclass(string) : "Filter Classname" : : "The class name to filter by. " +
 		"If the filter mode is Allow, only entities whose class name matches the given string will pass the filter. " +

fgd/point/filter/filter_activator_class.fgd

@@ -1,6 +1,6 @@
 @FilterClass base(filter_base)
 	iconsprite("editor/filter_mass.vmt")
-= filter_activator_mass_greater: "A filter that filters by the mass of the activator."
+= filter_activator_mass_greater: "A filter that checks if the mass of the activator is greater or equal to a given number."
 	[
 	filtermass(float) : "Filter Mass" : : "The mass to filter by. If the filter mode is Allow, only entities whose mass is greater than the give float will pass the filter. " +
 		"If the filter mode is Disallow, all entities EXCEPT those whose mass is greater than the given float will pass the filter."