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
rbx-open-source-docs[bot] committed Dec 2, 2024
1 parent b51ac3c commit 1d14dea
Show file tree
Hide file tree
Showing 20 changed files with 279 additions and 159 deletions.
15 changes: 14 additions & 1 deletion content/en-us/cloud-services/data-stores/error-codes-and-limits.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,12 @@ Requests you make to data stores can fail due to poor connectivity or other issu
<td>`GetVersionAsync` request dropped. Request was throttled.</td>
<td>`Class.DataStore:GetVersionAsync()|GetVersionAsync()` request has exceeded the maximum queue size and Roblox is unable to process the requests at the current throughput.</td>
</tr>
<tr>
<td></td>
<td>`GetVersionAtTimeAsyncThrottle`</td>
<td>`GetVersionAtTimeAsync` request dropped. Request was throttled.</td>
<td>`Class.DataStore:GetVersionAtTimeAsync()|GetVersionAtTimeAsync()` request has exceeded the maximum queue size and Roblox is unable to process the requests at the current throughput.</td>
</tr>
<tr>
<td></td>
<td>`ListDataStoresAsyncThrottle`</td>
Expand All @@ -234,6 +240,13 @@ Requests you make to data stores can fail due to poor connectivity or other issu
<td>`Class.DataStore:RemoveVersionAsync()|RemoveVersionAsync()` request has exceeded the maximum queue size and Roblox is unable to process the requests at the current throughput.</td>
<td></td>
</tr>
<tr>
<td></td>
<td>`InvalidTimestamp`</td>
<td>Timestamp must be positive and not more than ten minutes in the future.</td>
<td>The timestamp provided to `Class.DataStore:GetVersionAtTimeAsync()|GetVersionAtTimeAsync()` was not valid.</td>
<td></td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -339,7 +352,7 @@ Each server is allowed a certain number of data store requests based on the requ
</tr>
<tr>
<td><b>Get Version</b></td>
<td>`Class.DataStore:GetVersionAsync()|GetVersionAsync()`</td>
<td>`Class.DataStore:GetVersionAsync()|GetVersionAsync()`<br></br>`Class.DataStore:GetVersionAtTimeAsync()|GetVersionAtTimeAsync()`</td>
<td>5 + numPlayers × 2</td>
</tr>
<tr>
Expand Down
10 changes: 5 additions & 5 deletions content/en-us/effects/beams.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ The visual quality of your beams can change depending on the graphics settings o

The `Class.Beam.Texture|Texture` property renders that texture across the length of the beam. You can set a beam's `Class.Beam.Texture|Texture` property to any asset ID. For more information, including how to add or upload your own textures, see [Importing Assets](../projects/assets/manager.md#importing-assets).

<img src="../assets/lighting-and-effects/beam/Texture-Applied.png" width="800" />
<img src="../assets/lighting-and-effects/beam/Texture-Applied.png" alt="A texture of dark gray circles against a grey background emits between two attachments." width="800" />

A beam renders its texture using two triangles drawn between `Class.Beam.Segments|Segments`, and the segments are laid out between the two attachment points' orientation. When you rotate attachment points in different directions, segments also rotate.

<img src="../assets/lighting-and-effects/beam/Attachments-Rotated.png" width="800" />
<img src="../assets/lighting-and-effects/beam/Attachments-Rotated.png" alt="The same texture from the previous image is now curved because the attachments are in different orientations." width="800" />

### Color

Expand All @@ -89,7 +89,7 @@ The `Class.Beam.Color|Color` property tints the beam's texture to either a speci
1. Click on the color square to open the **Colors** pop-up window and select a color.
2. Input three numbers into the RGB color value field.

<img src="../assets/studio/properties/Color-Input-Options.png" width="320" />
<img src="../assets/studio/properties/Color-Input-Options.png" alt="" width="320" />

</TabItem>
<TabItem label="Color Gradient">
Expand Down Expand Up @@ -175,7 +175,7 @@ You can set the beam's width in studs at each endpoint by configuring the
The beam below has a `Class.Beam.Width0|Width0` value of **0.5** and a
`Class.Beam.Width1|Width1` value of **3**.

<img src="../assets/lighting-and-effects/beam/Width-Adjusted.png" width="800" />
<img src="../assets/lighting-and-effects/beam/Width-Adjusted.png" alt="A texture emits between two attachments. The texture starts with a small width and ends with a large width." width="800" />

