Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
jermainezhimin authored Feb 11, 2025
2 parents db4d908 + 01bffc6 commit 8459b0d
Show file tree
Hide file tree
Showing 5 changed files with 106 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,14 @@ Roblox supports automatic translation between the languages listed below. Curren
</tr>
</thead>
<tbody>
<tr>
<td>Arabic</td>
</tr>
<tr>
<td>Chinese - simplified</td>
<td>Chinese (Simplified)</td>
</tr>
<tr>
<td>Chinese - traditional</td>
<td>Chinese (Traditional)</td>
</tr>
<tr>
<td>English</td>
Expand Down
12 changes: 9 additions & 3 deletions content/en-us/reference/engine/classes/AssetService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,9 @@ methods:
- name: content
type: Content
default:
summary: ''
summary: |
Reference to asset content stored externally or as an object within the place, wrapping a single value
of one of the supported `Enum.ContentSourceType` values.
- name: editableImageOptions
type: Dictionary?
default:
Expand Down Expand Up @@ -250,7 +252,9 @@ methods:
- name: content
type: Content
default:
summary: ''
summary: |
Reference to asset content stored externally or as an object within the place, wrapping a single value
of one of the supported `Enum.ContentSourceType` values.
- name: editableMeshOptions
type: Dictionary?
default:
Expand Down Expand Up @@ -319,7 +323,9 @@ methods:
- name: meshContent
type: Content
default:
summary: ''
summary: |
Reference to asset content stored externally or as an object within the place, wrapping a single value
of one of the supported `Enum.ContentSourceType` values.
- name: options
type: Dictionary
default: nil
Expand Down
2 changes: 1 addition & 1 deletion content/en-us/reference/engine/classes/EditableMesh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ description: |
An `Class.EditableMesh` is displayed when it's linked to a new
`Class.MeshPart`, through `Class.AssetService:CreateMeshPartAsync()`. You can
create more `Class.MeshPart` instances that reference the same
`Class.EditableMesh` content, or link to an existing `Class.MeshPart` through
`Class.EditableMesh` `Datatype.Content`, or link to an existing `Class.MeshPart` through
`Class.MeshPart:ApplyMesh()`.
To recalculate collision and fluid geometry after editing, you can again call
Expand Down
12 changes: 6 additions & 6 deletions content/en-us/reference/engine/enums/Font.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ items:
- name: Arial
value: 1
summary: |
Arial has been removed from Roblox. Use Arimo instead.
Arial has been removed from Roblox. Using Arial will map to Arimo.
tags: []
deprecation_message: ''
- name: ArialBold
value: 2
summary: |
Arial has been removed from Roblox. Use Arimo instead.
Arial has been removed from Roblox. Using Arial will map to Arimo.
tags: []
deprecation_message: ''
- name: SourceSans
Expand Down Expand Up @@ -117,25 +117,25 @@ items:
- name: Gotham
value: 17
summary: |
Gotham has been removed from Roblox. Use Montserrat instead.
Gotham has been removed from Roblox. Using Gotham will map to Montserrat.
tags: []
deprecation_message: ''
- name: GothamMedium
value: 18
summary: |
Gotham has been removed from Roblox. Use Montserrat instead.
Gotham has been removed from Roblox. Using Gotham will map to Montserrat.
tags: []
deprecation_message: ''
- name: GothamBold
value: 19
summary: |
Gotham has been removed from Roblox. Use Montserrat instead.
Gotham has been removed from Roblox. Using Gotham will map to Montserrat.
tags: []
deprecation_message: ''
- name: GothamBlack
value: 20
summary: |
Gotham has been removed from Roblox. Use Montserrat instead.
Gotham has been removed from Roblox. Using Gotham will map to Montserrat.
tags: []
deprecation_message: ''
- name: AmaticSC
Expand Down
100 changes: 85 additions & 15 deletions content/en-us/reference/engine/libraries/math.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,8 @@ functions:
Returns `m` and `e` such that `x` = `m`\*`2`^`e`.
description: |
Returns `m` and `e` such that `x` = `m`\*`2`^`e`. `e` is an integer and
the absolute value of `m` is in the range of 0.5 to 1 (inclusive of 0.5
but exclusive of 1), or zero when `x` is zero.
the absolute value of `m` is in the range of `0.5` to `1` (inclusive of `0.5`
but exclusive of `1`), or zero when `x` is zero.
parameters:
- name: x
type: number
Expand Down Expand Up @@ -281,6 +281,36 @@ functions:
summary: ''
tags:
code_samples:
- name: math.lerp
summary: |
Returns the linear interpolation between `a` and `b`.
description: |
Returns the linear interpolation between `a` and `b` based on the factor `t`.
This function uses the formula `a`+`(b-a)`\*`t`. `t` is typically
between `0` and `1` but values outside this range are acceptable.
parameters:
- name: a
type: number
default:
summary: |
The starting value.
- name: b
type: number
default:
summary: |
The ending value.
- name: t
type: number
default:
summary: |
The interpolation factor, typically between `0` and `1`.
returns:
- type: number
summary: |
The interpolated value between `a` and `b`.
tags:
code_samples:
- name: math.log
summary: |
Returns the logarithm of `x` using the given base.
Expand Down Expand Up @@ -317,6 +347,46 @@ functions:
summary: ''
tags:
code_samples:
- name: math.map
summary: |
Returns the value of `x` mapped from one range to another.
description: |
Returns a value that represents `x` mapped linearly from the input range
(`inmin` to `inmax`) to the output range (`outmin` to `outmax`). This is
achieved by determining the relative position of `x` within the input
range and applying that ratio to the output range.
parameters:
- name: x
type: number
default:
summary: |
The number to be mapped.
- name: inmin
type: number
default:
summary: |
The lower bound of the input range.
- name: inmax
type: number
default:
summary: |
The upper bound of the input range.
- name: outmin
type: number
default:
summary: |
The lower bound of the output range.
- name: outmax
type: number
default:
summary: |
The upper bound of the output range.
returns:
- type: number
summary: |
The value of `x` mapped to the output range.
tags:
code_samples:
- name: math.max
summary: |
Returns the maximum value among the numbers passed to the function.
Expand Down Expand Up @@ -379,7 +449,7 @@ functions:
Returns a Perlin noise value.
description: |
Returns a Perlin noise value. The returned value is most often between the
range of -1 to 1 (inclusive) but sometimes may be outside that range; if
range of `-1` to `1` (inclusive) but sometimes may be outside that range; if
the interval is critical to you, use `Library.math.clamp(noise, -1, 1)` on
the output.
Expand All @@ -393,9 +463,9 @@ functions:
will always return `0.48397532105446` and `Library.math.noise(1.158, 6)`
will always return `0.15315161645412`.
If `x`, `y`, and `z` are all integers, the return value will be 0. For
If `x`, `y`, and `z` are all integers, the return value will be `0`. For
fractional values of `x`, `y`, and `z`, the return value will gradually
fluctuate between -0.5 and 0.5. For coordinates that are close to each
fluctuate between `-0.5` and `0.5`. For coordinates that are close to each
other, the return values will also be close to each other.
parameters:
- name: x
Expand Down Expand Up @@ -455,10 +525,10 @@ functions:
Returns a random number within the range provided.
description: |
When called without arguments, returns a uniform pseudo-random real number
in the range of 0 to 1 (inclusive of 0 but exclusive of 1).
in the range of `0` to `1` (inclusive of `0` but exclusive of `1`).
When called with an integer number `m`, returns a uniform pseudo-random
integer in the range of 1 to `m`, inclusive.
integer in the range of `1` to `m`, inclusive.
When called with two integer numbers `m` and `n`, returns a uniform
pseudo-random integer in the range of `m` to `n`, inclusive.
Expand Down Expand Up @@ -502,12 +572,12 @@ functions:
number.
description: |
Returns the integer with the smallest difference between it and the given
number. For example, the value 5.8 returns 6.
number. For example, the value `5.8` returns `6`.
For values like 0.5 that are equidistant to two integers, the value with
For values like `0.5` that are equidistant to two integers, the value with
the greater difference between it and zero is chosen. In other words, the
function "rounds away from zero" such that 0.5 rounds to 1 and -0.5 rounds
to -1.
function "rounds away from zero" such that `0.5` rounds to `1` and `-0.5`
rounds to `-1`.
parameters:
- name: x
type: number
Expand All @@ -521,11 +591,11 @@ functions:
code_samples:
- name: math.sign
summary: |
Returns -1 if `x` is less than 0, 0 if `x` equals 0, or 1 if `x` is
greater than 0.
Returns `-1` if `x` is less than `0`, `0` if `x` equals `0`, or `1` if `x` is
greater than `0`.
description: |
Returns -1 if `x` is less than 0, 0 if `x` equals 0, or 1 if `x` is
greater than 0.
Returns `-1` if `x` is less than `0`, `0` if `x` equals `0`, or `1` if `x` is
greater than `0`.
parameters:
- name: x
type: number
Expand Down

0 comments on commit 8459b0d

Please sign in to comment.