Meta Developers

Learn

Documentation

Welcome creators!

Install and run the desktop editor

Create your first world tutorial

Create your first world tutorial part 2

Batting cage tutorial

Meta Horizon Worlds for Roblox creators

Get started with Desktop Editor

Introduction to the desktop editor

Primary Tools in the User Interface

Build and Preview Modes

Panels and Tabs in the Desktop Editor

Create a New World

Collaborator Management

Modifying Editable Entity Properties

Adding and Editing Scripts

View Modes for Debugging

Introduction to the Desktop Editor Asset Library

Public Asset Library

Creating, Importing, Viewing, and Spawning Assets

Removing, Restoring, and Permanently Erasing Assets

Creating, Editing, Removing, and Moving Assets to Folders

Asset Spawning Reference

Asset Export to FBX File

Replacing Legacy and Imported Assets

Asset Templates

Data as an Asset

Hierarchy window

Hierarchy Panel Overview

Selecting Objects in Desktop Editor

Renaming Objects

Filtering and Searching in the Hierarchy Window

Generative AI tools

Generative AI Overview

Generative AI Creation Code Tool

Generative AI Creation Audio Tool

Generative AI Asset Metadata Tool

Quests, leaderboards, and variable groups

Quests, leaderboards, and variable groups

Variable groups

Using Variable Groups

Viewing Variable Group Details

Adding a Variable Group you Own to a World

Removing a Variable Group From a World

Managing Persistent Variables Associated with a Variable Group

Quests Overview

Creating Quests/Leaderboard/Variable Groups

Viewing Quests/Leaderboard/Variable Groups

Editing Quests/Leaderboard/Variable Groups

Deleting Quests/Leaderboard/Variable Groups

Sorting and Searching Quests/Leaderboard/Variable Groups

Debugging Quests/Leaderboards/Variable Groups

Object Instantiation

Object Spawning and Despawning

Object Manipulation

Object Lock and Unlock

Object Grouping

Grid and Surface Snapping

Player Settings Modification

World Settings Modification

Help and reference

Desktop editor troubleshooting

Desktop Editor Creation Tools Keyboard Shortcuts

Video presentation of creating performant custom UIs in Meta Horizon Worlds

Create a custom UI panel

Custom UI panel configurations

UIComponent class

Build an interactive custom UI

Building dynamic custom UI

User-Defined Components for Custom UI

Player-Specific Custom UI

Local Mode Custom UI Scripts

Performance Metrics for Custom UI

Animations For Custom UI

Non-Interactive Custom UI Screen Overlay

Interactive Custom UI Screen Overlay

API Reference For Custom UI

Custom UI Dynamic List

Custom UI Controls

Scripted Avatar NPCs

Getting Started with Scripted Avatar NPCs

Create Scripted Avatar NPC

Edit Scripted Avatar NPC Appearance

API Overview for Scripted Avatar NPCs

Spawning for Scripted Avatar NPCs

Build Navigation for Scripted Avatar NPCs

Grabbing for Scripted Avatar NPCs

Getting started with NPC assets

Setting up NPCs with Navigation

Navigation mesh generation

Nav Mesh Agents

Tutorial worlds

Getting started with tutorial worlds

Tutorial Prerequisites

Tutorial Assumptions

Access Tutorial Worlds

Use Assets from Tutorials

Developer Tools for Tutorials

Test Your World

GitHub Repository for Tutorials

Intro to Desktop Editor and TypeScript

Module 1 - Intro to Desktop Editor and TypeScript

Module 2 - Intro to Scripting

Module 3 - Build Game Manager

Module 4 - Broadcast Events

Module 5 - Build Game Setup

Module 6 - Game Start and Collection

Module 7 - Collecting Gems and Keeping Score

Module 8 - Adding Polish

Camera API Examples tutorial

Module 1 - Setup

Module 2 - PlayerCamera Overview

Module 3 - PlayerCameraManager