### Texture Length/Mode

Expand Down Expand Up @@ -211,4 +211,4 @@ Beams are configured to use a cubic Bézier curve formed by four control points.

<img src="../assets/engine-api/classes/Beam/Curvature-Diagram.png" width="800" alt="Beam curvature diagram" />

<img src="../assets/lighting-and-effects/beam/Curves-Applied.png" width="800" />
<img src="../assets/lighting-and-effects/beam/Curves-Applied.png" alt="" width="800" />
34 changes: 17 additions & 17 deletions content/en-us/effects/highlighting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ The `Class.Highlight` instance is a visual effect which you can use to call atte

<GridContainer numColumns="3">
<figure>
<img src="../assets/ui/highlighting-objects/OutlineTransparency-1.jpg" />
<img src="../assets/ui/highlighting-objects/OutlineTransparency-1.jpg" alt="A tree mesh against a grey background." />
<figcaption>Base object</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/Overview-Yellow-Outline.jpg" />
<img src="../assets/ui/highlighting-objects/Overview-Yellow-Outline.jpg" alt="The same tree mesh with a yellow outline and a black highlight interior." />
<figcaption>Yellow outline and black interior</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/Overview-Yellow-Interior.jpg" />
<img src="../assets/ui/highlighting-objects/Overview-Yellow-Interior.jpg" alt="The same tree mesh with a black outline and a yellow highlight interior." />
<figcaption>Black outline and yellow interior</figcaption>
</figure>
</GridContainer>
Expand All @@ -40,7 +40,7 @@ To add a highlight effect to an object, you can parent a new `Class.Highlight` d
1. In the [Explorer](../studio/explorer.md) window, hover over either a `Class.Model` or a `Class.BasePart`, then click the &CirclePlus; button. A contextual menu displays.
2. From the menu, insert a **Highlight**. The highlight displays on the object with its default property values that create a white outline and a red tint overlay.

<img src="../assets/ui/highlighting-objects/Adding-Highlight.jpg" width="320" />
<img src="../assets/ui/highlighting-objects/Adding-Highlight.jpg" alt="" width="320" />

### Setting the Adornee

