Skip to main content

snd_event_sphere

snd_event_sphere icon

Point Entity

Plays a sound event from the closest point on a sphere to the player. The origin can be this entity or a specified entity's position.

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.

  • Sound Event Name (soundName) <Sound>
    Name of the sound event to play

  • Source Entity Name (sourceEntityName) <TargetDestination>
    Name of the entity the sound should emit from.

  • Start On Spawn (startOnSpawn) <Boolean>
    Play the sound immediately upon spawning

  • To Local Player (toLocalPlayer) <Boolean>
    Play the sound directly to the local player

  • Re-trigger Stops Last (stopOnNew) <Boolean>
    Stop a previously playing event when a new one is started

  • Save/Restore (saveAndRestore) <Boolean>
    This soundevent should be saved and restored.

  • Entity Attachment Name (sourceEntityAttachment) <String>
    If set, will play the soundevent from this attachment point.

  • Entity Index Selection (entityIndexSelection) <Choices>

    • Use World Index
    • Use Entity Index

  • Radius (radius) <Float>
    Size of soundevent sphere

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.

  • SetSourceEntity <String>
    Set the name of the entity to play the sound from. The sound will follow the entity as it moves.

  • SetSoundEventName <String>
    Set the name of the sound event to play

  • StartSound <Void>
    Start the sound event. If an entity name is provided, the sound will originate from that entity

  • PauseSound <Void>
    Pause the sound event.

  • UnPauseSound <Void>
    UnPause the sound event.

  • StopSound <Void>
    Stop the sound event

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.

  • SoundEventGuid <Integer>
    Sound Event GUID

  • OnSoundFinished <Void>
    Fired when the sound finished playing