API Reference

Defaults to the class name. Used in logs and script event sender info.

Optional description text for tools that surface script metadata.

The object that owns this script instance.

The transform of the owning object.

Named object slots assigned by the runtime when available.

True when running in the runtime world rather than editor bootstrap mode.

Defaults to true. Override to disable automatic transform state sync at startup.

Runtime switch for automatic transform state synchronization.

Serialized scene reference with ObjectId, Id, IsNull, Exists, gameObject, transform, GetComponent<T>, GetComponents<T>, child lookup, and parent lookup helpers.

Scene object reference with SitpointId resolution for sitpoint components and settings.

Server-spawned avatar clone reference with SourceUsername, DisplayName, CloneId, and helper methods for destroy, transform, emote, sitpoint, and stand commands.

Scene object reference with a light property that resolves a Light on the object or in children.

Inventory reference with InventoryId, Kind, Id, IsNull, IsEmpty, Exists, and normalization helpers.

A texture inventory item (a picture, such as a backpack icon). Kind is Texture. Inspector fields of this type take only textures.

An emote. In the scene editor, a public Emote field (or List<Emote>) shows a dropdown of the scene author's own emotes, uploaded or bought in the Avatar Editor; pick one there. Emotes are not typed in by id. Kind is Emote; EmoteId mirrors InventoryId; check IsNull before using it.

User snapshot with Username, ObjectName, ObjectId, and PlayerObject.

Sit or stand snapshot with Username, SitpointId, ObjectName, ObjectId, Sitpoint, and PlayerObject.

Interactable callback data with Username, ObjectName, ObjectId, ScriptNetworkId, InteractionType, and Target.

Chat command callback data with Username, UserId, player object fields, room ids, FullText, Command, ParameterText, and split Args.

Sitpoint input data with MoveX, MoveY, LookX, LookY, Jump, Sprint, Username, SitpointId, and Sitpoint.

Trigger callback data with EventType, IsPlayer, username, object name/id, trigger object id, OtherObject, and TriggerObject.

Collision callback data with IsPlayer, username, collided object name/id, collision object id, OtherObject, and CollisionObject.

A player's pick in the world's backpack: Username, UserId, Index, Item, DisplayName, PlayerPosition, Forward, Yaw, SpawnPosition(distance, height). See Backpack.

Enum values: Enter, Exit.

Enum values: Standing, Falling, Sleep.

Enum values: All, Core, LeftArm, RightArm, LeftLeg, RightLeg, Head.

Fields: Strength (0.12), GravityScale (1), Damping (0.02), Friction (0.6), Bounciness (0.08). Used with SetCharacterRagdollSettings.

Adds or replaces a named event value and returns the same data object.

Checks whether the data contains a key. Keys are case-insensitive.

Gets a raw value or default.

Gets and converts a value to the requested type when possible.

Gets a typed value and reports whether the key existed.

Convenience typed accessors for common event payload values.

Returns a shallow copy of the event data.

Builds event data from alternating name/value pairs.

Contains EventName, Group, FullName, SenderScriptName, SenderObjectId, SenderObject, and Data.

Called when the script starts. Call base.Start() before custom setup.

Called as the script is destroyed. Use for cleanup such as despawning objects or stopping state.

Called when the script is enabled.

Called when the script is disabled.

Generic event hook for runtime-dispatched events.

Control automatic transform state synchronization for this script.

Advanced control for when state is applied. The base uses the update phase.

Override to run logic when a user enters.

Override to run logic when a user leaves.

Override to run logic when a user sits.

Override to run logic when a user stands.

Returns a list of active user snapshots.

Returns the active usernames known by the runtime.

Runs the callback for each active user and logs callback errors.

Builds ScriptEventData from alternating name and value arguments.

Alias for CreateScriptEventData.

Registers a callback with full sender and payload details.

Registers a callback that receives only the payload data.

Stops this script's event subscriptions. With no name, removes all subscriptions owned by this script.

Posts an event with empty data.

Posts an event with structured data.