Module 4 - Pan Camera

Module 5 - Fixed Camera and Spectator Mode

Module 6 - Fixed Camera and Cutscenes

Module 7 - Other Systems and Summary

Simple Shooting Mechanics tutorial

Module 1 - Setup

Module 2 - Projectile

Module 3 - Simple Gun

Module 4 - Laser Gun

Module 5 - Summary

Custom UI Examples tutorial

Station 0 - Setup

Station 1 - Text and Fonts

Station 2 - Image from Asset

Station 3 - Scrollable UI

Station 4 - Generic Yes/No Dialog

Station 5 - Light the Sphere Dialog

Station 6a - Column View

Station 6b - Combo View

Station 7 - Persistent Variables

Station 8 - JSON as Datasource for Custom UIs

Station 9 - Animation Effects

Station 10 - Timer and Build Info Overlays

Multiplayer Lobby tutorial

Module 1 - Setup

Module 2 - Provided Scripts

Module 3 - Handling players entering and exiting

Module 4 - Starting the Game

Module 5 - Entering the Match

Module 6 - Completing the Match and Returning Players

Developing for Web and Mobile Players tutorial

Module 1 - Setup

Module 2 - The HUD System

Module 3- The Puzzle Manager

Module 4 - Camera Manager

Module 5 - Player Manager

Module 6 - Room A: The Magic Wand

Module 7 - Room B: Secret Code

Module 7A: The Focused Interaction Manager

Module 7B - Use drag inputs to rotate objects

Module 7C - Use tap inputs to interact with a keypad

Module 8 - Room C: Target Practice

Module 9 - Summary

Spawning and Pooling in TypeScript tutorial

Module 1 - Setup

Module 2 - Implement Object Spawning

Module 3 - Implement Object Pooling

Module 4 - Spawn Controller

Module 5 - Summary

Scripted Avatar NPC tutorial

Module 1 - Setup

Module 2 - Overview of Scripted Avatar NPCs

Module 3 - NPC Manager

Module 4 - Adding Voice-Over

Module 5 - Quest Manager

Module 6 - Summary

Text as Asset tutorial

Module 1 - Setup

Module 2 - Using Text assets as in-game content

Module 3 - Using Text assets as metadata

Module 4 - Using Text assets for timed events

Horizon Traversal sample world

Module 1 - Setup

Module 2 - Overall Game Manager Systems

Module 3 - Player Movement Systems

Module 4 - Player HUD Systems

Module 5 - Player Out of Bounds Management Systems

Module 6 - Helper and Base Classes

Module 7 - Summary

Chop 'N Pop sample world

Module 1 - Setup

Module 2 - Design Patterns

Module 3 - Core System Scripts

Module 4 - Game Manager

Module 5 - Floating Text Manager

Module 6 - Player Manager

Module 7 - Weapon Systems - Axe

Module 8 - Weapon Systems - Handgun

Module 9 - Enemy Wave Manager

Module 10 - NPC System

Module 11 - Loot System

Chop 'n Pop analytics tutorial

Module 1 - Setup

Module 2 - Principles Of Analytics Events Implementation

Scripting using TypeScript

Get started with TypeScript

Using TypeScript in Meta Horizon Worlds

Adding an IDE to the desktop editor

TypeScript Tutorial

If VS Code can’t find a V2 module

Horizon TypeScript APIs

Modules and Global Functions

TypeScript Components, Properties, and Variables

The Debug Console

In World Examples

Object Type Persistent Variables

Persistent Variables

API references and examples

Horizon TypeScript V2 Changes

Entity Visibility

CodeBlock Achievements

Marking Instances as Opened or Closed

Example scripts library

Local scripting

Getting Started with Local Scripting

Maintaining Local State on Ownership Change

Ownership in Meta Horizon Worlds

Gameplay tags API

Introduction to Gameplay Tags

Modify Gameplay Tags on Entity and Get Entities with Tags

