Skip to content

Commit 781515e

Browse files
update Open Source Docs from Roblox internal teams
1 parent c514fa1 commit 781515e

18 files changed

+228
-96
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3713,6 +3713,11 @@ navigation:
37133713
type: engineapi
37143714
source: /reference/engine/enums/CompileTarget.yaml
37153715
ignoreTranslation: true
3716+
- title: CompletionAcceptanceBehavior
3717+
path: /reference/engine/enums/CompletionAcceptanceBehavior
3718+
type: engineapi
3719+
source: /reference/engine/enums/CompletionAcceptanceBehavior.yaml
3720+
ignoreTranslation: true
37163721
- title: CompletionItemKind
37173722
path: /reference/engine/enums/CompletionItemKind
37183723
type: engineapi

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ methods:
6262
summary: |
6363
Table containing options for the created `Class.EditableMesh`.
6464
Currently no options are available since
65-
`Class.EditableMesh.FixedSize|FixedSize` will always be `false` for empty editable meshes.
65+
`Class.EditableMesh.FixedSize|FixedSize` will always be `false` for
66+
empty editable meshes.
6667
returns:
6768
- type: Object
6869
summary: ''
@@ -220,8 +221,8 @@ methods:
220221
the device-specific editable memory budget is exhausted, creation will
221222
fail and this method will return `nil`.
222223
223-
See the `Class.EditableImage` documentation for special
224-
considerations when using this API.
224+
See the `Class.EditableImage` documentation for special considerations
225+
when using this API.
225226
code_samples: []
226227
parameters:
227228
- name: content

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ description: |
3030
3131
```lua
3232
local Players = game:GetService("Players")
33-
33+
3434
-- Accessing Backpack from a Server Script:
3535
local backpack = Players.PlayerName.Backpack
3636

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -452,8 +452,8 @@ properties:
452452
description: |
453453
Controls the size that the `Class.BillboardGui` will have on screen.
454454
Unlike `Class.GuiObject.Size`, the
455-
[scale](../../../ui/position-and-size.md#size) components of this
456-
property set the billboard's stud size in 3D space.
455+
[scale](../../../ui/position-and-size.md#size) components of this property
456+
set the billboard's stud size in 3D space.
457457
code_samples:
458458
type: UDim2
459459
tags: []

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ methods:
5757
numbers, strings, and booleans, although you should carefully explore the
5858
[limitations](../../../scripting/events/bindable.md#argument-limitations).
5959
60-
See [Bindable events and callbacks](../../../scripting/events/bindable.md) for
61-
code samples and further details on `Class.BindableEvent:Fire()|Fire()`.
60+
See [Bindable events and callbacks](../../../scripting/events/bindable.md)
61+
for code samples and further details on
62+
`Class.BindableEvent:Fire()|Fire()`.
6263
code_samples:
6364
parameters:
6465
- name: arguments
@@ -86,8 +87,8 @@ events:
8687
on the same `Class.BindableEvent` instance, using the same arguments as
8788
parameters.
8889
89-
See [Bindable events and callbacks](../../../scripting/events/bindable.md) for
90-
code samples and further details on `Class.BindableEvent.Event|Event`.
90+
See [Bindable events and callbacks](../../../scripting/events/bindable.md)
91+
for code samples and further details on `Class.BindableEvent.Event|Event`.
9192
code_samples:
9293
parameters:
9394
- name: arguments

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,18 @@ methods:
5252
the given tag.
5353
5454
##### Warnings
55-
56-
- An instance's tags that were added client-side will be dropped if the server
57-
later adds or removes a tag on that instance because the server replicates all
58-
tags together and overwrites previous tags.
5955
60-
- When tagging an instance, it is common that some resources
61-
are used to give the tag its functionality, for example event connections or
62-
tables. To prevent memory leaks, it's a good idea to clean these up
63-
(disconnect, set to `nil`, etc.) when no longer needed for a tag. Do this
64-
when calling `Class.CollectionService:RemoveTag()`, calling
65-
`Class.Instance:Destroy()` or in a function connected to a signal returned
66-
by `Class.CollectionService:GetInstanceRemovedSignal()`.
56+
- An instance's tags that were added client-side will be dropped if the
57+
server later adds or removes a tag on that instance because the server
58+
replicates all tags together and overwrites previous tags.
59+
60+
- When tagging an instance, it is common that some resources are used to
61+
give the tag its functionality, for example event connections or tables.
62+
To prevent memory leaks, it's a good idea to clean these up (disconnect,
63+
set to `nil`, etc.) when no longer needed for a tag. Do this when
64+
calling `Class.CollectionService:RemoveTag()`, calling
65+
`Class.Instance:Destroy()` or in a function connected to a signal
66+
returned by `Class.CollectionService:GetInstanceRemovedSignal()`.
6767
code_samples:
6868
parameters:
6969
- name: instance

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,25 @@ properties:
204204
capabilities:
205205
- Basic
206206
writeCapabilities: []
207+
- name: Decal.TextureContent
208+
summary: ''
209+
description: ''
210+
code_samples: []
211+
type: Content
212+
tags:
213+
- Hidden
214+
deprecation_message: ''
215+
security:
216+
read: None
217+
write: None
218+
thread_safety: ReadSafe
219+
category: Appearance
220+
serialization:
221+
can_load: true
222+
can_save: true
223+
capabilities:
224+
- Basic
225+
writeCapabilities: []
207226
- name: Decal.Transparency
208227
summary: |
209228
Determines the transparency of the `Class.Decal` with 0 being completely

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ properties:
2424
property that provides the screen position of a `Class.GuiBase2d` element
2525
in pixels. This represents the actual pixel position at which an element
2626
renders as a result of its ancestors' sizes and positions. Note that
27-
`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` always
28-
represents the top-left corner of the `Class.GuiBase2d` element.
27+
`Class.GuiBase2d.AbsolutePosition|AbsolutePosition` always represents the
28+
top-left corner of the `Class.GuiBase2d` element.
2929
3030
See also `Class.GuiBase2d.AbsoluteRotation|AbsoluteRotation` and
3131
`Class.GuiBase2d.AbsoluteSize|AbsoluteSize`.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ properties:
7474
is positioned (through `Class.GuiObject.Position`) and from which the
7575
rendered `Class.GuiObject.Size` expands.
7676
77-
See [here](../../../ui/position-and-size.md#anchorpoint) for
78-
illustrated diagrams and details.
77+
See [here](../../../ui/position-and-size.md#anchorpoint) for illustrated
78+
diagrams and details.
7979
code_samples:
8080
- AnchorPoint-Demo
8181
type: Vector2

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1458,6 +1458,24 @@ methods:
14581458
thread_safety: Unsafe
14591459
capabilities: []
14601460
writeCapabilities: []
1461+
- name: Humanoid:ComputeOriginalSizeForPart
1462+
summary: ''
1463+
description: ''
1464+
code_samples: []
1465+
parameters:
1466+
- name: part
1467+
type: Instance
1468+
default:
1469+
summary: ''
1470+
returns:
1471+
- type: Vector3?
1472+
summary: ''
1473+
tags: []
1474+
deprecation_message: ''
1475+
security: RobloxScriptSecurity
1476+
thread_safety: Unsafe
1477+
capabilities: []
1478+
writeCapabilities: []
14611479
- name: Humanoid:EquipTool
14621480
summary: |
14631481
Makes the `Class.Humanoid` equip the given `Class.Tool`.

0 commit comments

Comments
 (0)