Skip to main content

env_instructor_vr_hint

env_instructor_vr_hint icon

Point Entity

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

Keyvalues

  • Entity Scripts (vscripts) <ScriptList>
    Name(s) of script files that are executed after all entities have spawned.

  • Name (targetname) <TargetSource>
    The name that other entities refer to this entity by.

  • Caption (hint_caption) <String>
    The text of your hint.

  • Start Sound (hint_start_sound) <String>
    Sound to play when the lesson starts

  • Timeout (hint_timeout) <Integer>
    The automatic timeout for the hint. 0 will persist until stopped with EndHint.

  • Layout Type (hint_layoutfiletype) <Choices>
    Panorama Layout file to be used. Generic Hand, World or Custom. Custom requires specifying .xml file

    • Default
    • Custom

  • Custom Layout File (hint_custom_layoutfile) <String>
    Custom Path to a xml file ie - file://{resources}/layout/custom_hint.xml

  • Panel Attach Type (hint_vr_panel_type) <Choices>
    Attach Type for the Panorama Panel

    • None
    • Dominant Hand
    • Off Hand
    • Entity
    • HMD
    • Large Entity

  • Target Entity (hint_target) <TargetDestination>
    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) <Float>
    Height offset from the target entities root the panel should be displayed at.

Inputs

  • RunScriptFile <String>
    Load and execute a script file

  • RunScriptCode <String>
    Execute a fragment of script code

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

  • Kill <Void>
    Removes this entity from the world.

  • KillHierarchy <Void>
    Removes this entity and all its children from the world.

  • AddOutput <String>
    Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care.

  • FireUser1 <Void>
    Causes this entity's OnUser1 output to be fired.

  • FireUser2 <Void>
    Causes this entity's OnUser2 output to be fired.

  • FireUser3 <Void>
    Causes this entity's OnUser3 output to be fired.

  • FireUser4 <Void>
    Causes this entity's OnUser4 output to be fired.

  • ShowHint <String>
    Start showing the hint. If an entity name is passed as a parameter, the hint is shown only to that entity.

  • EndHint <Void>
    Stop showing the hint if it hasn't already timed out.

Outputs

  • OnUser1 <Void>
    Fired in response to FireUser1 input.

  • OnUser2 <Void>
    Fired in response to FireUser2 input.

  • OnUser3 <Void>
    Fired in response to FireUser3 input.

  • OnUser4 <Void>
    Fired in response to FireUser4 input.

  • OnKilled <Void>
    Fired when the entity is killed and removed from the game.