Skip to content

Commit

Permalink
update Open Source Docs from Roblox internal teams
Browse files Browse the repository at this point in the history
  • Loading branch information
rbx-open-source-docs[bot] committed Feb 6, 2025
1 parent 230aef0 commit 9f5d043
Show file tree
Hide file tree
Showing 58 changed files with 1,079 additions and 420 deletions.
11 changes: 10 additions & 1 deletion .github/actions/quality-checks/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,21 @@ description: Reusable action for running the quality checks
inputs:
BASE_BRANCH:
description: Base branch
CHECK_LOCALIZED_CONTENT:
description: Whether to check localized content
CHECK_MARKDOWN_LINT:
description: Whether to check markdown lint
CHECK_PROTECTED_FIELDS:
description: Whether to check protected YAML fields
CHECK_RETEXT_ANALYSIS:
description: Whether to check retext analysis
COMMIT_HASH:
description: Commit hash
EVENT_NAME:
description: Github event name
GITHUB_PAT:
description: Github token
POST_PULL_REQUEST_COMMENTS:
POST_PULL_REQUEST_COMMENTS:
description: Whether to post comments on the pull request
PULL_REQUEST_NUMBER:
description: Pull request number
Expand Down Expand Up @@ -40,7 +46,10 @@ runs:
env:
GITHUB_PAT: ${{ inputs.GITHUB_PAT }}
BASE_BRANCH: ${{ inputs.BASE_BRANCH }}
CHECK_LOCALIZED_CONTENT: ${{ inputs.CHECK_LOCALIZED_CONTENT }}
CHECK_MARKDOWN_LINT: ${{ inputs.CHECK_MARKDOWN_LINT }}
CHECK_PROTECTED_FIELDS: ${{ inputs.CHECK_PROTECTED_FIELDS }}
CHECK_RETEXT_ANALYSIS: ${{ inputs.CHECK_RETEXT_ANALYSIS }}
COMMIT_HASH: ${{ inputs.COMMIT_HASH }}
POST_PULL_REQUEST_COMMENTS: ${{ inputs.POST_PULL_REQUEST_COMMENTS }}
PULL_REQUEST_NUMBER: ${{ inputs.PULL_REQUEST_NUMBER }}
9 changes: 6 additions & 3 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,18 @@ engine reference:
- 'content/en-us/reference/engine/**/*'
- 'content/common/navigation/engine/reference.yaml'

navigation:
- 'content/common/navigation/**/*'

cloud:
- 'content/en-us/cloud/**/*'
- 'content/en-us/assets/open-cloud/**/*'
- 'content/en-us/reference/cloud/**/*'
- 'content/common/navigation/cloud/**/*'

localization:
- any: ['content/**/*', '!content/en-us/**', '!content/common/**']

navigation:
- 'content/common/navigation/**/*'

resources:
- 'content/en-us/resources/**/*'
- 'content/common/navigation/engine/resources.yaml'
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/content-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,10 @@ jobs:
with:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
BASE_BRANCH: origin/main
CHECK_LOCALIZED_CONTENT: false
CHECK_MARKDOWN_LINT: true
CHECK_PROTECTED_FIELDS: true
CHECK_RETEXT_ANALYSIS: true
COMMIT_HASH: ${{ github.event.pull_request.head.sha }}
EVENT_NAME: ${{ github.event_name }}
POST_PULL_REQUEST_COMMENTS: true
Expand Down
26 changes: 14 additions & 12 deletions content/common/navigation/engine/guides.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -369,24 +369,26 @@ navigation:
section:
- title: Labels
path: /ui/labels
- title: Buttons
path: /ui/buttons
- title: Frames
path: /ui/frames
- title: Scrolling frames
path: /ui/scrolling-frames
- title: Viewport frames
path: /ui/viewport-frames
- title: Video frames
path: /ui/video-frames
- title: Text input fields
path: /ui/text-input
- title: 2D paths
path: /ui/2D-paths
- title: Interactive
section:
- title: Buttons
path: /ui/buttons
- title: Text input fields
path: /ui/text-input
- title: Proximity prompts
path: /ui/proximity-prompts
- title: UI drag detectors
path: /ui/ui-drag-detectors
- title: 3D drag detectors
path: /ui/3D-drag-detectors
- title: Proximity prompts
path: /ui/proximity-prompts
- title: UI drag detectors
path: /ui/ui-drag-detectors
- title: 3D drag detectors
path: /ui/3D-drag-detectors
- title: Position and size
path: /ui/position-and-size
- title: Layout structures
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions content/en-us/assets/ui/misc/Roblox-UI-And-Cutout.png

