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/reference/risk-levels.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ The "try it out" feature uses four risk levels, which control the warnings and r
41
41
<td>✅</td>
42
42
<td>Yes (per endpoint, per session)</td>
43
43
<td>Yes</td>
44
-
<td>No</td>
44
+
<td>Yes (after accepting second warning dialog)</td>
45
45
</tr>
46
46
<tr>
47
47
<td>Critical</td>
@@ -60,6 +60,6 @@ The "try it out" feature uses four risk levels, which control the warnings and r
60
60
- They display a confirmation dialog before you send a request. This dialog appears once per endpoint per browser session.
61
61
- They show a warning banner to remind you of the risk level.
62
62
63
-
-**High risk** endpoints can modify or delete private information in ways that may be difficult or impossible to reverse. This category includes most DELETE operations and other potentially destructive actions. In addition to the confirmation dialog and warning banner from medium risk endpoints, cookie authentication is not supported for these endpoints.
63
+
-**High risk** endpoints can modify or delete private information in ways that may be difficult or impossible to reverse. This category includes most DELETE operations and other potentially destructive actions. In addition to the confirmation dialog and warning banner from medium risk endpoints, a second confirmation dialog is required to send the first request (enforced only per session, not per endpoint).
64
64
65
65
-**Critical risk** endpoints access or modify highly sensitive data that could compromise account security or privacy. "Try it out" is disabled for these endpoints.
Copy file name to clipboardExpand all lines: content/en-us/reference/engine/classes/HandleAdornment.yaml
+37-73Lines changed: 37 additions & 73 deletions
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,8 @@
5
5
name: HandleAdornment
6
6
type: class
7
7
memory_category: Instances
8
-
summary: |
9
-
HandleAdornment is an abstract class inherited by 3D handle adornments.
10
-
description: |
11
-
**Note:** For handles to be interactive, they must be parented to a player's
12
-
`Class.PlayerGui` or the `Class.CoreGui`. **HandleAdornment** is an abstract
13
-
class inherited by 3D handle adornments.
8
+
summary: An abstract class inherited by 3D handle adornments.
9
+
description: "`HandleAdornment` is an abstract class inherited by 3D handle adornments. If parented to a player's `Class.PlayerGui` or the `Class.CoreGui`, handles can listen to input events for purposes such as making dragger tools."
14
10
code_samples: []
15
11
inherits:
16
12
- PVAdornment
@@ -19,9 +15,8 @@ tags:
19
15
deprecation_message: ''
20
16
properties:
21
17
- name: HandleAdornment.AdornCullingMode
22
-
summary: |
23
-
Determines whether to automatically cull the adornment.
24
-
description: ''
18
+
summary: Determines whether to automatically cull the adornment.
19
+
description: This property determines whether to automatically cull the adornment based on distance from the camera.
25
20
code_samples: []
26
21
type: AdornCullingMode
27
22
tags: []
@@ -38,15 +33,10 @@ properties:
38
33
- Basic
39
34
- UI
40
35
- name: HandleAdornment.AlwaysOnTop
41
-
summary: |
42
-
Forces this object to render on top of all 3D objects in the workspace.
43
-
description: |
44
-
Forces this object to render on top of all 3D objects in the workspace.
45
-
Even if the adornment is behind a part based on its
46
-
`Class.HandleAdornment.CFrame`, if **AlwaysOnTop** is true then the
47
-
adornment will still draw on top. The one exception to this behavior is if
48
-
the `Class.HandleAdornment.ZIndex` of the adornment is set to -1. If this
49
-
is the case, the adornment will always draw behind 3D geometry.
36
+
summary: Forces this adornment to render on top of all 3D objects in the workspace.
37
+
description: |-
38
+
If `true`, forces this adornment to render on top of all 3D objects in the
39
+
workspace. As an exception, setting `Class.HandleAdornment.ZIndex|ZIndex` to `-1` will override an `Class.HandleAdornment.AlwaysOnTop|AlwaysOnTop` value of `true` and cause the adornment to appear either in front of or behind other adornments and objects based on their relative position in the 3D space.
50
40
code_samples: []
51
41
type: boolean
52
42
tags: []
@@ -63,15 +53,13 @@ properties:
63
53
- Basic
64
54
- UI
65
55
- name: HandleAdornment.CFrame
66
-
summary: |
56
+
summary: |-
67
57
The position and rotation of the object relative to its
68
58
`Class.PVAdornment.Adornee`.
69
-
description: |
70
-
The position and rotation relative to its `Class.PVAdornment.Adornee`.
71
-
This CFrame is in the local space of the adornee, so forward (0,0,-1) will
72
-
be forward relative to the adornee. The offset and rotation of this CFrame
73
-
is applied after any translations due to
74
-
`Class.HandleAdornment.SizeRelativeOffset`.
59
+
description: |-
60
+
`Datatype.CFrame` position and rotation relative to its
61
+
`Class.PVAdornment.Adornee`, applied after any translations due to
The positional offset of the adornment based on the adornee's
93
81
`Class.BasePart.Size`.
94
-
description: |
95
-
The positional offset of the adornment based on the adornee's
96
-
`Class.BasePart.Size`. By default, an adornment draws in the center of its
97
-
adornee. By using this property, the position of the adornment can be
98
-
shifted relative to the center of the adornee. The units of
99
-
**SizeRelativeOffset** are a scale based on the size of the adornee
100
-
itself. This scale is such that a value of 1 will move the adornment to
101
-
the corresponding edge of the adornee. This property is intended to allow
102
-
adornments to easily be moved to the edges of a parts.
82
+
description: |-
83
+
By default, an adornment draws in the center of its
84
+
`Class.HandleAdornment.Adornee|Adornee`, but this property shifts the
85
+
adornment's relative position based on the adornee's `Class.BasePart.Size`.
103
86
104
-
For example, if the **SizeRelativeOffset** is set to (0,1,0), the
105
-
adornment will be drawn with its center at the exact top of the adornee.
106
-
If set to (1,1,1), the adornment will be drawn in the upper corner of the
107
-
adornee.
87
+
Note that the units of `Class.HandleAdornment.SizeRelativeOffset|SizeRelativeOffset` are a **scale** based on the size of the adornee itself, such that a value of `1` will move the adornment to the corresponding edge of the adornee. For example, a value of
88
+
`Datatype.Vector3.new(0, 1, 0)` will shift the adornment to the exact top of its adornee.
108
89
code_samples: []
109
90
type: Vector3
110
91
tags: []
@@ -121,21 +102,13 @@ properties:
121
102
- Basic
122
103
- UI
123
104
- name: HandleAdornment.ZIndex
124
-
summary: |
125
-
Determines the draw order of the `Class.HandleAdornment`.
126
-
description: |
127
-
The `ZIndex` property determines the draw order of the
128
-
`Class.HandleAdornment`. This only refers to how the adornment will draw
129
-
relative to other adornments or 3D objects in the workspace. This does not
130
-
relate to the `Class.GuiObject.ZIndex` of GuiObjects.
105
+
summary: Determines the draw order of this `Class.HandleAdornment` when `Class.HandleAdornment.AlwaysOnTop|AlwaysOnTop` is `true`.
106
+
description: |-
107
+
Only applies if `Class.HandleAdornment.AlwaysOnTop|AlwaysOnTop` is `true` and determines the draw order of this `Class.HandleAdornment` relative to other adornments. It does not relate to the `Class.GuiObject.ZIndex|ZIndex` property for `Class.GuiObject|GuiObjects`.
108
+
109
+
Valid values are from `-1` to `10` with higher values drawing on top (in front) of lesser values. This drawing order will be respected even if an adornment is in front of or behind another adornment in the 3D space.
131
110
132
-
The valid values for ZIndex are from -1 to 10. If two HandleAdornments are
133
-
drawn over one another, the one with the higher ZIndex will be drawn. This
134
-
order of drawing will be respected even if the adornment with higher
135
-
ZIndex is behind the other adornment in terms of its position in 3D space.
136
-
If set to -1, ZIndex will force the adornment to draw behind other
137
-
adornments and objects in the Workspace, even if the
138
-
`Class.HandleAdornment.AlwaysOnTop` property for the adornment is true.
111
+
As an exception, setting `Class.HandleAdornment.ZIndex|ZIndex` to `-1` or `Class.HandleAdornment.AlwaysOnTop|AlwaysOnTop` to `false` will cause the adornment to appear either in front of or behind other adornments and objects based on their relative position in the 3D space.
139
112
code_samples: []
140
113
type: int
141
114
tags: []
@@ -154,12 +127,11 @@ properties:
154
127
methods: []
155
128
events:
156
129
- name: HandleAdornment.MouseButton1Down
157
-
summary: |
158
-
Fires when a user presses down on their left mouse button while hovering
159
-
over the adornment.
160
-
description: |
161
-
Fires when a user presses down on their left mouse button while hovering
162
-
over the adornment.
130
+
summary: Fires when a player presses down on their left mouse button while hovering over the adornment.
131
+
description: |-
132
+
This event fires when a player presses down their left mouse button while
133
+
hovering over the adornment. Only fires if the adornment is parented to a
134
+
player's `Class.PlayerGui` or the `Class.CoreGui`.
163
135
code_samples: []
164
136
parameters: []
165
137
tags: []
@@ -169,12 +141,8 @@ events:
169
141
- Basic
170
142
- UI
171
143
- name: HandleAdornment.MouseButton1Up
172
-
summary: |
173
-
Fires when a user releases their left mouse button while hovering over the
174
-
adornment.
175
-
description: |
176
-
Fires when a user releases their left mouse button while hovering over the
177
-
adornment.
144
+
summary: Fires when a player releases their left mouse button while hovering over the adornment.
145
+
description: This event fires when a player releases their left mouse button while hovering over the adornment. Only fires if the adornment is parented to a player's `Class.PlayerGui` or the `Class.CoreGui`.
178
146
code_samples: []
179
147
parameters: []
180
148
tags: []
@@ -184,10 +152,8 @@ events:
184
152
- Basic
185
153
- UI
186
154
- name: HandleAdornment.MouseEnter
187
-
summary: |
188
-
Fires when a user moves their mouse over the adornment.
189
-
description: |
190
-
Fires when a user moves their mouse over the adornment.
155
+
summary: Fires when a player moves their mouse over the adornment.
156
+
description: This event fires when a player moves their mouse over the adornment. Only fires if the adornment is parented to a player's `Class.PlayerGui` or the `Class.CoreGui`.
191
157
code_samples: []
192
158
parameters: []
193
159
tags: []
@@ -197,10 +163,8 @@ events:
197
163
- Basic
198
164
- UI
199
165
- name: HandleAdornment.MouseLeave
200
-
summary: |
201
-
Fires when a user moves their mouse out of the adornment.
202
-
description: |
203
-
Fires when a user moves their mouse out of the adornment.
166
+
summary: Fires when a player moves their mouse out of the adornment.
167
+
description: This event fires when a player moves their mouse out of the adornment. Only fires if the adornment is parented to a player's `Class.PlayerGui` or the `Class.CoreGui`.
![rbx-open-source-docs[bot]](https://avatars.githubusercontent.com/in/357490?v=4&size=40){kind=avatar}
0 commit comments