Avatar Speed Package Script

Description

Version 1.3.2 Control avatar movement speed in your experience using Nearby chat commands, speed zones, or Script Events. MPP — Avatar Speed Package is a dual-script system delivered as a single Script asset in your inventory. It includes a central Controller that manages all speed logic and optional Zone triggers that request speed changes through Script Events. This architecture keeps your experience organized, scalable, and easy to maintain, while allowing speed changes to be triggered from multiple systems. New in 1.3: the speed stays inside the range Sansar really applies (0.1 to 4), with "already at maximum / minimum" messages instead of announcing a speed the avatar does not get; /speedset accepts a comma or a dot; a private "please wait" message for a command that comes too soon; zones no longer slowed by the cooldown; in global mode, a refused visitor gets a private message and the person who triggers gets one summary; one clean return after a timed boost; avatar handles in the lists; settings grouped by category. 1.3.2 uses the same Permission Mode + Whitelist + Blacklist scheme as every MPP script and a numeric Zone Action. See "Updating from 1.2" below before you update a scene. Perfect for: • obstacle courses and parkour maps • racing or movement challenges • roleplay areas with slow/fast zones • adventure experiences with temporary boosts • interactive systems controlled by buttons or events Speed changes can be triggered through: • Nearby chat commands • speed zones (trigger volumes or contact) • Script Events from other scripts (including MPP – Action Button) ________________________________________ Key Features • Nearby chat commands /speedhelp /speedup /speeddown /speedreset /speedset <value> (comma or dot) • Flexible speed control Define minimum and maximum SpeedFactor values and adjust movement using a configurable Step Coefficient, inside the 0.1 to 4 that Sansar applies. • Local or global control Apply speed changes only to the triggering avatar, or to everyone in the experience. • Access control for global changes — New in 1.3 Permission Mode 1 owner only, 2 owner + whitelist, 3 everyone except blacklist, by avatar handle or UUID; private "not allowed" message. • Multi-zone gameplay ready Create unlimited SpeedUp, SpeedDown, Reset, or Set zones (Zone Action 1-4). • ScriptEvent integration Trigger speed changes from other scripts such as MPP – Action Button or custom systems. • Anti-spam cooldown — Improved in 1.3 Per-avatar cooldown for commands and events, with a private "please wait" message (customizable, or silent). Zones only keep a 0.1 s safety. • Optional timed boosts Temporary speed boosts automatically reset after a configurable duration, with one clean return. • Optional sound feedback Independent sounds for SpeedUp, SpeedDown, Reset, and Set actions (0-200 %, 0 = silent). Sound behavior: • Local mode → 3D positional sound from the avatar • Global mode → single global sound when applied to everyone ________________________________________ Quick Setup 1. Add the MPP – Avatar Speed Controller module to one object in your scene (one controller per experience). 2. Optional: add the MPP – Avatar Speed Zone module to trigger volumes and set Zone Action (1 SpeedUp, 2 SpeedDown, 3 Reset, 4 Set). 3. Make sure zone objects include a RigidBodyComponent and have collision enabled (Trigger Volume recommended). 4. Ensure the Script Event message name matches between controller and zones (default works out of the box). 5. Adjust speed limits, cooldown, permissions, sounds, and boost duration as desired. ________________________________________ Technical Details • Controller: 37 settings in eight groups (Activation, Speed, Access, Chat, Events, Sound, Messages, Debug); Zone: 5 settings • Speed kept inside Sansar's 0.1 to 4; warnings at start for a range, a step or a list that does not fit • /speedhelp lists only the active commands, with the real range and the scope • Optional Debug Logging with the SpeedFactor read from Sansar ________________________________________ Full documentation online: https://mpp-mainstore.com/sansar/AvatarSpeedPackage/ ________________________________________ Updating from 1.2 — please read • Take a screenshot of the Build panel of the Controller and of one Zone of each action BEFORE updating the script. • Your settings are kept (commands, range, step, cooldown, boost, lists, events, messages, sounds), except two: the global Permission Mode, now a number that starts at 2 (owner + whitelist: OwnerOnly → 1, OwnerAndBlacklist → 3), and the Zone Action, now a number that starts at 1 (SpeedUp: set 2, 3 or 4 on your SpeedDown, Reset and Set zones). • New settings at their defaults: Cooldown Notice (on), Cooldown Notice Text, Denied Text. • After the update, check that the Controller object still runs the Controller module and each zone the Zone module. Changelog — Version 1.3.2 • Access group with Permission Mode (1-3), Whitelist, Blacklist and a Denied Text setting, the same scheme as every MPP script. • Zone Action as a number (1 SpeedUp, 2 SpeedDown, 3 Reset, 4 Set). • Labels aligned with the other MPP scripts; modules named "MPP - Avatar Speed Controller" and "MPP - Avatar Speed Zone". Changelog — Version 1.3.0 • Speed kept inside the 0.1 to 4 that Sansar applies; "already at maximum / minimum" messages. • /speedset accepts a comma or a dot. • Private "please wait" message for a command refused by the cooldown. • Zones are no longer slowed by the cooldown (a Reset zone right after a SpeedUp zone works). • Global mode: an ordinary sentence gets no answer, a refused command a private message at most every 5 s, one summary and one sound for the person who triggers. • Timed boost: one return to the initial speed, restarted by each new change, cancelled by a Reset. • Lists accept avatar handles as well as UUIDs; annotated entries keep their UUIDs. • Sound Volume 0 = no sound. • /speedhelp lists only the active commands with the real range. • Settings grouped by category; warnings at start for inconsistent settings. Changelog — Version 1.2 • Added ScriptEvent support allowing other scripts to trigger speed actions (SpeedUp / SpeedDown / Reset / Set). • Added MPP – ActionButton compatibility for interactive speed control. • Improved anti-spam cooldown logic to prevent repeated commands without actual speed changes. • Added timed boost system allowing automatic reset after a configurable duration. • Improved stability and internal speed change validation. ________________________________________ Enjoy and Keep Good Vibes. Hugs from Morgane. ________________________________________