Expand All @@ -56,15 +56,15 @@ The `Class.Highlight.OutlineColor|OutlineColor` property sets the `Datatype.Colo

<GridContainer numColumns="3">
<figure>
<img src="../assets/ui/highlighting-objects/OutlineColor-Red.jpg" />
<img src="../assets/ui/highlighting-objects/OutlineColor-Red.jpg" alt="A tree mesh with red outline." />
<figcaption>OutlineColor = [255, 100, 50]</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/OutlineColor-Green.jpg" />
<img src="../assets/ui/highlighting-objects/OutlineColor-Green.jpg" alt="A tree mesh with green outline." />
<figcaption>OutlineColor = [0, 255, 125]</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/OutlineColor-Blue.jpg" />
<img src="../assets/ui/highlighting-objects/OutlineColor-Blue.jpg" alt="A tree mesh with blue outline." />
<figcaption>OutlineColor = [75, 150, 255]</figcaption>
</figure>
</GridContainer>
Expand All @@ -75,11 +75,11 @@ The `Class.Highlight.OutlineTransparency|OutlineTransparency` property sets the

<GridContainer numColumns="3">
<figure>
<img src="../assets/ui/highlighting-objects/OutlineTransparency-0.jpg" />
<img src="../assets/ui/highlighting-objects/OutlineTransparency-0.jpg" alt="A tree mesh with black opaque outline."/>
<figcaption>OutlineTransparency = 0</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/OutlineTransparency-1.jpg" />
<img src="../assets/ui/highlighting-objects/OutlineTransparency-1.jpg" alt="A tree mesh with transparent outline." />
<figcaption>OutlineTransparency = 1</figcaption>
</figure>
</GridContainer>
Expand All @@ -90,15 +90,15 @@ The `Class.Highlight.FillColor|FillColor` property sets the `Datatype.Color3` va

<GridContainer numColumns="3">
<figure>
<img src="../assets/ui/highlighting-objects/FillColor-Red.jpg" />
<img src="../assets/ui/highlighting-objects/FillColor-Red.jpg" alt="A tree mesh with a red fill." />
<figcaption>FillColor = [255, 100, 50]</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/FillColor-Green.jpg" />
<img src="../assets/ui/highlighting-objects/FillColor-Green.jpg" alt="A tree mesh with a red fill." />
<figcaption>FillColor = [0, 255, 125]</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/FillColor-Blue.jpg" />
<img src="../assets/ui/highlighting-objects/FillColor-Blue.jpg" alt="A tree mesh with a blue fill." />
<figcaption>FillColor = [75, 150, 255]</figcaption>
</figure>
</GridContainer>
Expand All @@ -109,15 +109,15 @@ The `Class.Highlight.FillTransparency|FillTransparency` property sets the visibi

<GridContainer numColumns="3">
<figure>
<img src="../assets/ui/highlighting-objects/FillTransparency-0.jpg" />
<img src="../assets/ui/highlighting-objects/FillTransparency-0.jpg" alt="A tree mesh with an opaque black fill." />
<figcaption>FillTransparency = 0</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/FillTransparency-Half.jpg" />
<img src="../assets/ui/highlighting-objects/FillTransparency-Half.jpg" alt="A tree mesh with an semi-transparent black fill." />
<figcaption>FillTransparency = 0.5</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/FillTransparency-1.jpg" />
<img src="../assets/ui/highlighting-objects/FillTransparency-1.jpg" alt="A tree mesh with a transparent black fill." />
<figcaption>FillTransparency = 1</figcaption>
</figure>
</GridContainer>
Expand All @@ -132,10 +132,10 @@ The `Class.Highlight.DepthMode|DepthMode` property controls how the effect displ

<Tabs>
<TabItem label="AlwaysOnTop">
<img src="../assets/ui/highlighting-objects/DepthMode-AlwaysOnTop.jpg" width="800" height="450" />
<img src="../assets/ui/highlighting-objects/DepthMode-AlwaysOnTop.jpg" alt="Two objects are behind pillars, but because their AlwayOnTop property is set to true, you can still see the objects and their highlight." width="800" height="450" />
</TabItem>
<TabItem label="Occluded">
<img src="../assets/ui/highlighting-objects/DepthMode-Occluded.jpg" width="800" height="450" />
<img src="../assets/ui/highlighting-objects/DepthMode-Occluded.jpg" alt="Two objects are behind pillars, but because their Occuluded property is set to true, you can only see the objects and their highlight in areas where they are unobstructed." width="800" height="450" />
</TabItem>
</Tabs>

Expand Down
12 changes: 6 additions & 6 deletions content/en-us/effects/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ are three types of light sources:

<GridContainer numColumns="3">
<figure>
<img src="../assets/lighting-and-effects/light-sources/PointLight-Range-8.jpg" />
<img src="../assets/lighting-and-effects/light-sources/PointLight-Range-8.jpg" alt="" />
<figcaption>Point Lights</figcaption>
</figure>
<figure>
<img src="../assets/lighting-and-effects/light-sources/SpotLight-Face-Bottom.jpg" />
<img src="../assets/lighting-and-effects/light-sources/SpotLight-Face-Bottom.jpg" alt="" />
<figcaption>Spotlights</figcaption>
</figure>
<figure>
<img src="../assets/lighting-and-effects/light-sources/SurfaceLight-Angle-0.jpg" />
<img src="../assets/lighting-and-effects/light-sources/SurfaceLight-Angle-0.jpg" alt="" />
<figcaption>Surface Lights</figcaption>
</figure>
</GridContainer>
Expand Down Expand Up @@ -75,15 +75,15 @@ width="100%"></video>

<GridContainer numColumns="3">
<figure>
<img src="../assets/ui/highlighting-objects/OutlineTransparency-1.jpg" />
<img src="../assets/ui/highlighting-objects/OutlineTransparency-1.jpg" alt="A tree mesh against a grey background." />
<figcaption>Base object</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/Adding-Highlight.jpg" />
<img src="../assets/ui/highlighting-objects/Adding-Highlight.jpg" alt="The same tree mesh with a white outline and a red highlight interior." />
<figcaption>White outline, 50% red interior</figcaption>
</figure>
<figure>
<img src="../assets/ui/highlighting-objects/Overview-Yellow-Outline.jpg" />
<img src="../assets/ui/highlighting-objects/Overview-Yellow-Outline.jpg" alt="The same tree mesh with a yellow outline and a black highlight interior." />
<figcaption>Yellow outline, black interior</figcaption>
</figure>
</GridContainer>
Loading

0 comments on commit 1d14dea

Please sign in to comment.