Skip to content

Commit 6f901e3

Browse files
authored
Merge branch 'main' into ui-ux-design-patch1
2 parents bc95561 + ba7e31a commit 6f901e3

File tree

4 files changed

+72
-20
lines changed

4 files changed

+72
-20
lines changed

content/en-us/cloud/open-cloud/index.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,29 @@ description: In addition to using Engine and Studio tools to create experiences
55

66
With Open Cloud, you can access Roblox resources through standard REST APIs, which lets you build everything from command line automation tools to complex web apps. The Open Cloud APIs support HTTPS and let you update experiences, restart servers, work with your data stores and memory stores, manage user restrictions, list inventory items, and much, much more.
77

8-
For the full list of available operations, see the Open Cloud API reference.
9-
108
<a href="../reference/index.md">
119
<Button variant="contained">Open Cloud API Reference</Button>
1210
</a>
1311

12+
## About the APIs
13+
14+
Roblox has four categories of HTTP REST API:
15+
16+
- [Open Cloud v2](../reference/index.md)
17+
- [Open Cloud v1](../reference/index.md)
18+
- [Legacy with API key and/or OAuth 2.0 authentication](../legacy.md)
19+
- [Legacy with cookie authentication](../legacy.md)
20+
21+
Whenever possible, use the Open Cloud v2 API. This API has the strongest stability guarantees and regularly adds new resources. The Open Cloud v1 API also has strong stability guarantees, but a more limited set of resources.
22+
23+
The legacy APIs, no matter which types of authentication they support, can incorporate breaking changes without notice and have minimal stability guarantees. They are not part of the Open Cloud v1 or v2 APIs, and we don't recommend them for production applications.
24+
1425
## Getting Started with Open Cloud
1526

