MPP - Random Object Spawner Script V1.5.2 - Documentation

Makes objects appear in your scene: one random item from your list, at a fixed spot or anywhere inside a radius, when a visitor clicks the spawner, every few minutes on its own, or when another script asks for it (an MPP - Action Button, a scheduler). Keeps the scene clean with a maximum of active objects, a cleanup chat command and a cleanup event. Access by permission mode, per-visitor "not allowed" message, optional sounds.

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

New in V1.5: settings grouped by category, the access scheme shared by every MPP script (Access/Permission Mode (1-3) with a Whitelist and a Blacklist, avatar handles accepted), an Enable Click switch, a private Denied Text for refused clicks, the option to hide the spawner from denied visitors, a cleanup command that follows the permissions and must be typed exactly, a maximum of active objects that holds even under fast clicks, empty list slots skipped instead of destroying an object for nothing, Volume 0 = silent, and warnings in the script console for risky settings. Two settings of V1.4.7 are not carried over: read "Updating from V1.4.7" before you update spawners already placed in a scene.

Quick Start

1. After purchase, the script is in your Inventory in Build mode. Add it to the object that will be the spawner: a pedestal, a chest, a machine.
2. Fill Spawn/Spawnable Clusters with one or more cluster resources from your inventory (the objects to make appear).
3. Set Spawn/Position Offset: where the objects appear, in meters from the spawner (for example <0,0,1> = one meter above it). Leave Spawn/Spawn Radius at 5 for a random spot around that point, or set it to 0 for the exact spot.
4. Choose who may click: Access/Permission Mode (1-3) is 1 by default (you only). Set it to 3 for a spawner open to everyone.
5. Set Spawn/Max Active Items (for example 10) so the scene never fills up: the oldest object is removed before a new one appears.
6. Build and visit: hover the spawner, read "Spawn Object", click.

The rest of this guide details every option.

How It Works

Each spawn picks one filled entry at random in Spawnable Clusters, computes the spawn point (spawner position + Position Offset, then a random point inside Spawn Radius, never below Min Spawn Height), removes the oldest object if Max Active Items is reached, creates the object with Rotation, and plays Spawn Sound at the new object.

In the Build panel the settings are grouped by category: Activation/, Spawn/, Access/, Events/, Sound/ and Debug/.

Activation

• Activation/Enable Click (default On): visitors see Activation/Hover Text ("Spawn Object" by default, 128 characters at most) and click to spawn. Off = no click and no hover text at all; auto spawn, Script Events and the Clean Command still work. Use Off for a spawner driven only by a timer or a button.
• Activation/Cooldown Seconds (default 5, 0 to 600): after a spawn by click or by Script Event, the spawner waits this long for everyone. The hover text disappears during the delay and comes back at its end. Auto spawn ignores it. A silent tenth of a second always separates two spawns, even at 0.
• Activation/Auto Spawn Minutes (default 0 = Off, 1 to 60): one object appears on its own every N minutes, whatever the permissions, the cooldown or Enable Click. Set Max Active Items with it, or the scene fills up.
• Activation/Clean Command (default /CleanSpawned): typed exactly in Nearby Chat (case does not matter), removes every object this spawner created. /CleanSpawned now or /CleanSpawnedBalls do not match. The scene owner can always use it; visitors only if Permission Mode allows them (a refused visitor gets no answer). Lines written in the chat by scripts are ignored. Empty = no command.

Spawn

Tip for a single-item rezzer: one entry in the list, Spawn Radius 0, Max Active Items 1. Each click replaces the object.

Access Control

Who can click, use the Clean Command and, with Use Click Permission On, send events, is set by one number and two lists, in the Access/ group. This is the scheme shared by every MPP script:

• The scene owner is always allowed, in every mode, even if listed in the Blacklist.
• A list that the current mode does not use is ignored, with a warning in the script console.
• Access/Whitelist and Access/Blacklist: avatar handles or avatar UUIDs, separated by commas or semicolons. Handles are not case sensitive and a leading @ is ignored. Display names are not accepted. An old V1.4.7 entry of UUIDs separated by spaces still works: every UUID of it is read, the other words are ignored with a warning. Example: @morgane, friend-handle; 3f2c1a9e-0000-4c1e-9a55-1234567890ab.
• Tip: turn Debug/Debug Logging On and click with the avatar to add: the script console shows its handle and UUID, ready to paste.
• Access/Denied Text (default "You are not allowed to use this spawner."): private message sent to a visitor who clicks without being allowed, at most once every 5 seconds. Empty = silent. A refused Clean Command or Script Event is always silent.
• Access/Hide From Denied (default Off): denied visitors do not see the spawner as clickable (no highlight, no hover text). Applied to the avatars present at start and to each arriving avatar about 2 seconds after arrival, and kept after each cooldown. The access check on click always stays active.

