Appearance

Experience ​

Properties ​

currentScene ​

  • Type: Scene
  • The current scene

environment ​

  • Type: Environment
  • Environment information (platform, OS version, locale)

sharedActivity ​

  • Type: SharedActivity
  • Shared activity state (SharePlay, WebSocket, or other shared session protocols)

Methods ​

getVariable() ​

javascript
getVariable(id: string): any

Get an experience-scoped variable

Example:

javascript
var count = experience.getVariable('visitCount');
var name = experience.getVariable('userName');

Parameters:

  • id (string) - Variable identifier

Returns: any

setVariable() ​

javascript
setVariable(id: string, value: any, options: any): void

Set an experience-scoped variable (persists across scene transitions)

Example:

javascript
experience.setVariable('visitCount', 3);
experience.setVariable('userName', 'Alice');
experience.setVariable('lastPosition', Vector3(0, 1, 0), { type: 'vector3' });

Parameters:

  • id (string) - Variable identifier
  • value (any) - Value to store (number, string, boolean, Vector3, Color, etc.)
  • options (any) - Optional type hint { type: "vector3" | "color" | ... }

Returns: void

transitionToScene() ​

javascript
transitionToScene(id: string): void

Transition to another scene

Example:

javascript
experience.transitionToScene('chapter-2');

Parameters:

  • id (string) - Scene identifier

Returns: void