point_viewcontrol

From Valve Developer Community
Revision as of 17:52, 14 February 2014 by ILOVEPIE (talk | contribs) (Flags)
Jump to: navigation, search

point_viewcontrol is a point entity available in all Source games. It is a camera entity that controls the player's view. While it's active, the player will see out of the camera.

In code it is represented by class CTriggerCamera, defined in triggers.cpp.

Bug.png Bug: This class appears to have some. Please see its discussion page for notes.

Keyvalues

Entity to Look At <targetname>
Name of the entity that the camera should point at and track while active.
Target Attachment Name <string>
If set, the camera will focus on the specified attachment on the 'Entity to Look At'.
Hold Time <integer>
The amount of time the camera should control the player's view for, after which it deactivates itself. If the camera should stay active until told to deactive, set the 'Infinite Hold Time' spawnflag.
Path Corner <targetname>
The first path corner in a track that the camera should move along once it's activated. If not specified, the camera won't move.
Interpolate Position To Player <boolean>
Gradually interpolate player's position to here on start. (Episodic only)
Initial Speed <string>
The starting speed that the camera moves at, if it's on a path track.
Acceleration units/sec^2 <string>
The speed at which the camera accelerates to path corner's desired speeds.
Stop Deceleration units/sec^2 <string>
The speed at which the camera decelerates to path corner's desired speeds.
Tracking Speed of the camera <float> (in all games since [Portal 2])
The speed that the camera tries to follow it's look target.
FOV <float> (in all games since <Alien Swarm>)
The FOV when using this camera. !FGD
FOV rate <float> (in all games since <Alien Swarm>)
How fast we change to the new fov. !FGD

Targetname:

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.

Angles:

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.

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.

Flags

  • 1 : Start At Player
Start the camera at the player's position. This is kind of buggy, because it breaks the camera movement if the player is still moving when this is activated.
  • 2 : Follow Player
This is the same as if you set the lookat target to !player.
  • 4 : Freeze Player
Stop recognizing input from the player.
  • 8 : Infinite Hold Time
Ignore the hold time, and stay activated until explicitly disabled.
  • 16 : Snap to goal angles
  • 32 : Make Player non-solid
  • 64 : Interruptable by Player
If the player presses +Use, disable.
  • 128 : Set Fov (in all games since <Alien Swarm>) !FGD (in Synergy this flag makes the point_viewcontrol work on all players)

Inputs

Enable
Enable the point_viewcontrol, and start controlling the player's view.
Disable
Disable the point_viewcontrol, and stop controlling the player's view.
SetTarget <string> (in all games since [Portal 2])
Set a new target for the camera to point at.
SetTargetAttachment <string> (in all games since [Portal 2])
Set a new attachment on the target for the camera to point at.
ReturnToEyes  (in all games since [Portal 2])
Return the camera view to the player's eyes.
TeleportToView  (in all games since [Portal 2])
Teleport the player to the current position of the camera.
SetTrackSpeed <float> (in all games since [Portal 2])
Set the speed that the camera will try to track it's target.
SetPath <string> (in all games since [Portal 2])
Have the camera start following a new path.

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and its children from the world.
Note.png Note: Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.
RunScriptFile <script> (in all games since <Left 4 Dead 2>)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since <Left 4 Dead 2>)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug.png Bug: In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning.png Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.

Parentname:

SetParent <string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset <string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.

Outputs

OnEndFollow
Fired when the point_viewcontrol deactivates, due to the Disable input being received, the Entity to Look At being destroyed, or the Hold Time expiring.

Targetname:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (only in <Left 4 Dead><Left 4 Dead 2>)
This output fires when the entity is killed and removed from the game.