Introduction to Asset Spawning

Checking for Asset Spawn Events

Optimization Tips

World Streaming

Scripting Considerations

World Update Events

CodeBlock Events

Broadcast Events

Events Best Practices

Recommended Version Control Strategies

TypeScript Script Lifecycle

File-Backed Scripts

Legacy Script Storage

Importing Data with JSON

Upgrade World to TypeScript API v2.0.0

Custom model import

Creating custom models for Horizon Worlds

Creating a Custom Model

Guidance for Custom Models: Budgets and Model Specs

Materials Guidance and Reference for Custom Models

Multiple Materials per Mesh

Collider Visualization User Guide

Collider Ingestion User Guide

Static Light Gizmos User Guide

Getting started with Custom Model Import

3D Modeling Tool Resources

Connect '23 Video Series: Custom Model Worlds

Replacing Primitive Worlds with Custom Model Worlds

Use the Text gizmo

Use the Environment gizmo

Use the Spawn Point gizmo

Use the Trigger gizmo

Use the Door gizmo

Media Board Gizmo

World Promotion Gizmo

Use the Sound Recorder gizmo

Save, optimize, and publish

Publish your world using Desktop Editor

Intro to Meta Horizon Worlds Discovery

Meta Horizon Worlds Content Guidelines

Creator capacity limits

Permissions when you add a collaborator to your world

Duplicate a world

Add world details

Save and return to your drafts

Learn about Frame Budget Boost

Memory limits and performance metrics

Members-only worlds

What is a members-only world?

How to set up a members-only world in desktop editor

What is the Code of Conduct for Virtual Experiences (CCVE) and how does it apply to members-only worlds?

What does it mean to be responsible for governing my members-only world?

How should creators moderate their members-only worlds?

Set up a members-only world using VR tools

Creator governance responsibilities for members-only worlds in Meta Horizon Worlds

Members-only worlds governance best practices in Meta Horizon Worlds

Manage reports for members-only worlds in Meta Horizon Worlds

Safety and privacy

Community Moderation

How to report someone

Using music in audio recordings in Meta Horizon Worlds

Welcome to the Meta Horizon Creator Program

How to Become a Meta Horizon Creator Partner

Where to start with Meta Horizon Worlds

MHCP Skills Matrix

Monetization opportunities

Bonus Program Overview

Bonus Program Analytics

In-world purchase guide

In-world purchase price setting

In-World Test Purchase

Meta Horizon Worlds: Kudos Panel Instructions

Meta Horizon Creator Program FAQ

How to Attach a Media File from the Headset to the Ticket Submission Form?

World Ratings FAQs

MHCP Session: Level Design Q&A with Victor Riddel

Q&A Session: Gameplay Loops with Victor Riddel

MHCP Q&A Session: Typescript with Christopher Kairalla and Jonathan Lehman

MHCP Q&A Session: Game Design with Andy Sargeant

MHCP Q&A Session: Custom Model Import with Barrett Meeker

MHCP Q&A Session: World Optimization with Michael Isaza

MHCP Creator Panel with Emmanuel Rebollar (May 23, 2023)

Meta Horizon: Looking Ahead in 2023 featuring Jeff Lin (January 18, 2023)

Marketing Essentials for MHCP Part 1 with Shannon O’Flaherty and Candace Locklear

Marketing Essentials for MHCP Part 2 with Shannon O’Flaherty and Candace Locklear

MHCP Program Updates with William Chandler and Marlowe Shaeffer

MHCP Session: Meta Horizon Worlds on Web and Mobile and Creation Tooling Updates with Linda Chen and Andy Sargeant

Connect '23 Video Series: Game Design in Meta Horizon Worlds

Meta Horizon Creator Program Technical Support Best Practices (January 18, 2023)

Tools to Build Your Community and Brand

MHCP Session: Deep Dive: Meta Horizon Worlds with Andy Sargeant

MHCP Mentor Focus Session: Branding and IWP

