FixedSize

Renders with a fixed size set using `Class.SurfaceGui.CanvasSize`.


PixelsPerStud

Renders with a variable size based on `Class.SurfaceGui.PixelsPerStud` and
the SurfaceGui's size in studs.


SurfaceGuiSizingMode

/reference/engine/enums/SurfaceGuiSizingMode.yaml

Used by `Class.SurfaceGui.SizingMode` to control the sizing behavior of a
`Class.SurfaceGui`.


An object that runs connected functions upon a specific occurrence.

Data Type

RBXScriptSignal

Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Avatar

Legacy

Cloud

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

This field may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

This field may be set on responses, but will be ignored in requests.

The following API key permissions are required to call this endpoint. For more
information on generating proper keys, see [Managing API Keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows viewing information about your groups.

This allows you to manage group join requests for your account.

This allows viewing information about your inventory.

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you follow.

Grants access to follow and unfollow experiences on your behalf.

Grants permission to read group information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.

Default Value: {defaultValueStart}{defaultValueEnd}

An array is an ordered list of values. Arrays are useful for storing collections of data.

A set of key-value pairs, where the keys can be any number, string, or object.

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

{nameStart}name{nameEnd} is no longer supported or maintained by Roblox.

This math operation is no longer supported or maintained by Roblox.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This member is accessible from OpenCloud Luau execution tasks.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible through the command bar and plugins. Attempting to access this member from scripts causes an error.

This member is read only. Attempting to write to this member causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

Learn how to create successful content on Roblox with comprehensive guides, code samples, reference, and tutorials.


{pageTitle} | {SiteName}

2D Paths

3D Art Overview

3D Drag Detectors

3D Importer

3D Workspace

9-Slice

9-Slice Design

AI Data Sharing

API Keys

About GDPR and CCPA

Accessibility Guidelines

Accessing Localization Settings

Accessory Fitting Tool

Account Information

Account Settings

Account Verification

Acquisition

Activity History

Activity Lessons

Ad Configuration

Adaptive Timestepping

Add New Models

Adding Animations

Adding Rounds

Adding Scripts

Adding Wings

Adding the Second Pose

Add to the Garage

Ads Manager

Advanced

Adventure Game Project

Adventure Game Pt. 1

Adventure Game Pt. 2

Adventure Game Pt. 3

Advertising

Advertising on Roblox

AlignOrientation

AlignPosition

Align Tool

All Cloud API

All Programs

Analytics

Analytics Dashboard

Analytics Essentials

AngularVelocity

Animate in Roblox

Animating Characters

Animating Heads

Animating Parts

Animation

Animation Capture

Animation Editor

Animation Events

Animations and Feedback

Appearance

Appearance Modifiers

Apply Polished Assets

Applying Surface Images

Architecture

Armature Setup

Assemble an Asset Library

Assemblies

Assembling Modular Environments

Asset Delivery v1

Asset Delivery v2

Asset Manager

Asset Privacy

Assets

Assistant

Assistant for Documentation

Atmosphere

Audience

Audience Engagement

Audio

Audio Assets

Authentication v1

Authentication v2

Authentication v3

Automatic Sizing

Automatic Skinning

Automatic Translations

Avatar Context Menu

Avatar Creation

Avatar Editor

Avatar Inspect Menu

Avatar Items

Avatar Preview

Avatar Setup

Avatar Tab

Avatar Tutorials

Avatar v1

Avatar v2

Avatar v3

Back to Avatar Tutorials

Back to Guides

Back to Tutorials

Badges

Balancing Virtual Economies

BallSocket

Basic Gameplay

Basic Particle Effects

Battle Royale

Battle Royale Project

Beams

Become an Artist

Beginner Content

Being a Digital Citizen

Best Practices

Beta Features

Beta Testing Experiences

Beyond The Dark

Bindable

Blender Configurations

Blender Setup

Blender and Maya Export Settings

Bodies

Bodies - From Templates

Body Scale

Booleans

Box Modeling

Brand Developer Directory

Bubble Chat

Build It, Play It Series

Build One Half

Building Ferris Wheels

Building Hinged Doors

Building Studio Widgets

Building System

Building Unique 3D Objects

Building Your Business

Building a Ferris Wheel

Building a Hinged Door

Buildings and Props

Build the Roads

Built-In

Buttons

Buying Upgrades

CFrames

Caging

Caging Character Head

Caging Setup

Calisthenics Tool

Camera

Catalog v1

Catalog v2

Challenge Checkpoint 1

Challenge Checkpoint 2

Challenge Checkpoint 3

Change the Animation

Change the Script

Character Controllers

Characters

Chat

Chat with Voice

Choose an Art Style

Classes

Classic Clothing

Classroom Best Practices

Classroom Facilitation

Cleanup

Cleanup and Reset

Client-Server Runtime

Client Settings v1

Client Settings v2

Clothing

Cloud Services

Clouds

Coding Abstraction

Coding Algorithms

Coding Fundamentals

Coding a Function

Coding a Question

Coding the Game Loop

Coding the Leaderboard

Coding the Story

Collaboration

Collaboration Best Practices

Collecting Items

Collisions

Colors and Textures

Combining Head Geometry

Comments

Community

Community Feedback Program

Complete the City

Completing the Challenge

Complying with Advertising Standards

Conditionals

Connect the Beam

Console Guidelines

Construct Your World

Constructing the House

Contacts

Containers

Content Updates

Contextual Purchases

Control Structures

Controlling the User's Camera

Converting to Accessory

Core

Core Curriculum

Core Loops

Core Scripts

Create Basic Visual Effects

Create Player Hazards

Create Your First Experience

Create a Coin Collection Mechanic

Create a Project

Create an Environment with Terrain

Create and Destroy

Create the First Pose

Creating Accessories from an Existing Model

Creating Animations

Creating Basic Heads

Creating Bundled Installers

Creating Character Animations

Creating Elevators

Creating Engaging Experiences

Creating Explosions

Creating Face Accessories

Creating Flickering Lights

Creating Health Pickups

Creating Interactive Buttons

Creating Laser Beams

Creating Moving Objects

Creating Neon Signs

Creating Part Interfaces

Creating Player Tools

Creating Private Servers

Creating Proximity Prompts

Creating Score Bars

Creating Seams and Unwrapping

Creating Spinning Objects

Creating Teams

Creating Volcanoes

Creating Waterfalls

Creating a GUI

Creating a Health Pickup

Creating a Score Bar

Creating a Script

Creating a Sparkler

Creating a Texture Map

Creating an Animation

Creating and Publishing

Creating the Map

Creating with Module Scripts

Creation Overview

Creator Affiliate Pilot Program

Creator Events

Creator Fund

Creator Spotlights

Creator Store

Cross-Platform Design

Cross-Server Messaging

Current Release

Curve Editor

Custom

Custom Events

Custom Fields

Custom Particle Effects

Custom Thumbnails

Custom Translations

Customization

Customize Global Lighting

Customize and Share

Customizing In-Experience Text Chat

Cylindrical

DMCA Guidelines

Dashboards

Data Model

Data Stores

Data Structures

Data Types

Deadly Lava

Debugging

Deep Linking

Designing Dark Soundscapes

Designing Educational Experiences

Designing For Roblox

Designing Poses

Designing Your Speeder

Designing a Map

Designing for Performance

Design the World

Detecting Hits

Detecting User Input

Develop Polished Assets

Developer Awards

Developer Console

Developer Products

Developing a Moving World

Develop v1

Develop v2

Dictionaries and Arrays

Digital Citizenship

Disabling Default UI

Disabling Default UI Elements

Discovery

Drag Detectors

Duplicate and Design

Dynamic Effects

Earning on Roblox

Economy

Economy Creator Stats

Economy Events

Educator Onboarding

Effects

Else/If Practice - Giving Points

Embedding and Exporting Textures

Emote Bar

Emotes

Ending Matches

Engagement

Engagement-Based Payouts

Engagement Payouts

Engine API Reference

Engine Instances

Enhancing Indoor Environments

Enhancing Outdoor Environments

Enhancing Outdoor Environments with Future Lighting

Enums

Environment

Environmental Art

Environments

Error Codes and Limits

Error Report

Errors

Event Organizers

Event Sequencer

Event Types

Events

Events Platform

Experience Events

Experience Guidelines

Experience Icons

Experience Notifications

Experience Thumbnails

Experienced Content

Experiences

Explorer Window

Export Settings

Exporting

Exporting Animations

Exporting Animations from Maya

Exporting Character Model

Exporting FBX

Exporting FBX from Blender

Exporting from Blender

External Catalog Queries

External Tools

Extra Head Objects

FACS Poses Reference

Fading Trap

Featured Content

Features

Final Checks

Finishing Projects

Finishing and Add More

Finishing the Project

Finish the Blast

Finish the Challenge

Fitting and Conversion

Followings v1

Followings v2

Foundational Gameplay Systems

Frames

Frequently Asked Questions

Friend Invite Reward System

Friends

Friends Locator

Functions

Functions and Events

Funnel Events

Galactic Speedway

Game Fund

Game Internationalization v1

Game Internationalization v2

Game Join

Game Settings

Gamepad

Gameplay Scripting

Games v1

Games v2

Get Off the Ground

Get Started

Getting Featured on Roblox Owned Channels

Getting Started

Getting Started for Developers

Global Lighting

Global Wind

Globals

Glowing Lights with For Loops

Go Beyond the Challenge

Going for a Race

Go to Educator Onboarding

Greybox Your Environment

Greybox a Playable Area

Grids and Tables

Grouping the Parts

Groups

Groups v1

Groups v2

Growing Your Audience

Guidelines

Handling Requests

Hash Map

Heads

Highlighting

Hinge

Hit Detection with Lasers

Home Tab

Icons and Thumbnails

Identifying Issues

If/then Practice - Power ups

If/then Practice - Traps

Immersive Ads

Immersive Narrative

Implement Designs in Studio

Implementation

Implementing Blaster Behavior

Implementing Player Data and Purchasing Systems

Importing PBR Textures

Importing into Studio

Improving Performance

In Blender

In-Experience Asset Creation

In-Experience Tools

In-Experience UI

In-Experience UI Containers

In-Game Sounds

In Studio

Input

Input and Camera

Inspire

Installation and Setup

Instance

Instance Attributes

Instance Streaming

Intellectual Property

Interactive

Interactive Buttons

Interfaces on Parts

Intermediate Gameplay

Introduction to Scripting

Intro to Arrays

Intro to Dictionaries

Intro to Digital Civility

Intro to Digital Safety

Intro to For Loops

Intro to Game Design and Coding

Intro to If Statements

Intro to Module Scripts

Intro to Roblox

Inventory

Inventory v1

Inventory v2

Inverse Kinematics

Invite Friends

Invite Friends to Play

Island Terrain

Island of Move

Item Configuration

Labels

Language Codes

Laser Traps with Beams

Layered Clothing

Layout Structures

Layout and Appearance

Layout and Design

Leaderboards

Learn & Explore Sort

Legacy Chat System

Libraries

Light Sources

Lighting

Lighting with Props

Lights and Polish

LineForce

LinearVelocity

List and Flex Layouts

List of Roblox Educators

LiveOps Essentials

LiveOps Planning

Loading Screens

Locale

Localization

Localization Tables

Localizing with Scripting

Looping Animations

Looping through Arrays

Loops

Luau

Luau Reference

Main Design Requirements

Make Final Touches

Making Changes to Arrays

Making Mesh Watertight

Making an Explosion

Managed Brand Integrations

Managing

Managing Data Stores

Managing Players

Mansion of Wonder

Manually Editing Localization Table

Marketing Materials

Marketplace Fees and Commissions

Marketplace Overview

Marketplace Policy

Material Generator

Materializing the World

Materials

Mechanical Constraints

Memory Stores

Memory Usage

Merch Booth

Meshes

Messaging

Metatables

Metrics

MicroProfiler

Migrating to In-Experience Text Chat

Minimap System

Mobile

Model Tab

Modeling

Modeling Specifications

Models

Moderation

Modes

Modifying Outer Cage

Monetization

Monetization Foundations

Monitoring

Monitoring Performance

Moods

Mouse and Keyboard

Mover Constraints

Moving the Body

Multi-Threading

Multiple Conditions with Else/If

Multiple Parameters and Arguments

NPC Kit

Name and Health Display

Native Code Generation

Nesting Loops

Network Ownership

Next Steps

NoCollision

Nominating for the Discover Page

Notable Translators Program

Notifications

Numbers

OAuth 2.0

Object Properties

Objects

Observability

On-Screen UI

On-Screen UI Containers

Onboarding

Onboarding Techniques

Opening the Template

Operators

Optimize Your Experience

Ordered Data Stores

Organizing Code

Output Window

PBR Material References

PBR Textures (Optional)

Packages

Page Layouts

Paid Access

Pairs and iPairs

Parameters Practice - Buttons

Parents and Children

Particle Emitters

Parts

Passes

Pathfinding

Patterns

Per-Partition Limits

Performance

Performance Optimization

Photo Booth

Physically-based Rendering (PBR)

Physics

Pickup System

Pivot Tools

Place Publishing

Plane

Planning for Educational Settings

Plant Reference Project

Platform Overview

Player Invite Prompts

Player Referral System

Player UI

Players

Playing Background Music

Playing Character Animations

Playing Positional Sounds

Playing on Roblox

Playtest the Map

Plugins Tab

Policies and Guidelines

Positioning and Sizing

Post-Processing Effects

Premium Features

Presence

Price Optimization

Prismatic

Private Messages

Private Servers

Products

Profile Card

Project Cleanup

Project Setup

Projects

Promotion

Prompt Guide and Examples

Properties Window

Properties and Attributes

Prototyping

Proximity Prompts

Publish

Publishing

Publishing Eyebrows and Eyelashes

Publishing to Marketplace

Quest Design

Queue

Queues

Quick Access Tools

R6 to R15 Adapter

Randomized Virtual Items Policy

Raycasting

Real-Time

Recent Releases

Record and Display Player Data

Reference Assets

Reference Files

Registration

Release Notes for 624

Release Notes for 625

Release Notes for 626

Release Notes for 627

Release Notes for 628

Release Notes for 629

Release Notes for 630

Release Notes for 631

Release Notes for 632

Remote

Removing Extra Bones

Repeating Code with while Loops

Retention

Returning Values From Tables

Reusing Code

Rich Text Markup

Rig Builder

Rigging

Rigging Humanoid Models

Rigging Simple Meshes

Rigging a Humanoid Model

Rigging a Humanoid Model (Blender)

Rigging a Simple Mesh (Blender)

Rigging and Caging an Existing Model

Rigging and Skinning

Rights Manager

Right to Erasure Requests

Rigid

Rigid Accessories

Roblox Blender Plugin

Roblox Connect Project

Roblox Developer 101

Roblox Developers Conference (RDC)

Roblox Innovation Awards

Roblox Research Panel

Roblox Studio

Roblox Studio Basics

Roblox Units

Roblox User Base

Roblox for AP CSP

Roblox for Unity Developers

Roblox for Unreal Developers

Rope

Running Classrooms

Running the Game

Sample App

Save and Publish

Save by Publishing

Saving Data

Scavenger Hunt

Scheduler

Scope

Scoring Points

Script Capabilities

Script Editor

Script Profiler

Script Tab

Script an Upgrade Button

Scripting

Scripting Avatar Animations

Scripts

Sculpting

Sculpting Detail

Sculpting Terrain

Search Ads

Season Pass Design

Security Tactics and Cheat Mitigation

Selfie Mode

Selling Items

Selling on the Creator Store

Selling your Accessory

Services

Setting Up Mesh

Setting Up Studio

Setting Up a Roblox Classroom

Setting Up a Team

Sharing Your Speeders

Size Modifiers and Constraints

Skinning Humanoid Models

Skinning Simple Meshes

Skinning a Humanoid Model

Skinning a Humanoid Model (Blender)

Skinning a Simple Mesh (Blender)

Skyboxes

Sleep System

Snap to Grid

Social Interactions

Solid Modeling

Sorted Map

Sound

Sound Design

Spatial Data

Spatial Voice

Spawn With Friends

Spawning and Respawning

Specifications

Sponsoring Experiences

Sponsoring Items

Spring

Stacks

Standard Data Stores

Start Coding

Story Games

Streaming

Streaming in Immersion

Strings

Studio

Studio Interface

Studio Setup

Studio Shortcuts

Studio Testing Modes

Subscription Design

Subscriptions

Supporting Systems

Surface Art

Tables

Tag Reference

Tag Table

Take Flight

Talent Hub Developer Safety

Task Scheduler

Teaching Remotely

Teams

Technical Overview

Technical Specifications

Teleporting

Template Files

Templates

Terrain

Terrain Editor

Terrain Tools

Test Tab

Test and Play

Test and Save

Testing

Testing Characters

Testing Poses

Test the Game

Test the Speeder

Text Chat

Text Filtering

Text Input

Text Input Fields

Texture Generator

Texture Painting

Texture Painting Setup

Texture Specifications

Textures and Decals

Texturing

Texturing Eyes

Texturing Face

The Mystery of Duvall Drive

The Storm

Third-Party Analytics Services

Third-Party Software

Thumbnails

Thumbnails Resizer

Timed Bridge For Loops

Timers and Events

Tips and Settings

Today's Picks on Home

Today's Picks on Marketplace

Toolbox

Tools

Torque

TorsionSpring

Trades

Trails

Translating Dynamic Content

Translating Experience Page Information

Translating In-Experience Content

Translation Roles

Trimming Clothing Shape

Tuples

Two Step Verification

Type Checking

Type Coercion

Types

Types and Locations

UI Animation

UI Animation/Tweens

UI Drag Detectors

UI Objects

UI and UX

Unit Lessons

Universal

Upload and Publishing

Uploading and Publishing

Uploading your Asset

User Advertisements

User Interface

User Interface Design

User Interfaces

User Inventories

Userdata

Users

Using Animations

Using Heads in Studio

Using Information with Parameters

Using MicroProfiler

Using Particles for Actions

Using Particles for Explosions

Using Studio's 3D Importer

Using Textures

Using the Accessory Fitting Tool

VR Guidelines

Validation Tool

Variables

Variables & Objects

VectorForce

Verifying Attachments

Video Assets

Video Frames

View Tab

Voice Chat

Walkthrough

Weapons Kit

Webhook Notifications

Weld

Wireframe Your Layouts

Working With Translators

Working in Teams

Writing the Story

Xbox Guidelines