Posts an event from alternating name and value arguments.

Shows a simple dialog with optional target, icon, and button set.

Shows an icon dialog with an OK button.

Shows a dialog with explicit icon and button configuration.

Shows a dialog and invokes the callback with ModalDialogResult.

Shows an OK dialog and invokes the callback.

None, Info, Warning, Error, Success.

OK, OKCancel, YesNo, YesNoCancel, Custom.

None, OK, Cancel, Yes, No, Custom1, Custom2, Custom3.

Starts a coroutine using the script runtime runner.

Waits inside a coroutine. For example, yield return new WaitForSeconds(0.5f); waits half a second.

Stops a coroutine started through the runtime runner.

Stops all coroutines on the runner.

Adds the offset to this script object's world position.

Rotates this script object in world space.

Rotates this script object around a world-space axis.

Sets this script object's world position, world rotation, or local scale.

Reads this script object's world position, world euler rotation, or local scale.

Sets the emission level. 0 is off; values like 1 to 3 are useful for visible glow.

Sets the emitted color. Use a bright color while lit and Color.black when resetting.

Leave this off for normal SV Standard Lit glow through the base texture. Turn it on only when the material has a dedicated emission mask map.

Sets the target material frame.

Sets animation, frame advance interval, and looping.

Applies any combination of frame, playback, loop, and map-affecting settings. Commands are persistent for late-joining clients.

The model's animation. foreach (AnimationState s in anim) lists the takes with s.name and s.length (known once a player has loaded the scene).

Plays a take (empty = the default take). Playing the take that is already set continues from its current time; another take starts at 0.

Stops (back to the rest pose), or jumps back to 0.

Speed (0 freezes, negative plays backwards), jump to a time, and repeat mode: WrapMode.Loop, PingPong, Once (stops at the end), ClampForever (holds the last frame). anim.wrapMode sets it for the current take.

Plays the take whose name contains name (a bool of false stops it). Animator.Play("take"), Animator.speed and Animator.enabled (pause / resume) also work.

Still accepted; the state is always shared, so these only re-send it.

Spawns an inventory item for everyone and returns it as a SceneObject; players who join later see it too. The item can be a mesh, a prefab or a system object (light, sitpoint, water, particles, media screen…), whichever was dropped on the script's InventoryItem field. A mesh spawns solid (a collider shaped like it). A prefab (Hierarchy → Save to Inventory) spawns with everything saved in it: rigidbodies fall and can be grabbed and thrown (simulated on the server), and scripts on it run on the server, one copy per spawned prefab. Each player downloads an item's model, textures and scripts once per visit, however often it is spawned.

Removes a spawned object for everyone, with all its parts, their physics and the scripts that ran on them.

Queues a teleport command for one username.

Plays the emote chosen in an Emote field on one user (everyone in the instance sees it). Nothing happens, with a warning in the log, if no emote was chosen.

Plays the emote on every user in the instance.

Stops the emote one user, or everyone, is playing.

Sets uniform scale for one user.

Sets non-uniform scale for one user.

Sets player scale for everyone.

Sets all media screens to a URL.

Sets one media screen id, or * for all media screens.

Sets all media screens to a URL only for the named user. Stored database rows are ignored for that user until a live public media update arrives. The override is not restored after rejoining.

Sets one media screen, or * for all screens, only for the named user. A public SetMediaScreenUrl or /media update releases the matching private override.

Returns the current scene instance EventID for the server script. This is useful for logs and instance-specific script behavior.

Sets up the world's backpack for every player (and players who join later). Entry i of each list belongs together: items[i] is the item, icons[i] a texture for its picture and names[i] the name under it. An empty icon uses the item's own thumbnail; an empty name, the item's own name. onItemSelected runs on the server when a player picks an entry: your script decides what happens, usually SpawnInventoryItem in front of that player. One backpack per world: the latest call replaces it. Up to 200 entries.

Takes the backpack away: the button leaves every player's control bar and an open panel closes.

