MPP - Sound States On Grab Script V1.1.2 - Documentation

Gives a prop three sound states: a base sound while nobody holds it (a hum, an ambience, a music pad), a held sound while a visitor carries it, and a release sound when they let it go, played once or looped until the base sound comes back. The sounds play from the object itself, so they follow it around the scene.

This script is standalone - it does not require any other MPP script to function.

New in V1.1.2: a quick release, grab and release no longer cuts the release sound short nor starts the base sound twice; a volume of 0 really plays no sound; warnings in the script console for a missing audio component, a wrong component name, an object that cannot be grabbed or a release loop too short to be heard; a Debug Logging switch that writes every sound start. Settings grouped by category in the Build panel. Your settings are kept when you update: see "Updating from v1.1".

Quick Start

1. After purchase, the script is in your Inventory in Build mode. Add it to a prop your visitors can pick up: a lantern, a music box, a toy.
2. Make sure the object is a physics object (a RigidBody) that can be grabbed, and add an Audio component to it so the sounds follow the object.
3. Assign your sounds from your inventory: Base/Sound (usually a loop), Held/Sound (usually a loop), Release/Sound (usually a one-shot).
4. Build and visit. The base sound plays; pick the object up: the held sound takes over; let it go: the release sound plays, then the base sound comes back.

That is all most props need. The rest of this guide details every option.

How It Works

Each sound has its own Volume (0 to 200 percent, 100 = the sound as recorded, 0 = no sound at all) and its own Looping switch. In the Build panel the settings are grouped by category: Audio/, Base/, Held/, Release/ and Debug/.

Audio Component

The sounds are played on the object's Audio component, so they move with the object when it is carried.

• Audio/Audio Component Name empty (default): the first Audio component of the object.
• A name: the Audio component with that exact name (spaces around it are ignored, letter case counts). If no component has that name, the first one is used and a warning says so in the script console.
• No Audio component at all: the sounds play at the position the object had when they started, and do not follow it. A warning says so at start. Add an Audio component to the object to fix it.

Base Sound

• Base/Sound: the sound played while the object is not held. Empty = none.
• Base/Volume (100) and Base/Looping (On): with Looping On the sound loops until the next grab; Off, it plays once at the scene start and once after each release (when Resume Base After Release is On).

Held Sound

• Held/Sound: the sound played while the object is held. Empty = none.
• Held/Volume (100) and Held/Looping (On): with Looping Off the sound plays once per grab, and is cut at the release if it is still playing.

Release Sound

• Release/Sound: the sound played when the object is released. Empty = none.
• Release/Volume (100) and Release/Looping (Off): a one-shot sound (Off) is left to finish; a looping sound (On) plays until the next grab, or until the base sound comes back.
• Release/Resume Base After Release (On): the base sound restarts Release/Base Resume Delay Seconds after each release (default 0.1 s, 0 to 5). Set the delay to the length of your release sound so they do not overlap. With Looping On on the release sound, the delay is the length of that loop: with the default 0.1 s it is barely heard, and a warning says so at start (raise the delay, or turn Resume Off).
• Resume Base After Release Off: the base sound never comes back after the first grab.

A fast release, grab and release keeps the full delay from the last release: the release sound plays its full time and the base sound starts once.

Volume

The three Volume settings go from 0 to 200 percent and are converted to decibels: 100 = the sound as recorded, 50 = about -6 dB (half the amplitude), 200 = about +6 dB (twice the amplitude). 0 = the sound is not played at all; the other two sounds behave as usual, and a muted release sound keeps its delay before the base sound comes back.

Editor Properties Reference (13 total)

Audio

Base

Held

Release

Debug

Version Notes

Updating from v1.1

• Your values carry over: the 13 settings of v1.1 keep their internal names, their defaults and their ranges. As with any update, take a screenshot of the Build panel first, update one object and check its panel before doing the others.
• Labels: the settings now sit in five groups. Same settings, same values:

• What behaves differently: a volume of 0 plays nothing (v1.1 played the sound at -80 dB, almost silent); a fast release, grab and release keeps the full delay and starts the base sound once (v1.1 cut the release loop early and started the base sound twice). The warnings at start are new.

Recipes

A - Lantern. Base: a soft hum loop at 60. Held: a short click, Looping Off. Release: an air whoosh, Looping Off, 90. Resume On, delay 0.15.

B - Music box. Base: a music loop at 50. Held: the same music at 100, Looping On. Release: nothing. Resume On, delay 0: the music simply gets louder while held.

C - Magic orb. Base: nothing. Held: an energy loop. Release: a long reverb tail, Looping On. Resume Off: the tail loops until the next grab.

D - One sound only. Only Held/Sound set: silence, then a sound while the object is carried.

Troubleshooting

Limits

• One object, one set of sounds: for two props, put the script on each.
• An avatar who leaves the scene while holding the object may leave the held sound playing until the next grab.
• The volume is applied when a sound starts, not while it plays.

Related MPP Items

MPP - My Pretty Pixels. Sound States On Grab Script V1.1.2 (script MPP - Sound States On Grab). Store: https://www.sansar.com/store/listings/3495dbd5-f76f-452a-a43a-2445d5304815/sound-states-on-grab-script