This file was deleted.

3 changes: 0 additions & 3 deletions content/en-us/assets/ui/ui-objects/Frame-Empty.jpg

This file was deleted.

4 changes: 2 additions & 2 deletions content/en-us/assets/ui/ui-objects/Frame-Example.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions content/en-us/assets/ui/ui-objects/ScrollingFrame-Example.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/en-us/environment/skybox.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A **skybox** is a cube made up of six individual images that create an immersive
Additionally, the `Class.Sky` object includes celestial bodies such as a sun, moon, and stars which dynamically appear, rise, and set based on the
`Class.Lighting.TimeOfDay|TimeOfDay` or `Class.Lighting.ClockTime|ClockTime`.

Finally, the `Class.Sky` object can be used as a cubemap for reflections in `Class.ViewportFrame|ViewportFrames`. For details, see [Frames](../ui/frames.md#viewportframe).
Finally, the `Class.Sky` object can be used as a cubemap for reflections in `Class.ViewportFrame|ViewportFrames`. For details, see [viewport frames](../ui/viewport-frames.md).

## Create skyboxes

Expand Down
2 changes: 1 addition & 1 deletion content/en-us/projects/assets/toolbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The Toolbox contains a selection of assets made by Roblox or Roblox
id: toolbox
---

The **Toolbox** contains a selection of [models](../../parts/models.md), [images](../../parts/textures-decals.md), [meshes](../../parts/meshes.md), [audio](../../sound/assets.md), [plugins](../../studio/plugins.md), [videos](../../ui/frames.md#videoframe), and fonts made by Roblox or Roblox community members. It also includes all of the creations that you've personally published or those which were published by [groups](../../projects/groups.md) you belong to.
The **Toolbox** contains a selection of [models](../../parts/models.md), [images](../../parts/textures-decals.md), [meshes](../../parts/meshes.md), [audio](../../sound/assets.md), [plugins](../../studio/plugins.md), [videos](../../ui/video-frames.md), and fonts made by Roblox or Roblox community members. It also includes all of the creations that you've personally published or those which were published by [groups](../../projects/groups.md) you belong to.

<img src="../../assets/studio/general/View-Tab-Toolbox.png" width="776" alt="Studio's View tab with the Toolbox button highlighted." />

Expand Down
18 changes: 18 additions & 0 deletions content/en-us/reference/engine/classes/AudioAnalyzer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,24 @@ properties:
capabilities:
- Audio
writeCapabilities: []
- name: AudioAnalyzer.WindowSize
summary: ''
description: ''
code_samples: []
type: AudioWindowSize
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: State
serialization:
can_load: true
can_save: true
capabilities:
- Audio
writeCapabilities: []
methods:
- name: AudioAnalyzer:GetConnectedWires
summary: |
Expand Down
14 changes: 14 additions & 0 deletions content/en-us/reference/engine/classes/AudioEcho.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,20 @@ methods:
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
- name: AudioEcho:Reset
summary: ''
description: ''
code_samples: []
parameters: []
returns:
- type: void
summary: ''
tags: []
deprecation_message: ''
security: RobloxScriptSecurity
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
events:
- name: AudioEcho.WiringChanged
summary: |
Expand Down
14 changes: 14 additions & 0 deletions content/en-us/reference/engine/classes/AudioListener.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,20 @@ methods:
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
- name: AudioListener:Reset
summary: ''
description: ''
code_samples: []
parameters: []
returns:
- type: void
summary: ''
tags: []
deprecation_message: ''
security: RobloxScriptSecurity
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
- name: AudioListener:SetAngleAttenuation
summary: |
Sets the angle attenuation curve that the `Class.AudioListener` should
Expand Down
18 changes: 18 additions & 0 deletions content/en-us/reference/engine/classes/AudioPitchShifter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,24 @@ properties:
capabilities:
- Audio
writeCapabilities: []
- name: AudioPitchShifter.WindowSize
summary: ''
description: ''
code_samples: []
type: AudioWindowSize
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: State
serialization:
can_load: true
can_save: true
capabilities:
- Audio
writeCapabilities: []
methods:
- name: AudioPitchShifter:GetConnectedWires
summary: |
Expand Down
7 changes: 5 additions & 2 deletions content/en-us/reference/engine/classes/AudioPlayer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ properties:
`Class.AudioPlayer.IsReady|IsReady` becomes true.
code_samples: []
type: string
tags: []
tags:
- Hidden
- NotReplicated
- Deprecated
deprecation_message: ''
security:
read: None
Expand All @@ -33,7 +36,7 @@ properties:
category: Asset
serialization:
can_load: true
can_save: true
can_save: false
capabilities:
- Audio
writeCapabilities: []
Expand Down
14 changes: 14 additions & 0 deletions content/en-us/reference/engine/classes/AudioReverb.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,20 @@ methods:
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
- name: AudioReverb:Reset
summary: ''
description: ''
code_samples: []
parameters: []
returns:
- type: void
summary: ''
tags: []
deprecation_message: ''
security: RobloxScriptSecurity
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
events:
- name: AudioReverb.WiringChanged
summary: |
Expand Down
16 changes: 10 additions & 6 deletions content/en-us/reference/engine/classes/DataStore.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,9 @@ methods:
type: int
default: 0
summary: |
**(Optional)** Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 50 items per page.
**(Optional)** Number of items to be returned in each page. If no
value is given, the engine sends a default value of 0 to the data
store web service, which in turn defaults to 50 items per page.
- name: cursor
type: string
default: ''
Expand Down Expand Up @@ -167,19 +169,21 @@ methods:
type: int64
default: 0
summary: |
**(Optional)** Unix timestamp in milliseconds after which the versions should be
listed.
**(Optional)** Unix timestamp in milliseconds after which the versions
should be listed.
- name: maxDate
type: int64
default: 0
summary: |
**(Optional)** Unix timestamp in milliseconds up to which the versions should be
listed.
**(Optional)** Unix timestamp in milliseconds up to which the versions
should be listed.
- name: pageSize
type: int
default: 0
summary: |
**(Optional)** Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 1024 items per page.
**(Optional)** Number of items to be returned in each page. If no
value is given, the engine sends a default value of 0 to the data
store web service, which in turn defaults to 1024 items per page.
returns:
- type: DataStoreVersionPages
summary: |
Expand Down
7 changes: 5 additions & 2 deletions content/en-us/reference/engine/classes/DataStoreService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ methods:
data store. This function also accepts an optional
`Class.DataStoreOptions` instance which includes options for enabling
`Class.DataStoreOptions.AllScopes|AllScopes`. See
[Data stores](../../../cloud-services/data-stores/index.md) for details on scope.
[Data stores](../../../cloud-services/data-stores/index.md) for details on
scope.
code_samples:
parameters:
- name: name
Expand Down Expand Up @@ -190,7 +191,9 @@ methods:
type: int
default: 0
summary: |
**(Optional)** Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 32 items per page.
**(Optional)** Number of items to be returned in each page. If no
value is given, the engine sends a default value of 0 to the data
store web service, which in turn defaults to 32 items per page.
- name: cursor
type: string
default: ''
Expand Down
16 changes: 8 additions & 8 deletions content/en-us/reference/engine/classes/Frame.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ description: |
<img src="/assets/ui/ui-objects/Frame-Example.jpg" width="840" />
When you manipulate frames, you also manipulate the
`Class.GuiObject|GuiObjects` they contain. For example, if you change the
position of a `Class.Frame` object with a child `Class.TextLabel`, you also
change the position of that label. In addition, all frames are also
`Class.GuiObject|GuiObjects`, so you can customize their properties, such as
`Class.Frame|Frames` are ideal containers for responsive layouts such as
[list and flex layouts](../../../ui/list-flex-layouts.md), allowing you to
change the size of the frame and dynamically adjust how layout items fit
within it. `Class.Frame|Frames` are also core `Class.GuiObject|GuiObjects`, so
you can customize properties such as
`Class.GuiObject.BackgroundColor3|BackgroundColor3`,
`Class.GuiObject.BorderMode|BorderMode`,
`Class.GuiObject.Transparency|Transparency`, and
`Class.GuiObject.Rotation|Rotation`, to fit the aesthetics of your experience.
`Class.GuiObject.Transparency|Transparency`, apply a
[background gradient](../../../ui/appearance-modifiers.md#gradient) or
[border](../../../ui/appearance-modifiers.md#stroke), and more.
code_samples:
inherits:
- GuiObject
Expand Down
Loading

0 comments on commit 9f5d043

Please sign in to comment.