ScriptAPI source
Browse practical scripts for interaction, triggers, dialogs, players, character physics, media, lights, materials, audio, animation, spritesheets, spawning, sitpoints, script events, and chat commands. Code blocks are loaded from the raw .cs files in this folder.
These examples are given to show acceptable patterns for user-uploaded scripts on the TestPlatform5 platform. The current script API is the very first version, and alot more system object types and features will be added soon. If you are searching for something specific, use the filter search box below to narrow the examples list shown below.
Shows success and error dialogs, including an OK/Cancel result callback.
Loading DialogDemo.cs...Targets a dialog at a named user and handles the selected button result.
Loading TargetedDialogCallback.cs...Makes the script object clickable and shows a dialog when a user interacts with it.
Loading InteractableSelf.cs...Uses a SceneObject field, hides its renderer, and reports the target id.
Loading SceneObjectReference.cs...Makes a slotted button interactable and toggles a target renderer independently for each user. Private visibility resets when the user rejoins.
Loading RendererVisibleForUser.cs...Runs multi-light dance patterns with timed rotation waypoints. The server sends only a modest number of commands while each client and the shared instance interpolate smoothly between them.
Loading LightControlLerp.cs...Uses a slotted button to switch a directional light on and off, then sends the current shared light state to joining users.
Loading DirectionalLightSwitch.cs...A glow switch: click a button and the chosen objects (with everything inside them) fade into a glow, click again and they fade out. Pick the colour, strength and fade time in the Inspector; optionally a colour per object. Uses SetObjectGlow / ClearObjectGlow.
Loading MaterialEmissionListDemo.cs...Registers a click target and changes a media screen URL for one screen id or all screens.
Loading MediaScreenUrl.cs...Adds a /privatevideo <url> or /privatevideo <screenId> <url> chat command that changes what the media screens show for the player who typed it only (/yt is the built-in command that changes them for everybody). The command name can be changed in the Inspector.
Loading PrivateMediaScreenChat.cs...Toggles an emote on the person who clicks, everyone, or a named user. Pick the emote in the selectedEmote dropdown in the Inspector: it lists your own emotes, uploaded or bought in the Avatar Editor.
Loading PlayerEmoteControl.cs...Spawns a server avatar clone by username (in one of their outfits by name, or the one they wear), toggles the emote picked in its selectedEmote dropdown, drops it as a ragdoll and stands it back up, slots it into a sitpoint, and destroys it through the cached clone reference.
Loading AvatarCloneControl.cs...Interactable that toggles scale for the clicking user, everyone, or a named target.
Loading PlayerScale.cs...Player ragdolls: a Drop button (with an optional push) and fall trigger zones turn the player into a ragdoll that falls onto whatever is below; a Stand button and recover timers get them up again. Ragdoll strength, gravity, drag, friction and bounce are set in the Inspector. Optional audio object slots.
Loading CharacterPhysicsModes.cs...Overrides user join and part callbacks for simple presence logging.
Loading UserJoinPart.cs...Runs a repeating coroutine that logs active users through ForEachUser.
Loading ForEachUser.cs...Posts global and grouped script events with structured name/value data.
Loading PostScriptEventsSender.cs...Listens to global and grouped script events and reads typed payload values.
Loading PostScriptEventsReceiver.cs...Listens for a custom slash command, reads the sender and arguments, and adds a [Script] chat response.
Loading ChatCommandRouter.cs...Registers enter and exit callbacks on the script object.
Loading TriggerSelf.cs...Registers enter and exit callbacks on a SceneObject trigger slot.
Loading TriggerSceneObjectSlot.cs...Plays a target audio source when a matching object enters a trigger, with name filtering and cooldown.
Loading NamedTriggerSoundOnce.cs...Resets players with TeleportPlayer and dynamic rigidbodies with transform client commands.
Loading ResetTrigger.cs...Plays an impact sound when objects bump into each other, higher the faster they meet. Put it on a moving physics object, or on a still object (a wall, a bell) that physics objects hit. Hits on objects whose name contains a word you choose can play a different sound. Uses RegisterCollision.
Loading CollisionVelocitySound.cs...Controls a legacy Animation with synced random frame, play, stop, and reset (back to frame 0) interactions. Up to two cart sounds (objects with an Audio Source inside the carts) are pitched by how fast their cart moves with SetAudioPitchByMotion: silent and low when the ride stands still, higher the faster it goes.
Loading Rollercoaster1.cs...Variant of the spritesheet button example with interaction hint text.
Loading Spritesheet.cs...Spawns an inventory item from a click target, caps total spawned objects, and despawns after a timeout.
Loading InventorySpawner.cs...A sandbox backpack: a Backpack button on every player's control bar opens a panel of your items (icon and name each); picking one spawns it in front of that player. Per-player limit, optional auto destroy, items removed when their player leaves. Meshes and prefabs work, including rigidbodies and scripts on them.
Loading Backpack.cs...Responds to user sit and stand events for a watched sitpoint.
Loading SitpointDetection.cs...Registers sitpoint input and applies movement forces to build a prototype vehicle controller.
Loading SitpointVehiclePrototype.cs...