Prop vehicle choreo generic: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(input/output sections are now fancier)
Line 13: Line 13:
==Inputs==
==Inputs==
* {{I BaseDriveableVehicle}}
* {{I BaseDriveableVehicle}}
* '''Open'''
; '''<code>Open</code>'''
: Plays the vehicle's open animation and unlocks the vehicle for entry or exit.
: Plays the vehicle's open animation and unlocks the vehicle for entry or exit.
* '''Close'''
; '''<code>Close</code>'''
: Plays the vehicle's close animation and locks the vehicle for entry or exit.
: Plays the vehicle's close animation and locks the vehicle for entry or exit.
* '''EnterVehicle'''
; '''<code>EnterVehicle</code>'''
: Forces the activator (or player) into the vehicle.
: Forces the activator (or player) into the vehicle.
* '''EnterVehicleImmediate'''
; '''<code>EnterVehicleImmediate</code>'''
: Forces the activator (or player) into the vehicle without enter/exit animations.
: Forces the activator (or player) into the vehicle without enter/exit animations.
* '''ExitVehicle'''
; '''<code>ExitVehicle</code>'''
: Boots the activator (or player) out of the vehicle.
: Boots the activator (or player) out of the vehicle.
* '''SetMinPitch'''
; '''<code>SetMinPitch</code>''' <code><[[integer]]></code>
* '''SetMaxPitch'''
: Sets the minimum pitch the player can look at, in degrees.
* '''SetMinYaw'''
; '''<code>SetMaxPitch</code>''' <code><[[integer]]></code>
* '''SetMaxYaw'''
: Sets the maximum pitch the player can look at, in degrees.
To Do: Add the rest of the outputs
; '''<code>SetMinYaw</code>''' <code><[[integer]]></code>
: Sets the minimum yaw the player can look at, in degrees.
; '''<code>SetMaxYaw</code>''' <code><[[integer]]></code>
: Sets the maximum yaw the player can look at, in degrees.
; '''<code>SetCanShoot</code>''' <code><[[boolean]]></code>
: Whether the player is allowed to fire their weapon or not. {{P2 add}}
{{Todo|Add the rest of the inputs}}
==Outputs==
==Outputs==
* {{O BaseDriveableVehicle}}
* {{O BaseDriveableVehicle}}
Line 34: Line 40:
* '''OnClose'''
* '''OnClose'''
: Fired when the vehicle too closed to enter.
: Fired when the vehicle too closed to enter.
{{Todo|Add the rest of the outputs}}
[[Category:Half-Life 2: Episode One Entities]]
[[Category:Half-Life 2: Episode One Entities]]

Revision as of 12:09, 26 April 2020

Template:Base point multi

Entity Description

Generic Choreo vehicle used for scripted and complicated scenes and events.

Keyvalues

  • 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?


  • model
<studio> World model
  • ignoremoveparent
<boolean> Should the player ignore this vehicle's move parent when performing exit checks.
  • ignoreplayer
<boolean> If set, the player won't collide against this vehicle when moving around.

Inputs

  • 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.
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.
SetMinPitch <integer>
Sets the minimum pitch the player can look at, in degrees.
SetMaxPitch <integer>
Sets the maximum pitch the player can look at, in degrees.
SetMinYaw <integer>
Sets the minimum yaw the player can look at, in degrees.
SetMaxYaw <integer>
Sets the maximum yaw the player can look at, in degrees.
SetCanShoot <boolean>
Whether the player is allowed to fire their weapon or not. Template:P2 add
Todo: Add the rest of the inputs

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.
  • OnOpen
Fired when the vehicle is open enough to enter.
  • OnClose
Fired when the vehicle too closed to enter.
Todo: Add the rest of the outputs