math.abs

math.acos

math.asin

Returns the arc tangent of x (in radians).


math.atan

Returns the arc tangent of y/x (in radians), but uses the signs of both
parameters to find the quadrant of the result. It also handles correctly
the case of x being zero.


math.atan2

Returns the arc tangent of y/x (in radians) while using the signs of both
parameters to find the quadrant of the result.


Returns the smallest integer larger than or equal to x.


math.ceil

Returns a number between min and max, inclusive.


math.clamp

Returns the cosine of x (assumed to be in radians).


math.cos

math.cosh

Returns the angle x (given in radians) in degrees.


math.deg

math.exp

Returns the largest integer smaller than or equal to x.


math.floor

Returns the remainder of the division of x by y that rounds the quotient
towards zero.


math.fmod

Returns m and e such that x = m\*2^e, e is an integer and the absolute
value of m is in the range [0.5, 1) (or zero when x is zero).


math.frexp

Returns x\*2^e (e should be an integer).


math.ldexp

Returns the logarithm of x using the given base, or the mathematical
constant e if no base is provided (natural logarithm).


math.log

base

The base of the logarithm, the constant e by default.


Returns the logarithm of x using the given base.


math.log10

Returns the maximum value among the numbers passed to the function.


math.max

Returns the minimum value among the numbers passed to the function.


math.min

Returns two numbers, the integral part of x and the fractional part of x.


math.modf

Returns a perlin noise value. The returned value is most often between the
range [-1, 1].

The returned value is sometimes will be outside of the range [-1,1], so if
the interval is critical to you, you should use `math.clamp(noise, -1, 1)`
on the output.

If you leave arguments out, they will be interpreted as zero, so
`math.noise(1.158)` is equivalent to `math.noise(1.158, 0, 0)` and
`math.noise(1.158, 5.723)` is equivalent to `math.noise(1.158, 5.723, 0)`.

The function uses a perlin noise algorithm to assign fixed values to
coordinates. For example, `math.noise(1.158, 5.723)` will always return
`0.48397532105446` and `math.noise(1.158, 6)` will always return
`0.15315161645412`.

If x, y and z are all integers, the return value will be 0. For fractional
values of x, y and z, the return value will gradually fluctuate between
-0.5 and 0.5. For coordinates that are close to each other, the return
values will also be close to each other.


math.noise

Returns x^y. (You can also use the expression x^y to compute this value.)


math.pow

Returns the angle x (given in degrees) in radians.


math.rad

An interface to the simple pseudo-random generator function rand provided
by ANSI C. (No guarantees can be given for its statistical properties.)
When called without arguments, returns a uniform pseudo-random real number
in the range [0,1). When called with an integer number m, math.random
returns a uniform pseudo-random integer in the range [1, m]. When called
with two integer numbers m and n, math.random returns a uniform
pseudo-random integer in the range [m, n].


math.random

Returns a random number within the range provided.


Sets x as the seed for the pseudo-random generator: equal seeds produce
equal sequences of numbers.


math.randomseed

Sets x as the seed for the pseudo-random generator.


Returns the integer with the smallest difference between it and the given
number. For example, the value 5.8 returns 6.

For values like 0.5 that are equidistant to two integers, the value with
the greater difference between it and zero is chosen. In other words, the
function **rounds away from zero**: 0.5 rounds to 1; -0.5 rounds to -1.


math.round

Returns the integer with the smallest difference between it and the given
number.


Returns -1 if x < 0, 0 if x == 0, or 1 if x > 0.


math.sign

Returns the sine of x (assumed to be in radians).


math.sin

math.sinh

Returns the square root of x. (You can also use the expression x^0.5 to
compute this value.)


math.sqrt

Returns the tangent of x (assumed to be in radians).


math.tan

math.tanh

math

math.huge

math.pi

Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Avatar

Cloud

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

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.

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 allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

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.

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

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

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.

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}

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

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 object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts 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 read only. Attempting to write to this member 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}

title

Unable to add to inventory

The code sample {title} has been added to your Inventory.

Version {versionNumber} includes general performance improvements and bug fixes. Check our other release notes for status on specific improvements and bugs.

Please don't include private or personal information. Maximum {maxDescriptionLength} words.

Minimum {minDescriptionLength} words required in the description.

Release Notes for Roblox Studio Version {versionNumber}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.