You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/cloud/open-cloud/index.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,29 @@ description: In addition to using Engine and Studio tools to create experiences
5
5
6
6
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.
7
7
8
-
For the full list of available operations, see the Open Cloud API reference.
9
-
10
8
<ahref="../reference/index.md">
11
9
<Buttonvariant="contained">Open Cloud API Reference</Button>
12
10
</a>
13
11
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
+
14
25
## Getting Started with Open Cloud
15
26
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
+
17
31
1. Use a tool like [Postman](https://www.postman.com) or the [OAuth 2.0 sample app](oauth2-sample.md) to test API calls.
18
32
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).
Copy file name to clipboardExpand all lines: content/en-us/reference/engine/classes/FluidForceSensor.yaml
+40-14Lines changed: 40 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,15 @@ name: FluidForceSensor
2
2
type: class
3
3
category:
4
4
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.
7
14
code_samples: []
8
15
inherits:
9
16
- SensorBase
@@ -12,8 +19,12 @@ tags:
12
19
deprecation_message: ''
13
20
properties:
14
21
- 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.
17
28
code_samples: []
18
29
type: Vector3
19
30
tags:
@@ -31,8 +42,10 @@ properties:
31
42
capabilities: []
32
43
writeCapabilities: []
33
44
- 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.
36
49
code_samples: []
37
50
type: Vector3
38
51
tags:
@@ -50,8 +63,10 @@ properties:
50
63
capabilities: []
51
64
writeCapabilities: []
52
65
- 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.
55
70
code_samples: []
56
71
type: Vector3
57
72
tags:
@@ -70,25 +85,36 @@ properties:
70
85
writeCapabilities: []
71
86
methods:
72
87
- 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
0 commit comments