Prop vehicle crane

Class hierarchy
CPropCrane ↳CBaseProp ↳CBaseAnimating ↳CBaseEntity
vehicle_crane.cpp

The typical models/Cranes/crane_docks.mdl model, with an attached models/props_wasteland/cranemagnet01a.mdl phys_magnet.

prop_vehicle_crane is a model entity available in Half-Life 2 series.

It is a player-drivable crane. It requires an attached phys_magnet (see KVs).

Important:In the FGD, a base class with the default script jeep_test.txt is used, so you need to change the Vehicle Script KV to scripts/vehicles/crane.txt.

Keyvalues

Magnet entity (magnetname) <targetname>

The crane will not show up at all unless a phys_magnet with a model is specified in this field. The crane will automatically be connected to the entity with a rope/wire.

Note:Set the magnet's "Mass Scale" to something like 500, or it will be bouncy and unusable.

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:

• 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 ) / jeep_test.txt
• prop_vehicle_choreo_generic:
  • Half-Life 2: Episode One only:
  • choreo_vehicle.txt
  • choreo_vehicle_ep1_dogintro.txt
  • Half-Life 2: Episode Two only:
  • choreo_vehicle_ep2_barn1.txt
  • choreo_vehicle_ep2_hangar.txt
  • choreo_vehicle_ep2_intro.txt
  • choreo_vehicle_ep2_Outland_02.txt
  • choreo_vehicle_ep2_playertrapped.txt
• 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 )
• p3_vehicle_segway: segway.txt (only in )

Scale of action input / framerate (actionScale) <float>

Todo: How fast the vehicle turns/accelerates?

Inputs

ForcePlayerIn

Force the player to get into the crane. Only works in singleplayer.

BaseDriveableVehicle:

HandBrakeOn

HandBrakeOff

Turns the handbrake on/off, preventing the vehicle from driving but not disabling motion from external forces.

BaseVehicle:

Action <floatRedirectInput/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.

Outputs

BaseDriveableVehicle:

PlayerOn <void>

PlayerOff <void>

!activator = the player
!caller = this entity
Player entered/exited the vehicle.

PressedAttack <void>

PressedAttack2 <void>

!activator = !caller = this entity
Player pressed the +attack/+attack2 key.

AttackAxis <floatRedirectOutput/float>

Attack2Axis <floatRedirectOutput/float>

!activator = the player when exitting the vehicle other-wise it's this entity
!caller = this entity
State of the attack/attack2 buttons (can only be 0 or 1). Also called when the player exits the vehicle.

See also

• npc_cranedriver
• phys_magnet
• Crane