Template:KV BaseVehicle

From Valve Developer Community
Revision as of 20:42, 2 May 2021 by Luke18033 (talk | contribs) (Add P2 vehicle scripts and {{only}} tags)
Jump to: navigation, search


Vehicle Script File (vehiclescript)<string>
The vehicle script files contained in scripts\vehicles\ define the behaviour and handling of a vehicle. It is important to match the right script to the right entity/model:
  • prop_vehicle_airboat: airboat.txt
  • prop_vehicle_apc: apc.txt / apc_npc.txt
  • prop_vehicle_crane: crane.txt
  • prop_vehicle_prisoner_pod: prisoner_pod.txt
  • prop_vehicle_jeep: jalopy.txt (only in Half-Life 2: Episode TwoHalf-Life 2: Episode Two) / jeep_test.txt
  • prop_vehicle_choreo_generic:
    • choreo_vehicle.txt (only in Half-Life 2: Episode OneHalf-Life 2: Episode One)
    • choreo_vehicle_ep1_dogintro.txt (only in Half-Life 2: Episode OneHalf-Life 2: Episode One)
    • choreo_vehicle_ep2_barn1.txt (only in Half-Life 2: Episode TwoHalf-Life 2: Episode Two)
    • choreo_vehicle_ep2_hangar.txt (only in Half-Life 2: Episode TwoHalf-Life 2: Episode Two)
    • choreo_vehicle_ep2_intro.txt (only in Half-Life 2: Episode TwoHalf-Life 2: Episode Two)
    • choreo_vehicle_ep2_Outland_02.txt (only in Half-Life 2: Episode TwoHalf-Life 2: Episode Two)
    • choreo_vehicle_ep2_playertrapped.txt (only in Half-Life 2: Episode TwoHalf-Life 2: Episode Two)
    • player_ending.txt (only in Portal 2)
    • player_down.txt (only in Portal 2)
    • br_player_look.txt (only in Portal 2)
    • br_player_view.txt (only in Portal 2)
  • There is also reference_vehicle.txt, which you can modify to make your own vehicle or use as-is.
  • prop_vehicle_sin: sincar.txt / sincar_pit.txt (only in SiN Episodes)
Scale of action input / framerate (actionScale) <float>
To do: How fast the vehicle turns/accelerates?


Collisions <choices>
How objects should collide with the prop. "Bounding box" means using QPhysics.
Lighting Origin <targetname>
An info_lighting to specify a location to sample lighting from, instead of using this entity's origin.
Disable Vertex lighting <bool>
Disable Self-Shadowing with vertex lighting <bool>
Ignore surface normal for computing vertex lighting <bool>
Tweaks to the manner in which VRAD generates per-vertex lighting.
Screen Space Fade <bool>
The method by which the fading distance should be determined.
  • Yes: fade "distance" is the size of the object on-screen, in pixels.
  • No (default): fade distance is the distance from the camera, in units.
Start Fade Dist/Pixels <float>
Normally: distance at which the prop starts to fade (<0 means use End Fade Dist).
Screen Space Fade mode: width in pixels of the prop when it starts to fade.
End Fade Dist/Pixels <float>
Normally: maximum distance at which the prop is visible (0 means don't fade out).
Screen Space Fade mode: width in pixels of the prop when it finishes fading.
Fade Scale <float>
If you specify so in worldspawn, or if the engine is running below DirectX7, props will fade out even if the fade distances above aren't specified. This value gives you some control over when this happens: numbers smaller than 1 cause the prop to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether.


World Model (model) <string>
The model this entity should appear as. 128-character limit.
Skin (skin) <integer>
Some models have multiple skins. This value selects from the index, starting with 0.
Tip.png Tip: Hammer's model browser automatically updates this value if you use it to view different skins.
Model Scale (modelscale) <float> (in all games since Source 2013Source 2013)
A multiplier for the size of the model.


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 ShadowDepth (disableshadowdepth) <boolean> (in all games since Portal 2)
Used to disable rendering into shadow depth (for projected textures) for this entity.
Projected Texture Cache (shadowdepthnocache) <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.
  • 0 : Default
  • 1 : No cache - render every frame
  • 2 : Cache it - render only once
Disable flashlight (disableflashlight) <boolean> (in all games since Portal 2)
Used to disable projected texture lighting and shadows on this entity.


Render in Fast Reflections (drawinfastreflection) <boolean> (in all games since Portal 2)
If enabled, this entity will render in fast water reflections (i.e. when a water material specifies $reflectonlymarkedentities) and in the world impostor pass.


Minimum DX Level (mindxlevel) <choices>
The entity will not exist if the engine is running outside the given range of DirectX Versions. Replaced by SystemLevelChoice from Left 4 Dead Left 4 Dead onwards.
Warning.png Warning: If these are used, the object may break when the user switches their DirectX settings.
Maximum DX Level (maxdxlevel) <choices>


Pitch Yaw Roll (Y Z X) (angles) <angle>
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.


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.


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


Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (in all games since Left 4 Dead 2)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (in all games since Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note.png Note: Try to avoid expensive operations in this function, as it may cause performance problems.


Allow Physics Gun (gmod_allowphysgun) <boolean> (only in Garry's Mod)
If set, players cannot use Physics Gun on this entity.
Sandbox Tool Whitelist (gmod_allowtools) <string> (only in Garry's Mod)
If set, only given tools can be used on this entity. You need to supply the tool class names, the names of the .lua files of those tools. This also includes the context menu properties!