16-
1. See the authentication documentation for how to use [API keys](api-keys.md) or [OAuth 2.0](oauth2-overview.md).
27+
1. Set up authentication for your application.
28+
29+
See the documentation for how to use [API keys](api-keys.md) or [OAuth 2.0](oauth2-overview.md). API keys are the easiest way to get started.
30+
1731
1. Use a tool like [Postman](https://www.postman.com) or the [OAuth 2.0 sample app](oauth2-sample.md) to test API calls.
1832
1. Review the [resource guides](experience-notifications.md) for end-to-end walkthroughs of using certain APIs.
19-
1. See the Open Cloud [reference documentation](../reference/index.md) for the full list of resources, [common API patterns](../reference/patterns.md), and [types](../reference/types.md).
33+
1. See the Open Cloud [reference documentation](../reference/index.md) for the full list of v1 and v2 resources, [common API patterns](../reference/patterns.md), and [types](../reference/types.md).

content/en-us/projects/assets/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,18 @@ if success then
260260
end
261261
```
262262

263+
### rbxgameasset
264+
265+
`rbxgameasset` points to an asset uploaded through the [Asset Manager](../../projects/assets/manager.md). It allows access to assets by a user‑friendly name instead of ID, so if you upload an image named `Potion.png`, you can reference it as:
266+
267+
<span><Chip label='rbxgameasset://Images/Potion' color='primary' size='large' /></span><br />
268+
269+
In the above example, `Images` is the category/folder that appears in the [Asset Manager](../../projects/assets/manager.md) and `Potion` is the asset name, minus its extension.
270+
271+
<Alert severity="warning">
272+
`rbxgameasset` only works for the current game. If you paste a parent object that utilizes the asset into another game, the asset will not load (or will load a different asset if you've uploaded one with the same name to that other game). If you need an asset to work across multiple games, use `rbxassetid` instead of `rbxgameasset`.
273+
</Alert>
274+
263275
### rbxhttp
264276

265277
`rbxhttp` is shorthand for `Class.ContentProvider.BaseUrl`, for example:

content/en-us/reference/engine/classes/AtmosphereSensor.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ category:
44
memory_category: Instances
55
summary: |
66
A `Class.SensorBase` that outputs data about the
7-
`Class.AtmosphereSensor.AirDenstiy|AirDenstiy` and
7+
`Class.AtmosphereSensor.AirDensity|AirDensity` and
88
`Class.AtmosphereSensor.RelativeWindVelocity|RelativeWindVelocity` at the
99
sensor's position.
1010
description: |
1111
A `Class.SensorBase` that outputs data about the
12-
`Class.AtmosphereSensor.AirDenstiy|AirDenstiy` and
12+
`Class.AtmosphereSensor.AirDensity|AirDensity` and
1313
`Class.AtmosphereSensor.RelativeWindVelocity|RelativeWindVelocity` at the
1414
sensor's position.
1515
code_samples: []

content/en-us/reference/engine/classes/FluidForceSensor.yaml

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,15 @@ name: FluidForceSensor
22
type: class
33
category:
44
memory_category: Instances
5-
summary: ''
6-
description: ''
5+
summary: |
6+
A `Class.SensorBase` that outputs `Class.FluidForceSensor.Force|Force`, `Class.FluidForceSensor.Torque|Torque` and `Class.FluidForceSensor.CenterOfPressure|CenterOfPressure`.
7+
description: |
8+
`FluidForceSensor` is a `Class.SensorBase` which outputs the results of fluid
9+
force simulation from the last physics frame for the part it is attached to.
10+
The sensor outputs the `Class.FluidForceSensor.Force|Force`,
11+
`Class.FluidForceSensor.Torque|Torque` and
12+
`Class.FluidForceSensor.CenterOfPressure|CenterOfPressure` which were computed
13+
by the fluid force simulation on the last physics frame.
714
code_samples: []
815
inherits:
916
- SensorBase
@@ -12,8 +19,12 @@ tags:
1219
deprecation_message: ''
1320
properties:
1421
- name: FluidForceSensor.CenterOfPressure
15-
summary: ''
16-
description: ''
22+
summary: |
23+
Assembly center of pressure offset from its center of mass in world
24+
coordinates.
25+
description: |
26+
Assembly center of pressure offset from its center of mass in world
27+
coordinates.
1728
code_samples: []
1829
type: Vector3
1930
tags:
@@ -31,8 +42,10 @@ properties:
3142
capabilities: []
3243
writeCapabilities: []
3344
- name: FluidForceSensor.Force
34-
summary: ''
35-
description: ''
45+
summary: |
46+
Assembly fluid force in world coordinates.
47+
description: |
48+
Assembly fluid force in world coordinates.
3649
code_samples: []
3750
type: Vector3
3851
tags:
@@ -50,8 +63,10 @@ properties:
5063
capabilities: []
5164
writeCapabilities: []
5265
- name: FluidForceSensor.Torque
53-
summary: ''
54-
description: ''
66+
summary: |
67+
Assembly fluid torque in world coordinates.
68+
description: |
69+
Assembly fluid torque in world coordinates.
5570
code_samples: []
5671
type: Vector3
5772
tags:
@@ -70,25 +85,36 @@ properties:
7085
writeCapabilities: []
7186
methods:
7287
- name: FluidForceSensor:EvaluateAsync
73-
summary: ''
74-
description: ''
88+
summary: |
89+
Asynchronously computes force, torque, and center of pressure for the
90+
parent part of a sensor given provided inputs.
91+
description: |
92+
Asynchronously computes force, torque, and center of pressure for the
93+
parent part of a sensor given provided inputs.
7594
code_samples: []
7695
parameters:
7796
- name: linearVelocity
7897
type: Vector3
7998
default:
80-
summary: ''
99+
summary: |
100+
Linear velocity in world coordinates.
81101
- name: angularVelocity
82102
type: Vector3
83103
default:
84-
summary: ''
104+
summary: |
105+
Angular velocity in world coordinates.
85106
- name: cframe
86107
type: CFrame
87108
default:
88-
summary: ''
109+
summary: |
110+
`Datatype.CFrame` to be used for evaluation.
89111
returns:
90112
- type: Tuple
91-
summary: ''
113+
summary: |
114+
Tuple of `Class.FluidForceSensor.Force|Force`,
115+
`Class.FluidForceSensor.Torque|Torque` and
116+
`Class.FluidForceSensor.CenterOfPressure|CenterOfPressure` calculated
117+
given the input parameters.
92118
tags:
93119
- Yields
94120
deprecation_message: ''

0 commit comments

Comments
 (0)