Skip to main content

ambient_generic

ambient_generic icon

Point Entity

Universal ambient sound. Use it to play and control a single sound.

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 Name (message) <Sound>
    Name of the GameSound entry for the sound to play. Also supports direct .wav filenames.

  • Volume (health) <Integer>
    Sound volume, expressed as a range from 0 to 10, where 10 is the loudest.

  • Dynamic Presets (preset) <Choices>

    • None
    • Huge Machine
    • Big Machine
    • Machine
    • Slow Fade in
    • Fade in
    • Quick Fade in
    • Slow Pulse
    • Pulse
    • Quick pulse
    • Slow Oscillator
    • Oscillator
    • Quick Oscillator
    • Grunge pitch
    • Very low pitch
    • Low pitch
    • High pitch
    • Very high pitch
    • Screaming pitch
    • Oscillate spinup/down
    • Pulse spinup/down
    • Random pitch
    • Random pitch fast
    • Incremental Spinup
    • Alien
    • Bizzare
    • Planet X
    • Haunted

  • Start Volume (volstart) <Integer>

  • Fade in time in seconds (0-100) (fadeinsecs) <Integer>

  • Fade out time in seconds (0-100) (fadeoutsecs) <Integer>

  • Pitch (pitch) <Integer>
    Sound pitch, expressed as a range from 1 to 255, where 100 is the sound's default pitch.

  • Start Pitch (pitchstart) <Integer>

  • Spin up time (0-100) (spinup) <Integer>

  • Spin down time (0-100) (spindown) <Integer>

  • LFO type 0)off 1)sqr 2)tri 3)rnd (lfotype) <Integer>

  • LFO rate (0-1000) (lforate) <Integer>

  • LFO mod pitch (0-100) (lfomodpitch) <Integer>

  • LFO mod vol (0-100) (lfomodvol) <Integer>

  • Incremental Spinup Count (cspinup) <Integer>

  • Max Audible Distance (radius) <String>
    Maximum distance at which this sound is audible.

  • Spawnflags (spawnflags) <Flags>

    • Play everywhere
    • Start Silent
    • Is NOT Looped

  • SourceEntityName (SourceEntityName) <TargetDestination>
    If an entity is specified, sound will come from this named entity instead of the location of ambient_generic.

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.

  • Pitch <Integer>
    Sets the sound pitch, expressed as a range from 1 to 255, where 100 is the sound's default pitch.

  • PlaySound <Void>
    Starts the sound.

  • StopSound <Void>
    Stops the sound if it is playing.

  • ToggleSound <Void>
    Toggles the sound between playing and stopping.

  • Volume <Integer>
    Sets the sound volume, expressed as a range from 0 to 10, where 10 is the loudest.

  • FadeIn <Integer>
    Fades the sound up to full volume over a specified number of seconds, with a range from 0 to 100 seconds.

  • FadeOut <Integer>
    Fades the sound to silence over a specified number of seconds, with a range from 0 to 100 seconds.

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.