World publishing guide

Mobile worlds crash course, part 1: Getting Started

Mobile worlds crash course, part 2: Viral game ideas

Mobile worlds crash course, part 3: Submitting Your Optimized World

MHCP Mentor Workshop Video: IWP Ready Assets & How to Make Them with SpaceGlitterUnicorn

Community guides

Community tutorials

Meta Horizon Worlds creator manual

How to Script a Retention and Interaction Dashboard with PigeonNo12

Meta Horizon CMI & TypeScript API 2.0: Import Images & Add Texture Animation

How to Script a Player Manager with Elastic_Plastic

How to Script a Player Manager Part Two with Elastic_Plastic

How to Script Fire with thejohnmclay

CodeBlocks to TypeScript

How to Script a Consent Box with VRPLUG

Part One: Understanding Asset Spawning with SeeingBlue

Part Two: Asset Spawning Application with SeeingBlue

Meta Horizon TypeScript API 2.0: JSON PPVs & Versioning

How to Script a Joystick with PigeonNo12

Introduction to Advanced Math Concepts with Elastic_Plastic

Debugging in Meta Horizon Worlds Using Print Codeblocks

Version Control Video Tutorial with PigeonNo12

Managing World Backups

In-World Purchase (IWP) in Codeblocks

Basic Hotkey Guide to the Blenderverse

Text Entry and Formatting Tutorial

Blender basics and UV unwrapping with SpaceGlitterUnicorn

The 5andw1ch Framework for Design

Typescript Conventions and Best Practices for Meta Horizon Worlds

3D Modeling 101

MHCP Mentor Workshop Video - What Makes a World Go Viral with Laex05

Custom UI API Introduction

Policy and legal

World Ratings Survey

Policy Update: Sharing Advanced Tools Educational Content

Holster Icon Menu

The holster icon menu is a menu of UI icons representing items attached to a player’s avatar. Players can use these icons to switch between and equip items. These icons show items that are grabbable entities attached to the player.

Note: The holster button to open the holster icon menu will appear if a player has more than one grabbable entity attached.

Attaching a grabbable entity to a player

For an item to appear in the holster icon menu when it is not equipped you must attach that grabbable entity to the player:

this.entity
  .as(hz.AttachableEntity)
  .attachToPlayer(player, AttachablePlayerAnchor.Torso);

You can combine attaching the entity with a primary input action API so the player can control the attachment process:

this.connectCodeBlockEvent(
  this.entity,
  CodeBlockEvents.OnIndexTriggerUp,
  (player: Player) => {
    this.entity
      .as(hz.AttachableEntity)
      .attachToPlayer(player, AttachablePlayerAnchor.Torso);
  },
);

You can configure how a grabbable entity will show up in the holster icon menu by setting the Holster Icon property in the entity properties panel:

Default value: If you don’t specify a value, the holster icon will show the default slot number.
Action icon value: The holster icon will show the selected action icon.
None: The entity will not be included in the holster icon menu.

To ensure an entity won’t appear in the holster icon menu, you can either:

Select None in the Holster Icon property on the grabbable entity.
Set the Who Can Grab? property of the grabbable entity to an empty array of Script assignees to make it impossible to grab.

Available Action Icons

The pool of available icons grows continually. The following table lists examples of the icons that you can select for controls on web and mobile.

Shoot	Reload	Jump	Unholster	Drop	Special	Grab
Interact	Throw	Ability	Rocket	Airstrike	Swing	Swap
Inspect	Open Door	Shield	Aim	Dual Wield	Sprint	Crouch
Eat	Drink	Speak	Purchase	Place	Heal

Learn

Programs

Meta Horizon Creator Program

My Creations

Privacy & Legal

Learn

Programs

Meta Horizon Creator Program

My Creations

Privacy & Legal

Learn

Programs

Meta Horizon Creator Program

My Creations

Privacy & Legal

© 2025 Meta