prop_vehicle_choreo_generic

From Valve Developer Community
Jump to navigation Jump to search

prop_vehicle_choreo_generic is a point entity available in Half-Life 2 series Half-Life 2 series and Portal series Portal series. It is a generic vehicle used for scripted scenes and other complicated events.

Class hierarchy
CPropVehicleChoreoGeneric
CDynamicProp
CBreakableProp
CBaseProp
CBaseAnimating
CBaseEntity
vehicle_choreo_generic.cpp

Keyvalues

World model (model) <model path>
Ignore Move Parent on Exit (ignoremoveparent) <boolean>
Should the player ignore this vehicle's move parent when performing exit checks?
Ignore Player collision (ignoreplayer) <boolean>
If set, the player won't collide against this vehicle when moving around.
Use Player Eyes (useplayereyes) <boolean> !FGD
Todo: Document me
player can shoot (playercanshoot) <boolean> (only in Portal 2)
Todo: Document me
use attachment eyes (useattachmenteyes) <boolean> (only in Portal 2)
Todo: Document me

BaseDriveableVehicle:

Starts locked (VehicleLocked) <boolean>
Players cannot enter vehicle until it is unlocked.

BaseVehicle:

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:
Scale of action input / framerate (actionScale) <float>
Todo: How fast the vehicle turns/accelerates?


Inputs

Open
Plays the vehicle's open animation and unlocks the vehicle for entry or exit.
Close
Plays the vehicle's close animation and locks the vehicle for entry or exit.
EnterVehicle
Forces the activator (or player) into the vehicle.
EnterVehicleImmediate
Forces the activator (or player) into the vehicle without enter/exit animations.
ExitVehicle
Boots the activator (or player) out of the vehicle.
ViewLock <boolean>
Set true to prevent player from looking around *at all*. Set false to let player look within limits.
SetAnimation <string>
Force the prop to play an animation. The parameter should be the name of the animation.
SetCanShoot  (only in Portal 2)
Todo: Document me
UseAttachmentEyes  (only in Portal 2)
Todo: Document me
SetMaxPitch  (only in Portal 2)
Todo: Document me
SetMinPitch  (only in Portal 2)
Todo: Document me
SetMaxYaw  (only in Portal 2)
Todo: Document me
SetMinYaw  (only in Portal 2)
Todo: Document me
BaseDriveableVehicle:
HandBrakeOn
HandBrakeOff
Turns the handbrake on/off, preventing the vehicle from driving but not disabling motion from external forces.
BaseVehicle:
Action <float>
Set the speed of the action animation.
Todo: What does this mean?
TurnOn
Start engine and enable throttle.
TurnOff
Stop engine, disable throttle, engage brakes.
Lock
Unlock
Prevent/allow the player from entering or exiting the vehicle.

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

BaseDriveableVehicle:

PlayerOn
PlayerOff
Player entered/exited the vehicle. (!activator is the player.)
PressedAttack
PressedAttack2
Player pressed the +attack/+attack2 key.
AttackAxis <boolean>
Attack2Axis <boolean>
State of the attack/attack2 buttons. Also called when the player exits the vehicle.


OnOpen
Fired when the vehicle is open enough to enter.
OnClose
Fired when the vehicle too closed to enter.