Skip to main content

point_commentary_node

Point Entity

Defines the position and data of a commentary node.

Keyvalues

  • Parent (parentname) <TargetDestination>
    The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.

  • Parent Bone/Attachment Name (parentAttachmentName) <ParentAttachment>
    The name of the bone or attachment to attach to on the entity's parent in the movement hierarchy. Use !bonemerge to use bone-merge style attachment. NOTE: If this is specified the Hammer transform will be disregarded, even if 'Use Local Transform' is NOT specified (in that case local transform will be identity)

  • Use Local Transform (useLocalOffset) <Boolean>
    Whether to respect the specified local offset when doing the initial hierarchical attachment to its parent.

  • Local Origin (local.origin) <Vector>
    Offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

  • Local Angles (local.angles) <Angle>
    Angular offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

  • Local Scale (local.scales) <Vector>
    Scale in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

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

  • Model (model) <Studio>
    Model to use.

  • Commentary Audio (commentaryfile) <Sound>
    Name of the sound event that contains the commentary audio for this node.

  • Title (title) <String>
    Title of this commentary node.

  • Speaker(s) Names (speakers) <String>
    Name(s) of the speaker(s) in the commentary audio for this node.

  • Node ID (node_id) <Integer>
    The unique number of this node in the current level. If left at 0, the first unused Node ID will be calculated at runtime.

  • Pre Commands (precommands) <String>
    A set of console commands, separated by semi-colon, that should be issued when this node starts playing.

  • Post Commands (postcommands) <String>
    A set of console commands, separated by semi-colon, that should be issued when this node stops playing (due to completion or interruption).

  • View Target Entity (viewtarget) <TargetDestination>
    Optional name of an entity that the player's view will be forced to look at when listening to this node.

  • View Origin Entity (viewposition) <TargetDestination>
    Optional name of an entity that the player's view should move to when listening to this node.

  • Teleport Target (teleport_origin) <WorldPoint>
    Teleport position associated with this node. If players use Mouse2 to jump to the next node, they'll be moved to that node's corresponding teleport position.

  • Prevent Movement? (prevent_movement) <Choices>
    If set, the player will be unable to move while this node is playing.

    • No
    • Yes

  • Start Disabled? (start_disabled) <Choices>
    If set, this node will be disabled on startup, and will require the Enable input to be fired before it will be visible to the player.

    • No
    • Yes

Inputs

  • SetParent <TargetDestination>
    Changes the entity's parent in the movement hierarchy.

  • SetParentAttachment <String>
    Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.

  • SetParentAttachmentMaintainOffset <String>
    Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the parent at the time it is attached.

  • ClearParent <Void>
    Removes this entity from the the movement hierarchy, leaving it free to move independently.

  • FollowEntity <String>
    Bone merges this entity to a parent entity. Call again passing nothing to end the bone merge.

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

  • KillConstrained <Void>
    Removes this entity, all its children, and anything constrained to it, 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.

  • StartCommentary <String>
    Forces a node to start playing.

  • StartUnstoppableCommentary <String>
    Forces a node to start playing, and prevents the player from stopping the playback until it has completed.

  • Enable <Void>
    Enable this node, making it visible to the player.

  • Disable <Void>
    Disable this node, making it invisible to the player.

  • SetNewOrigin <TargetDestination>
    Set a new origin for this commentary node. If it's not in use, it'll teleport to this location immediately. If it's currently being listened to, it'll return to this location when it finishes playing.

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. Parameter is the inflictor.

  • OnCommentaryStarted <Void>
    Fired when this node starts playback.

  • OnCommentaryStopped <Void>
    Fired when this node stops playback.