env_instructor_vr_hint

env_instructor_vr_hint is a point entity available in Half-Life: Alyx.

The env_instructor_hint entity

An entity that allows for creation and control of VR Based instructor lessons by map logic.

Keyvalues

Caption (hint_caption) ([todo internal name (i)]) <string>

The text of your hint.

Start Sound (hint_start_sound) ([todo internal name (i)]) <string>

Sound to play when the lesson starts

Timeout (hint_timeout) ([todo internal name (i)]) <integer>

The automatic timeout for the hint. 0 will persist until stopped with EndHint.

Layout Type (hint_layoutfiletype) ([todo internal name (i)]) <choices>

Panorama Layout file to be used. Generic Hand, World or Custom. Custom requires specifying .xml file

Custom Layout File (hint_custom_layoutfile) ([todo internal name (i)]) <string>

Custom Path to a xml file ie - file://{resources}/layout/custom_hint.xml

Panel Attach Type (hint_vr_panel_type) ([todo internal name (i)]) <choices>

Attach Type for the Panorama Panel

Target Entity (hint_target) ([todo internal name (i)]) <targetname>

The entity to show this hint on top of. The entity used must exist on the client, info_target_instructor_hint can be parented to server only entities for this purpose. Set hint_vr_panel_type.

Height Offset (hint_vr_height_offset) ([todo internal name (i)]) <float>

Height offset from the target entities root the panel should be displayed at.

Height Offset (hint_vr_height_offset) ([todo internal name (i)]) <float>

Height offset from the target entities root the panel should be displayed at.

Source 2 Targetname:

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Entity Scripts (vscripts) <scriptlist>

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.

Create Client-Only Entity (clientSideEntity) <choices>

• 0: No
• 1: Yes

Source 2 Transform:

Origin (origin) <coordinates>

The world space origin of the entity.

Angles (angles) <angles>

The pitch, yaw, roll orientation of the entity.

Scale (scales) <vector>

The x, y, z scales of the entity. Not all entities can use this.

Transform Locked (transform locked) <boolean>

Lock the transform at its current value, preveting the transform of the node from being modified.

Force Hidden (force hidden) <boolean>

Visually hides the entity from the viewports. The Outliner pane will still list hidden entities.

Editor Only (editor only) <boolean>

Entity is only displayed in Hammer and will not appear in game.

Inputs

ShowHint

Start showing the hint. If an entity name is passed as a parameter, the hint is shown only to that entity.

EndHint

Stop showing the hint if it hasn't already timed out.

Source 2 Targetname:

Kill

Removes this entity from the world.

KillHierarchy

Removes this entity and all its children from the world.

AddOutput <string>

Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
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.

RunScriptFile <string>

Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.

RunScriptCode <string>

Execute a string of VScript source code in the scope of the entity receiving the input.

CallScriptFunction <string>

Call a script function.

CallPrivateScriptFunction <string>

Calls a script function from this entity's private script scope.

CallGlobalScriptFunction <string>

Calls a script function in the global script scope.

Outputs

Source 2 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

This Output fires when the entity is killed and removed from the game.