This article's documentation is for anything that uses the Source engine. Click here for more information.

Func train: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Brush based instead of point based. As mentioned by the FGD snippet as well as the common naming practice.)
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{ent not in fgd}}
{{LanguageBar}}
{{back|Trains}}
{{back|Trains}}
{{base brush|func_train}}
{{TabsBar|main=gs|base=func_train}}
{{Ent not in fgd}}
{{CD|CFuncTrain|file1=1}}
{{This is a|brush entity|name=func_train}}


== Entity Description ==
It is a leftover from {{Quake|2}} that ping-pongs between the start and end of a series of [[path_corner]]s. Unlike {{ent|func_tracktrain}}, it does not rotate when turning.
It is a leftover from [[Quake]] that ping-pongs between the start and end of a series of path_corners. It was mostly replaced by {{ent|func_tracktrain}} in {{gldsrc|4}}, but was still used for looping auto-scrolling backgrounds. In Source, the introduction of parenting has rendered this method obsolete. However, the entity is still functional.


{{tip|This entity is not affected by the turning inaccuracy issues that <code>func_tracktrain</code> is, making it a good alternative for fast-moving objects.}}
{{tip|This entity is not affected by the turning inaccuracy issues that <code>func_tracktrain</code> is, making it a good alternative for fast-moving objects.}}
{{bug|It will always try to play sounds, regardless of whether they are actually specified. This can be set to <code>Default.Null</code> with a volume of 0 to play no sound.}}
{{bug|It will always try to play sounds, regardless of whether they are actually specified. This can be set to <code>Default.Null</code> with a volume of 0 to play no sound.}}


==KeyValues==
== Keyvalues ==
{{KV|Spawn path_corner|intn=target|target_destination}}
{{Brush rendering note}}
: The name of the first path_corner in the train's path. The train will spawn at this path_corner.
{{KV|Speed|intn=speed|float}}
: Speed at which the train moves.
{{KV|Movement Sound|intn=noise1|string}}
: The sound to play when the train moves.
{{KV|Stop Sound|intn=noise2|string}}
: The sound to play when the train stops moving.
{{KV|Sound Volume (0-10)|intn=volume|float}}
: Volume of the sounds emitted when moving and stopping.
{{KV|Crush Damage|intn=dmg|float}}
: Amount of damage to deal to entities blocking the train.
{{KV BaseEntity|brush=1}}
{{KV RenderFields}}


==Flags==
{{KV Targetname}}
{{KV Angles|Initial orientation of the train.}}
{{KV|Spawn path_corner|intn=target|target_destination|The name of the first path_corner in the train's path. The train will spawn at this path_corner.}}
{{KV|Speed|intn=speed|float|Speed at which the train moves.}}
{{KV|Movement Sound|intn=noise1|string|The sound to play when the train moves.}}
{{KV|Stop Sound|intn=noise2|string|The sound to play when the train stops moving.}}
{{KV|Sound Volume (0-10)|intn=volume|float|Volume of the sounds emitted when moving and stopping.}}
{{KV|Crush Damage|intn=dmg|float|Amount of damage to deal to entities blocking the train.}}
 
== Flags ==
{{fl|1|Wait to retrigger|Set and unset by game code; should not be set manually.}}
{{fl|8|Non-solid}}
{{fl|8|Non-solid}}


==Inputs==
== Inputs ==
{{I BaseEntity}}
{{I|Toggle|Toggle movement}}
{{I RenderFields}}
{{I|Start|Start movement}}
{{IO|Toggle}}
{{I|Stop|Stop movement}}
: Toggle movement
{{IO|Start}}
: Start movement
{{IO|Stop}}
: Stop movement


==Outputs==
{{O BaseEntity|l4d=1}}


==FGD Code==
== FGD Code ==
<!--Editor's note: TexFrameIndex exists on every brush entity, so I'm not sure why it was specifically included here. It should be in KVBaseEntity if anything.-->
<!--Editor's note: TexFrameIndex exists on every brush entity, so I'm not sure why it was specifically included here. It should be in KVBaseEntity if anything.-->
{{pre|
<pre>
@SolidClass base(Targetname, Origin, RenderFields) line(255 255 0, targetname, target) {{=}} func_train: "An old entity leftover from Quake. It follows a series of path_corner entities."
@SolidClass base(Targetname, Origin, Angles, RenderFields) line(255 255 0, targetname, target) = func_train: "An old entity leftover from Quake. It follows a series of path_corner entities."
[
[
spawnflags(flags) {{=}}
spawnflags(flags) {{=}}
Line 62: Line 54:
input Stop(void) : "Stop movement"
input Stop(void) : "Stop movement"
]
]
}}
</pre>
 
[[Category:Entities]]

Latest revision as of 10:40, 26 October 2025

English (en)Translate (Translate)
← Trains
Icon-NotInFGD.png
This entity is not in the FGD by default.
See below for instructions on making it available.
C++ Class hierarchy
CFuncTrain
↳CBasePlatTrain
↳CBaseToggle
↳CBaseEntity
C++ trains.cpp

func_train is a brush entity available in all Source Source games.

It is a leftover from Quake Quake that ping-pongs between the start and end of a series of path_corners. Unlike func_tracktrain, it does not rotate when turning.

Tip.pngTip:This entity is not affected by the turning inaccuracy issues that func_tracktrain is, making it a good alternative for fast-moving objects.
Icon-Bug.pngBug:It will always try to play sounds, regardless of whether they are actually specified. This can be set to Default.Null with a volume of 0 to play no sound.  [todo tested in ?]

Keyvalues

Note.pngNote:For Keyvalues and Inputs affecting brush rendering, see Brush entity/Rendering related keyvalues and inputs


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>
Initial orientation of the train.
Spawn path_corner (target) <targetname>
The name of the first path_corner in the train's path. The train will spawn at this path_corner.
Speed (speed) <float>
Speed at which the train moves.
Movement Sound (noise1) <string>
The sound to play when the train moves.
Stop Sound (noise2) <string>
The sound to play when the train stops moving.
Sound Volume (0-10) (volume) <float>
Volume of the sounds emitted when moving and stopping.
Crush Damage (dmg) <float>
Amount of damage to deal to entities blocking the train.

Flags

Wait to retrigger : [1]
Set and unset by game code; should not be set manually.
Non-solid : [8]

Inputs

Toggle
Toggle movement
Start
Start movement
Stop
Stop movement


FGD Code

@SolidClass base(Targetname, Origin, Angles, RenderFields) line(255 255 0, targetname, target) = func_train: "An old entity leftover from Quake. It follows a series of path_corner entities."
[
	spawnflags(flags) {{=}}
	[
		8 : "Non-solid" : 0
	]
	target(target_destination) : "Spawn path_corner" : : "The name of the first path_corner in the train's path. The train will spawn at this path_corner."
	speed(float) : "Speed" : "50" : "Speed at which the train moves."
	noise1(sound) : "Movement Sound" : "Default.Null" : "The sound to play when the train moves. This must be specified, but can be set to 'Default.Null' to play no sound."
	noise2(sound) : "Stop Sound" : "Default.Null" : "The sound to play when the train stops moving. This must be specified, but can be set to 'Default.Null' to play no sound."
	volume(float) : "Sound volume (0-10)" : "10" : "Volume of the sounds emitted when moving and stopping."
	dmg(float) : "Crush Damage" : "0" : "Amount of damage to deal to entities blocking the train."

	// Inputs
	input Toggle(void) : "Toggle movement"
	input Start(void) : "Start movement"
	input Stop(void) : "Stop movement"
]
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Func_train&oldid=491429"