Merge pull request TeamSpen210#207 from Luke18033/unified-fgd-changes-4

Unified FGD changes: TF2 edition

Author: TeamSpen210

fgd/bases/BaseEntity.fgd

@@ -1,5 +1,5 @@
 // Special case - entities that aren't quite brushes or point ents.
-@BaseClass base(BaseEntityIO) = BaseEntity
+@BaseClass base(BaseEntityInputs, BaseEntityOutputs) = BaseEntity
 	[
 	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. " +

fgd/bases/BaseEntityBrush.fgd

@@ -1,4 +1,4 @@
-@BaseClass base(BaseEntityIO) = BaseEntityBrush
+@BaseClass base(BaseEntityInputs, BaseEntityOutputs) = BaseEntityBrush
 	[
 	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. " +

fgd/bases/BaseEntityIO.fgd fgd/bases/BaseEntityInputs.fgdfgd/bases/BaseEntityIO.fgd renamed to fgd/bases/BaseEntityInputs.fgd

@@ -1,7 +1,6 @@
-// IO available on all entities.
-@BaseClass = BaseEntityIO
-	[
-	// Inputs
+@BaseClass = BaseEntityInputs
+[
+    // Inputs
 	input Kill(void) : "Removes this entity from the world."
 	input KillHierarchy(void) : "Removes this entity and all its children from the world."
 
@@ -17,23 +16,16 @@
 	input DispatchEffect[until_L4D](string) : "Dispatch an effect from the entity's origin. See https://developer.valvesoftware.com/wiki/List_of_Client_Effects"
 
 	input RunScriptFile[VSCRIPT](string) : "Execute a game script file from disk."
-	input RunScriptCode[+VSCRIPT, -srctools, -TF2](script) : "Execute a string of script source code."
-	input RunScriptCode[+VSCRIPT, +srctools, -TF2](script) : "Execute a string of script source code. Backtick ( ` ) characters will be converted to quotes in-game for strings."
+	input RunScriptCode[+VSCRIPT, -srctools, -TF2](script) : "Execute a string of script source code. Using double quote characters will corrupt the VMF, so strings cannot be passed in."
+	input RunScriptCode[+VSCRIPT, +srctools, -TF2](script) : "Execute a string of script source code. Using double quote characters will corrupt the VMF, use backticks ( ` ) instead if you need to pass in a string."
 	// TF2 does this in game code.
-	input RunScriptCode[+TF2, +VSCRIPT](script) : "Execute a string of script source code. Backtick ( ` ) characters will be converted to quotes in-game for strings."
+	input RunScriptCode[+TF2, +VSCRIPT](script) : "Execute a string of script source code. Using double quote characters will corrupt the VMF, use backticks ( ` ) instead if you need to pass in a string."
 	input RunScriptCodeQuotable[+MBase, +VSCRIPT](string) : "Execute a string of script source code which converts double apostrophes ('') to quotation marks for strings."
 	input CallScriptFunction[VSCRIPT](string) : "Execute the given function name."
 	input ClearScriptScope[+MBase, +VSCRIPT](void) : "Clears this entity's script scope"
 	input TerminateScriptScope[+TF2, +VSCRIPT](void) : "Terminates the script scope of the entity."
 
-	// Outputs
-	output OnUser1(void) : "Fired in response to FireUser1 input."
-	output OnUser2(void) : "Fired in response to FireUser2 input."
-	output OnUser3(void) : "Fired in response to FireUser3 input."
-	output OnUser4(void) : "Fired in response to FireUser4 input."
-	output OnKilled[MBase, L4D](void) : "Fired when the entity is killed and removed from the game."
-
-	// Mapbase BaseEntity changes:
+    // Mapbase Inputs:
 	input PassUser1[MBase](string) : "Causes this entity's OutUser1 output to be fired, passing along the parameter unchanged."
 	input PassUser2[MBase](string) : "Causes this entity's OutUser2 output to be fired, passing along the parameter unchanged."
 	input PassUser3[MBase](string) : "Causes this entity's OutUser3 output to be fired, passing along the parameter unchanged."
@@ -50,8 +42,8 @@
 	input AcceptInput[MBase](string) : "Fires the named input on this entity. Format: '<input name>:<parameter>:<activator>:<caller>:<output ID>' (SetTarget:cheese). Everything beyond the input name is optional. Mind the fact this is arranged differently from FireOutput, having the parameter right after the input name."
 	input CancelPending[MBase](void) : "Cancels any events fired by this entity that are currently pending in the I/O event queue."
 
-	input AddSpawnFlags[MBase](integer) : "Adds spawnflag(s) to this entity. Many spawnflags have their respective numbers suffixed in this FGD."
-	input RemoveSpawnFlags[MBase](integer) : "Removes spawnflag(s) to this entity. Many spawnflags have their respective numbers suffixed in this FGD."
+	input AddSpawnFlags[MBase](integer) : "Adds spawnflag(s) to this entity. Spawnflags have their respective numbers prefixed in this FGD."
+	input RemoveSpawnFlags[MBase](integer) : "Removes spawnflag(s) to this entity. Spawnflags have their respective numbers prefixed in this FGD."
 
 	input AddSolidFlags[MBase](integer) : "Adds solid flags to this entity."
 	input RemoveSolidFlags[MBase](integer) : "Removes solid flags from this entity."
@@ -62,12 +54,7 @@
 	input SetTarget[MBase](target_destination) : "Sets this entity's target. This is specific to certain entities, particularly logic entities that involve a target."
 	input SetOwnerEntity[MBase](target_destination) : "Sets this entity's owner entity. This has nothing to do with parenting and has more to do with collision and kill credits."
 
-	input SetThinkNull[MBase](void) : "Sets this entity's general think function to null. Behavior varies from entity to entity.."
+	input SetThinkNull[MBase](void) : "Sets this entity's general think function to null. Behavior varies from entity to entity."
 
 	input Use[MBase](void) : "More or less replicates the player interacting with an entity. (+USE)"
-
-	output OutUser1[MBase](string) : "Fires in response to PassUser1 input, with the parameter passed through unchanged."
-	output OutUser2[MBase](string) : "Fires in response to PassUser2 input, with the parameter passed through unchanged."
-	output OutUser3[MBase](string) : "Fires in response to PassUser3 input, with the parameter passed through unchanged."
-	output OutUser4[MBase](string) : "Fires in response to PassUser4 input, with the parameter passed through unchanged."
-	]
+]

fgd/bases/BaseEntityOutputs.fgd

@@ -0,0 +1,15 @@
+@BaseClass = BaseEntityOutputs
+[
+    // Outputs
+	output OnUser1(void) : "Fired in response to FireUser1 input."
+	output OnUser2(void) : "Fired in response to FireUser2 input."
+	output OnUser3(void) : "Fired in response to FireUser3 input."
+	output OnUser4(void) : "Fired in response to FireUser4 input."
+	output OnKilled[MBase, L4D](void) : "Fired when the entity is killed and removed from the game."
+
+    // Mapbase Outputs
+	output OutUser1[MBase](string) : "Fires in response to PassUser1 input, with the parameter passed through unchanged."
+	output OutUser2[MBase](string) : "Fires in response to PassUser2 input, with the parameter passed through unchanged."
+	output OutUser3[MBase](string) : "Fires in response to PassUser3 input, with the parameter passed through unchanged."
+	output OutUser4[MBase](string) : "Fires in response to PassUser4 input, with the parameter passed through unchanged."
+]

fgd/bases/BaseEntityPoint.fgd

@@ -1,4 +1,4 @@
-@BaseClass base(BaseEntityIO) = BaseEntityPoint
+@BaseClass base(BaseEntityInputs, BaseEntityOutputs) = BaseEntityPoint
 	[
 	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. " +

fgd/bases/BaseObject.fgd

@@ -3,8 +3,16 @@
 	teamnum[engine](integer) : "Team" : 2
 	teamnum(choices) : "Team" : 2 : "Team" =
 		[
-		2: "Red"
-		3: "Blue"
+		2: "RED"
+		3: "BLU"
+		]
+
+	defaultupgrade[engine](integer) : "Starting Upgrade Level" : 0
+	defaultupgrade(choices) : "Starting Upgrade Level" : "0" =
+		[
+		0: "Level 1"
+		1: "Level 2"
+		2: "Level 3"
 		]
 
 	spawnflags(flags) : "spawnflags" =
@@ -13,8 +21,8 @@
 		]
 
 	// Inputs
-	input SetBuilder(string) : "Sets the builder of this object to the player given (from an output)"
-	input SetSolidToPlayer(string) : "Sets the builder solid to the player given (from an output)"
+	input SetBuilder(string) : "Sets the builder of this object to the !activator"
+	input SetSolidToPlayer(integer) : "Sets if the building should be solid to players other than its builder"
 	input Show(void) : "Makes the building visible and tries to re-enable it."
 	input Hide(void) : "Makes the building invisible and disables it."
 	input SetHealth(integer) : "Sets a new value for the breakable's health. If the breakable's health reaches zero it will break."

fgd/bases/Door.fgd

@@ -42,7 +42,7 @@
 		32: "Toggle" : 0
 		256: "Use Opens" : 0
 		512: "NPCs Can't" : 0
-		1024: "Touch Opens" : 1
+		1024: "Touch Opens" : 0
 		2048: "Starts locked" : 0
 		4096: "Door Silent" : 0
 		131072: "Block Infected nav when closed" : 0 [L4D, L4D2]

fgd/bases/NavAttributeRegion.fgd

@@ -20,4 +20,10 @@
 	precise(boolean) : "Precise" : 0
 	crouch(boolean) : "Crouch" : 0
 	stairs(boolean) : "Stairs" : 0
+	remove_attributes(integer) : "Remove Attributes" : 0 : "Should remove attributes from nav areas instead of applying them?"
+	tank_only(boolean) : "Tank Only" : 0
+	mob_only(boolean) : "Mob Only" : 0
+
+	// Inputs
+	input ApplyNavAttributes(void) : "Applies the nav attributes."
 	]

fgd/bases/TFPickup.fgd

@@ -0,0 +1,12 @@
+@BaseClass base(Item) 
+	appliesto(TF2)
+	sphere(fademindist) 
+	sphere(fademaxdist) = TFPickup: "Base class for TF2 item pickups"
+	[
+	pickup_sound(string) : "Sound Effect" : : "The sound script entry that is played when the item is picked up."
+	pickup_particle(string) : "Particle Effect" : : "The particle effect that is displayed when the item is picked up."
+
+	// Outputs
+	output OnRedPickup(void) : "Sent when RED picks-up the item."
+	output OnBluePickup(void) : "Sent when BLU picks-up the item."
+	]

fgd/bases/TeamNum.fgd

@@ -5,7 +5,7 @@
 		[
 		0: "Any"
 		2: "RED"
-		3: "BLU/ROBOTS"
+		3: "BLU/Robots"
 		5 : "Halloween Bosses"
 		1 : "Spectator / Halloween Souls"
 		]