Template:Archived Page History/Template:KV BaseTrain: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (standard-table)
(Updated)
Line 1: Line 1:
{{ScrollBox|title=BaseTrain|
{{KV|First Stop Target|target_destination|The name of the first path_track in the train's path. The train will spawn at this path_track. It will also turn to face direction indicated by the 'Orientation Type' setting.}}
{{KV|Max Speed (units / second)|integer|The maximum speed that this train can move. Any speeds applied to this train, such as by path_tracks or <code>SetSpeed</code> inputs, will be clipped to this maximum value.}}
{{KV|Initial Speed (units / second)|integer|The speed that the train will move at after it spawns, 0 {{=}} stopped.}}
{{KV|Change Velocity|choices|The method through which this train changes its velocity as it moves along the path.}}
:* 0 : Instantaneously
:* 1 : Linear blend
:* 2 : Ease in/ease out
{{KV|Change angles|choices|The method through which this train changes its orientation as it moves along the path.}}
:* 0 : Never (fixed orientation)
:* 1 : Near path_tracks
:* 2 : Linear blend
:* 3 : Ease in/ease out
{{KV|Distance Between the Wheels|integer|Used for turning and stopping.}}
{{KV|Height above track|integer|The height above the track that this train moves.}}
{{KV|Bank Angle on Turns|string}}
{{KV|Damage on Crush|integer|The amount of damage this train does to entities that block it.}}
{{KV|Minimum Light Level|string|The minimum level of ambient light that hits this brush.}}
{{KV|Move Sound|sound|A sound that is played (and looped) while the train is moving.}}
{{KV|Move Ping Sound|sound|A sound that is played more frequently as the train speeds up.}}
{{KV|Start Sound|sound|A sound played when the train starts moving.}}
{{KV|Stop Sound|sound|A sound played when the train stops moving.}}
{{KV|Volume (10 {{=}} loudest)|integer|Volume of the sound when the train is moving.}}
{{KV|Min pitch (1-255, > 100 {{=}} higher)|integer|The sound pitch value that the train will approach as it comes to a stop.}}
{{KV|Max pitch (1-255, > 100 {{=}} higher)|integer|The sound pitch value that the train will approach as it approaches its max speed (or 1000 inches/second if the 'Use max speed for pitch shifting move sound' flag is not set).}}
{{KV|Min move sound interval|float|Minimum interval at which to play the move ping sound.}}
{{KV|Max move sound interval|float|Maximum interval at which to play the move ping sound.}}
{{KV Targetname}}
{{KV Targetname}}
*{{KV Parentname}}
{{KV Parentname}}
*{{KV Origin}}
{{KV Origin}}
*{{KV RenderFields}}
{{KV RenderFields}}
*{{KV Global}}
{{KV Global}}
*{{KV Shadow}}
{{KV Shadow}}
*'''target'''
}}<noinclude>
:<target_destination> The name of the first [[path_track]] in the train's path. The train will spawn at this path_track. It will also turn to face direction indicated by the 'Orientation Type' setting.
[[Category:Keyvalue Templates|BaseTrain]]
*'''startspeed'''
</noinclude>
:<integer> The maximum speed that this train can move. Any speeds applied to this train, such as by path_tracks or '''SetSpeed''' inputs, will be clipped to this maximum value.
*'''speed'''
:<integer> The speed that the train will move at after it spawns, 0 = stopped.
*'''velocitytype'''
:<choices> Change Velocity.
:{| {{standard-table}}
! Literal value || Description
|-
| 0 || Instantaneously
|-
| 1 || Linear blend
|-
| 2 || Ease in/ease out
|}
*'''orientationtype'''
:<choices> Change angles.
:{| {{standard-table}}
! Literal value || Description
|-
| 0 || Never (fixed orientation)
|-
| 1 || Near path_tracks
|-
| 2 || Linear blend
|-
| 3 || Ease in/ease out
|}
*'''wheels'''
:<integer> Used for turning and stopping.
*'''height'''
:<integer> The height above the track that this train moves.
*'''bank'''
:<string> Bank Angle on Turns.
*'''dmg'''
:<integer> The amount of damage this train does to entities that block it.
*'''_minlight'''
:<string> The minimum level of ambient light that hits this brush.
*'''MoveSound'''
:<sound> A sound that is played (and looped) while the train is moving.
*'''MovePingSound'''
:<sound> A sound that is played more frequently as the train speeds up.
*'''StartSound'''
:<sound> A sound played when the train starts moving.
*'''StopSound'''
:<sound> A sound played when the train stops moving.
*'''volume'''
:<integer> Volume (10 = loudest).
*'''MoveSoundMinPitch'''
:<integer> The sound pitch value that the train will approach as it comes to a stop.
*'''MoveSoundMaxPitch'''
:<integer> The sound pitch value that the train will approach as it approaches its "max speed" (or 1000 inches/second if the 'Use max speed for pitch shifting move sound' flag is not set)
*'''MoveSoundMinTime'''
:<float> Minimum interval at which to play the move ping sound.
*'''MoveSoundMaxTime'''
:<float> Maximum interval at which to play the move ping sound.

Revision as of 10:39, 25 July 2011

BaseTrain:
First Stop Target ([todo internal name (i)]) <targetname>
The name of the first path_track in the train's path. The train will spawn at this path_track. It will also turn to face direction indicated by the 'Orientation Type' setting.
Max Speed (units / second) ([todo internal name (i)]) <integer>
The maximum speed that this train can move. Any speeds applied to this train, such as by path_tracks or SetSpeed inputs, will be clipped to this maximum value.
Initial Speed (units / second) ([todo internal name (i)]) <integer>
The speed that the train will move at after it spawns, 0 = stopped.
Change Velocity ([todo internal name (i)]) <choices>
The method through which this train changes its velocity as it moves along the path.
  • 0 : Instantaneously
  • 1 : Linear blend
  • 2 : Ease in/ease out
Change angles ([todo internal name (i)]) <choices>
The method through which this train changes its orientation as it moves along the path.
  • 0 : Never (fixed orientation)
  • 1 : Near path_tracks
  • 2 : Linear blend
  • 3 : Ease in/ease out
Distance Between the Wheels ([todo internal name (i)]) <integer>
Used for turning and stopping.
Height above track ([todo internal name (i)]) <integer>
The height above the track that this train moves.
Bank Angle on Turns ([todo internal name (i)]) <string>
Damage on Crush ([todo internal name (i)]) <integer>
The amount of damage this train does to entities that block it.
Minimum Light Level ([todo internal name (i)]) <string>
The minimum level of ambient light that hits this brush.
Move Sound ([todo internal name (i)]) <sound>
A sound that is played (and looped) while the train is moving.
Move Ping Sound ([todo internal name (i)]) <sound>
A sound that is played more frequently as the train speeds up.
Start Sound ([todo internal name (i)]) <sound>
A sound played when the train starts moving.
Stop Sound ([todo internal name (i)]) <sound>
A sound played when the train stops moving.
Volume (10 = loudest) ([todo internal name (i)]) <integer>
Volume of the sound when the train is moving.
Min pitch (1-255, > 100 = higher) ([todo internal name (i)]) <integer>
The sound pitch value that the train will approach as it comes to a stop.
Max pitch (1-255, > 100 = higher) ([todo internal name (i)]) <integer>
The sound pitch value that the train will approach as it approaches its max speed (or 1000 inches/second if the 'Use max speed for pitch shifting move sound' flag is not set).
Min move sound interval ([todo internal name (i)]) <float>
Minimum interval at which to play the move ping sound.
Max move sound interval ([todo internal name (i)]) <float>
Maximum interval at which to play the move ping sound.
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
Parentname:
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.

Origin:

Origin (X Y Z) (origin) <origin>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.

RenderFields:


Render Mode (rendermode) <byte choices>
Set a non-standard rendering mode on this entity.
Render Modes
  • 0: Normal
  • 1: Color
  • 2: Texture
  • 3: Glow
  • 4: Solid/Alphatest Obsolete
  • 5: Additive
  • 6: Removed, does nothing Obsolete
  • 7: Additive Fractional Frame
  • 8: Alpha Add
  • 9: World Space Glow
  • 10: Don't Render
Render FX (renderfx) <byte choices>
Various somewhat legacy alpha effects. See render effects.
Render Amount / Transparency (renderamt) <byte>
Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
Render Color (R G B) (rendercolor) <color255>
Color tint.
Global:
Global Entity Name (globalname) <string>
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.

Shadow:

Disable Shadows (disableshadows) <boolean>
Prevents the entity from creating cheap render-to-texture shadows, or lightmap shadows if the entity is a prop_static. Does not affect shadow mapping.
Disable Receiving Shadows (disablereceiveshadows) <boolean>
Prevent the entity from receiving dynamic shadows on itself.
Shadow Cast Distance (shadowcastdist) <integer> !FGD
Sets how far the entity casts dynamic shadows. 0 means default distance from the shadow_control entity.
Disable Shadow Depth (disableshadowdepth) <boolean> (in all games since Portal 2)
Used to disable rendering into shadow depth (for projected textures) for this entity.
Disable flashlight (disableflashlight) <boolean> (in all games since Portal 2)
Used to disable projected texture lighting and shadows on this entity.
Projected Texture Cache (shadowdepthnocache) <integer choices> (in all games since Portal 2)
Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead.
Choices
  • 0 : Default
  • 1 : No cache - render every frame
  • 2 : Cache it - render only once