Filled missing descriptions for all entities & minor tweaks. (#308)

Co-authored-by: Laveig <LavaGue228@users.noreply.github.com>

Author: Laveig

fgd/base_entity.fgd

@@ -6,53 +6,52 @@
 = _CBaseEntity_
 	[
 	classname(string) : "Classname" : : "The class of the entity, and is changed."
-	origin(origin) : "Position" : "0 0 0"
-	angles(angle) : "Pitch Yaw Roll (X Y Z)" : "0 0 0"
+	origin(origin) : "Position" : "0 0 0" : "Range in which this NPC will search for busy hints."
+	angles(angle) : "Pitch Yaw Roll (X Y Z)" : "0 0 0" : "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."
 
 	targetname(target_source) : "Name"
 	hammerid(integer) : "Hammer ID"
 	// Defined here, but don't include - it's treated as 
 	// many different types.
 	// target(target_destination) : "Target" 
-	spawnflags(flags) = []
+	spawnflags(flags) : "spawnflags" : "Flags that can be set on spawn (i.e. in Hammer Editor)" = []
 
 
-	vscripts[VSCRIPT](scriptlist) : "Entity Scripts"
-	thinkfunction[VSCRIPT](string) : "Script think function"
-	nextthink(integer) : "Next Think"
+	vscripts[VSCRIPT](scriptlist) : "Entity Scripts" : : "Name(s) of script files that are executed after all entities have spawned."
+	thinkfunction[VSCRIPT](string) : "Script think function" : : "Name of a function in this entity's script scope which will be called automatically."
+	nextthink(integer) : "Next Think" : : "Name of another function in this entity's script scope which will be called automatically."
+	globalname(string) : "Global Entity Name" : : "Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state."
 
-	globalname(string) : "Global Entity Name"
+	mincpulevel(integer) : "Min CPU Level" : 0 : "This entity will not render if settings are lower than this value."
+	maxcpulevel(integer) : "Max CPU Level" : 0 : "This entity will not render if settings are higher than this value."
+	mingpulevel(integer) : "Min GPU Level" : 0 : "This entity will not render if settings are lower than this value."
+	maxgpulevel(integer) : "Max GPU Level" : 0 : "This entity will not render if settings are higher than this value."
 
-	mincpulevel(integer) : "Min CPU Level" : 0
-	maxcpulevel(integer) : "Max CPU Level" : 0
-	mingpulevel(integer) : "Min GPU Level" : 0
-	maxgpulevel(integer) : "Max GPU Level" : 0
-
-	parentname(target_destination) : "Parent"
+	parentname(target_destination) : "Parent" : "Parent entity that this (child) entity will be attached to and move with."
 
 	teamnumber[+USE_TEAM](integer) : "Team number" : : "Team number this entity is on."
 	pendingteamnumber[+USE_TEAM](integer) : "Pending Team Number" : : "Team numer this entity will be on at the beginning of the next round."
 
-	responseContext(string) : "Response Context" : ""
+	responseContext(string) : "Response Context" : : "Response system context(s) for this entity. Format should be: 'key:value,key2:value2,etc'. When this entity speaks, the list of keys & values will be passed to the response rules system."
 	addon(string) : "AI Addon" : : "Broken ASW feature."
 
-	health(integer) : "Health"
-	max_health(integer) : "Max Health"
-	is_autoaim_target(boolean) : "Is Autoaim Target" : 0
-	damagefilter(filterclass) : "Damage Filter"
-	nodamageforces(boolean) : "No damage forces"
-
-	renderfx(integer) : "Render FX" : 0
-	rendermode(integer) : "Render Mode" : 0
-	renderamt(integer) : "Render Alpha" : 255
-	effects(integer) : "Effects" : 0
-	rendercolor(color255) : "Render Color" : "255 255 255"
+	health(integer) : "Health" : : "Number of points of damage to take before breaking. 0 means don't break."
+	max_health(integer) : "Max Health" : : "Overrides the NPC's max health. Health cannot exceed this amount."
+	is_autoaim_target(boolean) : "Is Autoaim Target" : 0 : "Should this entity automatically aim at its target."
+	damagefilter(filterclass) : "Damage Filter" : : "Name of the filters that control which entities can be damaged by this entity."
+	nodamageforces(boolean) : "No damage forces" : : "Should this entity receive damage forces?"
+
+	renderfx(integer) : "Render FX" : 0 : "Various somewhat legacy alpha effects. Material Proxies are more modern."
+	rendermode(integer) : "Render Mode" : 0 : "Used to set a non-standard rendering mode on this entity. See also 'FX Amount' and 'FX Color'.* Color & Texture = src*a+dest*(1-a)* Glow = src*a + dest, fixed on screen for sprites* Solid = Performs alphatest transparency* Additive = src*a + dest* Additive FF = blend between sprite nimation frames* Alpha Add = src + dest*(1-a)* World Space Glow = src*a + dest"
+	renderamt(integer) : "Render Alpha" : 255 : "Opacity of this entity. 255 is fully opaque. Requires Additive render mode to be set."
+	effects(integer) : "Effects" : 0 : "For configuring visual effects. If you want to combine effects, turn SmartEdit off and add the effect numbers together, i.e. 64 + 8 = 72."
+	rendercolor(color255) : "Render Color" : "255 255 255"  : "A color to mix with the model/sprite."
 	modelindex(integer) : "Model Index" : 0 : "Internal model index, shouldn't be used."
 	model(studio) : "Model" : "" : "Model/sprite name, or brush index."
-	shadowcastdist(integer) : "Shadow Cast Distance" : 0
-	texframeindex(integer) : "Texture Frame" : 0
-	drawinfastreflection(boolean) : "Draw In Fast Reflections"
-	disableshadows(boolean) : "Disable Shadows"
+	shadowcastdist(integer) : "Shadow Cast Distance" : 0 : "Sets how far the entity casts dynamic shadows, in units. 0 means default distance from the shadow_control entity."
+	texframeindex(integer) : "Texture Frame" : 0 : "If the VTF is multi-frame, specifies the frame to use."
+	drawinfastreflection(boolean) : "Draw In Fast Reflections" : 0 : "If enabled, causes this entity/prop to to render in fast water reflections (i.e. when a water material specifies $reflectonlymarkedentities) and in the world impostor pass."
+	disableshadows(boolean) : "Disable Shadows" : 0 : "Prevent the entity from creating render-to-texture (dynamic) shadows."
 	disablereceiveshadows(boolean) : "Disable Recieving Shadows"
 	disableflashlight(boolean) : "Disable Projected Texture Shadows"
 	disableshadowdepth(boolean) : "Disable Shadow Depth"

fgd/bases/BaseActBusy.fgd

@@ -3,15 +3,15 @@
 = BaseActBusy
 	[
 	actor(target_name_or_class) : "Actor(s) to affect" : : "NPC's that should act busy"
-	startactive(boolean) : "Start Active" : 0
+	startactive(boolean) : "Start Active" : 0 : "Should this entity be active on spawn?"
 	searchtype[engine](integer) : "Search Type" : 0
 	searchtype(choices) : "Search Type" : 0 : "How to search for the entities using the targetname." =
 		[
 		0: "Entity Name"
 		1: "Classname"
 		]
-	busysearchrange(float) : "Search Range for Busy Hints" : 2048
-	visibleonly(boolean) : "Visible Busy Hints Only" : 0
+	busysearchrange(float) : "Search Range for Busy Hints" : 2048 : "Range in which this NPC will search for busy hints."
+	visibleonly(boolean) : "Visible Busy Hints Only" : 0 : "Should this NPC use only visible busy hints?"
 
 	// Inputs
 	input Activate(void) : "Begin acting busy"

fgd/bases/BaseBeam.fgd

@@ -1,15 +1,16 @@
 @BaseClass base(BaseEntityPoint, RenderFields, Reflection) 
-= BaseBeam: "This is the definition of the 'beam' class, but we don't want that in the entity list."
+= BaseBeam: "Internal entity." + 
+			"This is the definition of the 'beam' class, but we don't want that in the entity list."
 	[
-	rendermode[engine](integer) readonly : "Render Mode" : 2 : "Render mode is forced to Texture."
+	rendermode[engine](integer) readonly : "Render Mode" : 2
 	rendermode(choices) readonly : "Render Mode" : 1 : "Render mode is forced to Texture, but set to Color in Hammer to ensure correct rendering." = 
 		[
 		1: "Color"
 		]
-	renderamt(integer) : "Brightness (1 - 255)" : 100
-	rendercolor(color255) : "Beam Color (R G B)" : "255 255 255"
+	renderamt(integer) : "Brightness (1 - 255)" : 100 : "Opacity (alpha) of the beam."
+	rendercolor(color255) : "Beam Color (R G B)" : "255 255 255" : "An RGB color value used for this beam."
 
-	hdrcolorscale(float) : "HDR color scale." : 1.0 : "float value to multiply sprite color by when running in HDR mode."
+	hdrcolorscale(float) : "HDR color scale." : 1.0 : "Float value to multiply sprite color by when running in HDR mode."
 	noiseamplitude(float) : "Amount of noise (0-64)" : 0 : "The amount of noise in the beam. 0 is a perfectly straight beam."
 
 	framerate(integer) : "Frames per 10 seconds" : 0 : "Framerate at which the beam texture should animate, if it has multiple frames."
@@ -20,7 +21,7 @@
 
 	damage(string) : "Damage / second" : "0" : "How much damage this beam does per second to things while active. For continuous damage, the value should be greater than 10 or it may not work."
 
-	dissolvetype[engine](integer) : "Dissolve Type" : 0
+	dissolvetype[engine](integer) : "Dissolve Type" : 0 : "If entities interact with the beam, they will be dissolved in the following way."
 	dissolvetype(choices) : "Dissolve Type" : -1 =
 		[
 		-1: "None"

fgd/bases/BaseClusteredDynLight.fgd

@@ -1,6 +1,6 @@
 @BaseClass base(BaseClusteredLight) = BaseClusteredDynLight
 	[
-	spawnflags(flags)  =
+	spawnflags(flags) : "spawnflags" =
 		[
 		1: "Initially dark" : 0
 		2: "Shadowed" : 0
@@ -24,8 +24,9 @@
 		]
 	slopescale(float) : "Slope Scale" : 1.0 : "Shadowmap slope scale. Higher values tend to eat away at the contact shadow, but can get rid of shadow acne. Higher values will also tend to shine through small shadow blockers"
 
-	texturename(string) : "Cookie Texture Name" : "" : "The cookie texture to use for the light. An empty value means no cookie texture."
-	textureframe(integer) : "Cookie Texture Frame" : 0 : "The frame of the cookie texture to use for the light."
+	texturename(string) : "Cookie Texture Name" : "" : "The cookie texture to use for the light. Must be a greyscale VTF file. " +
+	"An empty value means no cookie texture. This light will project the specified texture (aka making artificial shadows)."
+	textureframe(integer) : "Cookie Texture Frame" : 0 : "If cookie texture specified is multi-frame, this frame will be used for the light."
 
 	input SetCookieTexture(string) : "Set the cookie texture of this light. An empty value means no cookie texture."
 	input SetCookieTextureFrame(integer) : "Set the frame texture of the cookie texture for this light."

fgd/bases/BaseClusteredLight.fgd

@@ -1,10 +1,13 @@
 @BaseClass = BaseClusteredLight
 	[
-	spawnflags(flags)  =
+	spawnflags(flags) : "spawnflags" =
 		[
 		1: "Initially dark" : 0
 		2: "Shadowed" : 0
 		]
+
+	linedivider_clus1[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : : "Oops, you must've misclicked."
+
 	_specularmode(choices) : "Specular light mode" : 0 : "The type of specular lighting to use for the light." = 
 		[
 		0: "None"
@@ -31,6 +34,10 @@
 		6: "6"
 		7: "7"
 		]
+
+	linedivider_clus2[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : : "Oops, you must've misclicked."
+		
+	_initialshadowsize(integer) : "Initial Shadow Size" : 3 : "The initial static shadow resolution exponent. Only relevant for static shadow allocation. Adding 1 to this value doubles both dimensions of the shadowmap."
 	nearz(float) : "Near Z" : 4.0 : "Near Z for this light. Determines where shadows start to be cast. Inside the nearz radius, the light is still visible, but anything inside it won't cast shadows"
 
 	input SetShadowSize(integer) : "Set the size exponent of this light's shadowmap(s)."

fgd/bases/BaseDriveableVehicle.fgd

@@ -1,6 +1,6 @@
 @BaseClass base(BaseVehicle)
 	appliesto(+USE_VEHICLES)
-= BaseDriveableVehicle
+= BaseDriveableVehicle: "Internal entity. Contains code about drivable vehicles."
 	[
 	vehiclelocked(boolean) : "Start locked" : 0 : "Whether to start the vehicle locked. A locked vehicle cannot be entered or exited."
 

fgd/bases/BaseDustParticleSpawner.fgd

@@ -2,9 +2,9 @@
 	sphere(distmax)
 = BaseDustParticleSpawner
 	[
-	startdisabled(boolean) : "Start Disabled" : 0
-	color(color255) : "Start Particle Color (R G B)" : "255 255 255"
-	color2(color255) : "End Particle Color (R G B)" : "255 255 255"
+	startdisabled(boolean) : "Start Disabled" : 0 : "Sets this brush as disabled on map spawn."
+	color(color255) : "Start Particle Color (R G B)" : "255 255 255" : "Color of the particle after spawning."
+	color2(color255) : "End Particle Color (R G B)" : "255 255 255" : "Color of the particle when fading."
 	spawnrate(integer) : "Particle Per Second" : 40 : "Number of particles to spawn, per second."
 	speedmax(integer) : "Maximum Particle Speed" : 13 : "Maximum speed that the particles can move after spawning."
 	fallspeed(integer) : "Particle Fall Speed" : 0 : "How fast the particles fall to the ground. This value is subtracted from the particle speed in the Z-axis only."
@@ -16,7 +16,7 @@
 	affectedbywind(boolean) : "Affected by Wind" : 1 : "When set, the dust will be affected by any env_wind entity settings in the map."
 	origin(string) readonly : "Origin" : "0 0 0" : "The origin keyvalue has to be set to 0 0 0 for this entity to work properly in game. If this value isn't 0 0 0, reset it."
 
-	linedivider_base[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : ""
+	linedivider_base[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : : "Oops, you must've misclicked."
 
 	// Inputs
 	input TurnOn(void) : "Turn on."

fgd/bases/BaseEffectBrush.fgd

@@ -1,4 +1,4 @@
-@BaseClass = BaseEffectBrush
+@BaseClass = BaseEffectBrush: "Internal entity. Has nothing to do with brushes, provides basic entity keyvalues such as `Attachment Point` and `Entity Scripts`."
 	[
 	targetname(target_source) : "Name" : : "The name that other entities refer to this entity by."
 	globalname(string) : "Global Entity Name" : : "Name by which this entity is linked to another entity in a different map. " +
@@ -9,5 +9,5 @@
 	vscripts[VSCRIPT](scriptlist) : "Entity Scripts" : : "Name(s) of script files that are executed after all entities have spawned."
 	thinkfunction[VSCRIPT](string) : "Script think function" : : "Name of a function in this entity's script scope which will be called automatically."
 
-	linedivider_base[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : ""
+	linedivider_base[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : : "Oops, you must've misclicked."
 	]

fgd/bases/BaseEntity.fgd

@@ -1,7 +1,7 @@
 // Special case - entities that aren't quite brushes or point ents.
 @BaseClass
 	base(BaseEntityIO)
-= BaseEntity
+= BaseEntity: "The most powerful internal entity. Connects everything together - from functionality to compatibility and vscript integrations. \nThis is also the root of all base entities."
 	[
 	targetname(target_source) : "Name" : : "The name that other entities refer to this entity by."
 	globalname(string) : "Global Entity Name" : : "Name by which this entity is linked to another entity in a different map. " +
@@ -11,5 +11,5 @@
 	vscripts[VSCRIPT](scriptlist) : "Entity Scripts" : : "Name(s) of script files that are executed after all entities have spawned."
 	thinkfunction[VSCRIPT](string) : "Script think function" : : "Name of a function in this entity's script scope which will be called automatically."
 
-	linedivider_base[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : ""
+	linedivider_base[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : : "Oops, you must've misclicked."
 	]

fgd/bases/BaseEntityAnimating.fgd

@@ -42,11 +42,11 @@
 	texframeindex(integer) : "Texture Frame" : : "The frame number for any animated textures on this entity."
 	hitboxset(string) : "Hitbox Set" : : "Sets the $hboxset to use for collision testing."
 
-	modelscale(float) : "Model Scale" : : "A multiplier for the size of the model."
+	modelscale(float) : "Model Scale" : : "A multiplier for the size of the model. Negative values are accepted. Does not alter the physics collisions in most cases, however. Negative values can crash the game!"
 
 	AllowSilentDissolve[+P2](boolean) : "Allow SilentDissolve input" : 1 : "Allow the SilentDissolve input to dissolve this object."
 
-	linedivider_animbase[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : ""
+	linedivider_animbase[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : : "Oops, you must've misclicked."
 
 	LightingOrigin(target_destination) : "Lighting Origin" :  : "Select any entity (not info_lighting!) from which to sample lighting instead of the entity's origin."
 	LightingOriginHack(target_destination) : "Lighting Origin Offset" :  : "The info_lighting_relative from which to sample lighting instead of the entity's origin."
@@ -72,7 +72,7 @@
 	shadowdepthnocache[engine](integer): "": 0
 	disableflashlight(boolean) : "Disable flashlight" : 0 : "Used to disable flashlight (env_projectedtexture) lighting and shadows on this entity."
 
-	linedivider_anim[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : ""
+	linedivider_anim[!engine](string) readonly : "----------------------------------------------------------------------------------------------------------" : : "Oops, you must've misclicked."
 
 	// Inputs
 	input Skin(integer) : "Changes the model skin to the specified number."