Script Events (buttons, schedulers, your own scripts)

With Events/Enable Script Events On (default), the spawner listens to two Script Events:

Several spawners with the same names all react to one event; give each spawner its own names to target them.

Who may send them: Events/Use Click Permission (default On):

• On: an event that carries the avatar who caused it (an MPP - Action Button does) follows Access/Permission Mode, the owner always allowed. An event without an avatar (a timer, the Day Night scheduler, a script of your own without payload) passes only in mode 3.
• Off: every spawn and clean event is accepted, with or without an avatar.

A refused event is silent for the visitor (Debug Logging writes it in the console). Empty event names are not listened to; the two names must differ.

From an MPP - Action Button: Send as Command On and Command 1 = mpp_randomspawn_spawn (or the clean name). From your own script: post the event name, and send the same data as Action Button when you want the access check to know the avatar (an object with a text property ActivatorAvatarUuid holding the avatar's UUID).

Sound

Editor Properties Reference (26 total)

Activation

Spawn

Access

Events

Sound

Debug

Version Notes

Updating from V1.4.7

Before you update, take a screenshot of the Build panel of one spawner of each kind. Two settings are replaced by new ones and their values are not carried over.

• Your other values carry over: the list of clusters, positions, radius, height, limit, hover text, cooldown, auto spawn, clean command, both lists, sounds, volumes and event names keep their internal names and their values. The panel now shows plain labels in six groups instead of the raw names (ReadyPrompt is Activation/Hover Text, SpawnDelay is Activation/Cooldown Seconds, ClickWhitelistCsv is Access/Whitelist, and so on).
• Permission Mode: replaced by Access/Permission Mode (1-3), which starts at 1 = Owner only on every updated spawner: visitors cannot click until you set it again. Use your screenshot:

• Allow Without Avatar: removed. With Events/Use Click Permission On, an event without an avatar now passes in mode 3 only; turn Use Click Permission Off to accept every event, as the old switch did.
• Three new settings: Activation/Enable Click (On), Access/Denied Text (a private message for refused clicks; empty it for the V1.4.7 silence) and Access/Hide From Denied (Off).
• What behaves differently: the Clean Command must be typed exactly and follows the permissions (in V1.4.7 anyone could clean everything); a lone word in an old list (a label like Friends) is now read as a handle, so check your lists; Spawn Volume and Clean Volume 0 are now silent; a cleanup launched while an object is being created can leave that one object, the next cleanup removes it.

Recipes

A - A pedestal that shows one item. One entry, Spawn Radius 0, Max Active Items 1, Permission Mode 3: each click replaces the item on the display spot.

B - Random props over time. Several entries, Auto Spawn Minutes 5, Max Active Items 10, Enable Click Off: props appear on their own, never more than ten.

C - A loot button. An MPP - Action Button with Send as Command On and Command 1 = mpp_randomspawn_spawn; on the spawner, Use Click Permission On and Permission Mode 3 so everyone can press it, Max Active Items set.

D - A reward for your staff. Permission Mode 2 with their handles in Whitelist, Hide From Denied On: visitors do not even see the spawner as clickable.

E - A cleanup button for you. An MPP - Action Button with Command 1 = mpp_randomspawn_clean and Access/Permission Mode 1 on the button; or simply type /CleanSpawned in the chat.

Troubleshooting

Limits

• The cooldown is shared by everyone: one spawn per cooldown, whoever clicks.
• The Clean Command answers only exact lines typed by avatars; text posted by other scripts is ignored.
• Position Offset and Rotation are in the scene axes: turning the spawner does not turn its spawn point.
• Up to 20 entries in Spawnable Clusters and 100 active objects.

Related MPP Items

MPP - My Pretty Pixels. Random Object Spawner Script V1.5.2 (script MPP - Random Object Spawner). Store: https://www.sansar.com/store/listings/1de81a6d-1e59-4b68-9423-c11b4deaa61d/random-object-spawner-script