What a player picked: Username, UserId, Index (the entry), Item, DisplayName, PlayerPosition (their feet), Forward (the flat direction their avatar faces), Yaw (that direction in degrees, for a spawn rotation of new Vector3(0, Yaw, 0)) and PlayerObject.

A point distance metres in front of the player and height metres above their feet.

Drag items from the Inventory panel onto the field. InventoryItem fields take things that can be spawned (prefabs, meshes and system objects); TextureItem fields take textures; other kinds are refused. In a list, drop on an entry to replace it or on the box at the end to add one. Lists are numbered from #0 so entries of different lists line up. List<string> fields get one text box per entry.

Spawns a clone of the named user's avatar at a world position and returns an AvatarClone reference.

Spawns a clone with a world position and rotation.

Spawns a clone with an explicit rotation and scale. The clone wears the user's outfit named outfitName (the name they gave it in the Avatar Editor; capitals do not matter), or the outfit they are wearing when outfitName is blank or they have no outfit by that name. The clone's OutfitName keeps the name asked for.

Destroys a spawned clone. Clients remove it when the server stops sending clone packets.

Moves a clone to a world position.

Sets clone world rotation in Euler angles.

Sets clone scale.

Sets clone position, rotation, and scale in one command.

Makes the clone play the emote chosen in an Emote field. The resulting bones are serialized to clients like player bones.

Stops the clone's forced emote.

Slots the clone into a slotted Sitpoint.

Removes the clone from its current sitpoint.

Same as DestroyAvatarClone(clone).

Convenience methods for controlling the cached clone reference.

Convenience methods for forcing or stopping server-side clone emotes.

Turns the clone into a ragdoll (it falls onto whatever is below, like a player) and gets it back up where the body lies. Also SetAvatarCloneRagdoll(clone, true / false). Sitting, moving or destroying the clone ends the ragdoll.

Hits the clone (it becomes a ragdoll if it is not one yet): power metres per second in direction. Also ApplyAvatarCloneImpact(clone, …).

Convenience methods for sitpoint slotting.

Falling: ragdoll with the current ragdoll settings (use it for fall trigger zones). Sleep: a completely limp ragdoll. Standing: get up, blending back to normal animation over transitionSeconds. Set autoStandAfterSeconds above 0 to get up automatically.

Gets the player up from a ragdoll: they stand where the body lies, and the pose blends back to normal over transitionSeconds (0 = at once).

How that player's ragdoll behaves from now on (also while already ragdolled): Strength (muscles: 0 = limp, 1 = stiff as a statue; about 0.1–0.2 looks like a person falling), GravityScale (1 = normal), Damping (air drag, 0–0.95), Friction (0 = slides, 1 = stops where it lands), Bounciness (0–1).

Hits the player: power is the speed (metres per second) added in direction, spread over durationSeconds, to the body part (or the whole body). With fall = true the player becomes a ragdoll (or is pushed further if already one); with fall = false a standing player is only pushed. direction = Vector3.zero, power = 0, fall = true simply collapses the player.

Listens for every non-system slash command that was not handled by the game client command list.

Listens for one custom slash command such as /roll. The leading slash is optional. Built-in commands (/yt, /media, /help, /alert, /kick, /ban and the other admin and recording commands) are handled by the viewer and cannot be registered: the script log says so and the command is skipped.

Removes this script's chat command listener for one command, or all chat command listeners when omitted.

Inserts a room chat history entry from the fake username [Script].

Makes the script object interactable and calls the callback when activated.

Makes a target object interactable.

Registers trigger callbacks on the script object.

Registers trigger callbacks on a target object.

Registers a server-side collision callback on the script object. The callback receives the collided object's ObjectName and ObjectId.

Registers a server-side collision callback on a target object or its child colliders.

Registers a callback for input from the sitpoint associated with this script's network id.

Queues a raw client command for this script object's network id.

Queues a raw client command for a target object id.

Writes a normal log message prefixed with the script name.

Writes a warning prefixed with the script name.

Writes an error prefixed with the script name.