Skip to content

Commit

Permalink
Merge branch 'main' into patch-9
Browse files Browse the repository at this point in the history
  • Loading branch information
aetter authored Jan 30, 2025
2 parents 4c7bc69 + b6bb353 commit c11b7af
Show file tree
Hide file tree
Showing 18 changed files with 211 additions and 55 deletions.
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Folders
**/node_modules/
tools/output/
**output/
**dist/

# Files
.DS_Store
.env
**.env
10 changes: 10 additions & 0 deletions content/common/navigation/engine/reference.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,11 @@ navigation:
type: engineapi
source: /reference/engine/classes/BubbleChatMessageProperties.yaml
ignoreTranslation: true
- title: BugReporterService
path: /reference/engine/classes/BugReporterService
type: engineapi
source: /reference/engine/classes/BugReporterService.yaml
ignoreTranslation: true
- title: BuoyancySensor
path: /reference/engine/classes/BuoyancySensor
type: engineapi
Expand Down Expand Up @@ -4618,6 +4623,11 @@ navigation:
type: engineapi
source: /reference/engine/enums/ProductLocationRestriction.yaml
ignoreTranslation: true
- title: ProductPurchaseChannel
path: /reference/engine/enums/ProductPurchaseChannel
type: engineapi
source: /reference/engine/enums/ProductPurchaseChannel.yaml
ignoreTranslation: true
- title: ProductPurchaseDecision
path: /reference/engine/enums/ProductPurchaseDecision
type: engineapi
Expand Down
2 changes: 1 addition & 1 deletion content/en-us/production/promotion/ads-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ An **ad campaign** is a coordinated series of ads designed to achieve a specific
Before launching your campaign, you'll be able to [review your campaign details](#review-the-campaign) before submitting it to Roblox for moderation and approval.

<Alert severity="warning">
Advertising paid experiences is prohibited. You will not be able to select paid experiences in the dropdown menu during the ad selection process.
Advertising paid experiences and restricted (17+) experiences is only available with sponsored and search ads.
</Alert>

### Define the campaign
Expand Down
2 changes: 1 addition & 1 deletion content/en-us/production/promotion/search-ads.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Search results populate in the following ways:
<br />

<Alert severity ='warning'>
All Roblox advertisers of experiences must abide by our [Community Standards](https://en.help.roblox.com/hc/en-us/articles/203313410-Roblox-Community-Standards). Currently, [paid access experiences in Robux](../monetization/paid-access-robux.md), [paid access experiences in local currency](../monetization/paid-access-local-currency.md), and [17+ experiences](https://en.help.roblox.com/hc/en-us/articles/15869919570708-Roblox-17-Policy-Standards) are not eligible to advertise using search ads. Roblox prevents surfacing experiences identified as clickbait or spam.
All Roblox advertisers of experiences must abide by our [Community Standards](https://en.help.roblox.com/hc/en-us/articles/203313410-Roblox-Community-Standards). Roblox prevents surfacing experiences identified as clickbait or spam.
</Alert>

## Create search ads
Expand Down
48 changes: 48 additions & 0 deletions content/en-us/reference/engine/classes/BugReporterService.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: BugReporterService
type: class
category:
memory_category: Instances
summary: ''
description: ''
code_samples: []
inherits:
- Instance
tags:
- NotCreatable
- Service
- NotReplicated
deprecation_message: ''
properties: []
methods:
- name: BugReporterService:IsAvailable
summary: ''
description: ''
code_samples: []
parameters: []
returns:
- type: bool
summary: ''
tags:
- Yields
deprecation_message: ''
security: RobloxScriptSecurity
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
events:
- name: BugReporterService.BugReportRequested
summary: ''
description: ''
code_samples: []
parameters:
- name: message
type: string
default:
summary: ''
tags: []
deprecation_message: ''
security: RobloxScriptSecurity
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
callbacks: []
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ events:
default:
summary: |
The identifier for the recording.
- name: operationn
- name: operation
type: FinishRecordingOperation
default:
summary: ''
Expand Down
19 changes: 19 additions & 0 deletions content/en-us/reference/engine/classes/Chat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,25 @@ properties:
can_save: true
capabilities: []
writeCapabilities: []
- name: Chat.IsAutoMigrated
summary: ''
description: ''
code_samples: []
type: bool
tags:
- Hidden
- NotReplicated
deprecation_message: ''
security:
read: RobloxScriptSecurity
write: RobloxScriptSecurity
thread_safety: ReadSafe
category: Data
serialization:
can_load: true
can_save: true
capabilities: []
writeCapabilities: []
- name: Chat.LoadDefaultChat
summary: |
Toggles whether the default chat framework should be automatically loaded
Expand Down
14 changes: 8 additions & 6 deletions content/en-us/reference/engine/classes/CollectionService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ methods:
set to `nil`, etc.) when no longer needed for a tag. Do this when
calling `Class.CollectionService:RemoveTag()|RemoveTag()`, calling
`Class.Instance:Destroy()` or in a function connected to a signal
returned by `Class.CollectionService:GetInstanceRemovedSignal()|GetInstanceRemovedSignal()`.
returned by
`Class.CollectionService:GetInstanceRemovedSignal()|GetInstanceRemovedSignal()`.
code_samples:
parameters:
- name: instance
Expand Down Expand Up @@ -137,11 +138,11 @@ methods:
conditions:
- The tag is assigned to an instance within the `Class.DataModel` using
`Class.CollectionService:AddTag()` or `Class.Instance:AddTag()`.
`Class.CollectionService:AddTag()` or `Class.Instance:AddTag()`.
- An instance with the given tag is added as a descendant of the
`Class.DataModel`, for example by setting `Class.Instance.Parent` or
similar.
`Class.DataModel`, for example by setting `Class.Instance.Parent` or
similar.
Subsequent calls to this method with the same tag return the same signal
object. Consider also calling
Expand Down Expand Up @@ -178,10 +179,11 @@ methods:
conditions:
- The tag is removed from an instance within the `Class.DataModel` using
`Class.CollectionService:RemoveTag()` or `Class.Instance:RemoveTag()`.
`Class.CollectionService:RemoveTag()` or `Class.Instance:RemoveTag()`.
- An instance with the given tag is removed as a descendant of the
`Class.DataModel`, for example by un‑setting `Class.Instance.Parent` or similar.
`Class.DataModel`, for example by un‑setting `Class.Instance.Parent` or
similar.
Subsequent calls to this method with the same tag return the same signal
object. The signal is useful for cleaning up resources used by instances
Expand Down
25 changes: 24 additions & 1 deletion content/en-us/reference/engine/classes/CreatorStoreService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,29 @@ tags:
- Service
deprecation_message: ''
properties: []
methods: []
methods:
- name: CreatorStoreService:PerformCreatorStorePurchase
summary: ''
description: ''
code_samples: []
parameters:
- name: productTargetId
type: int64
default:
summary: ''
- name: assetType
type: string
default:
summary: ''
returns:
- type: Dictionary
summary: ''
tags:
- Yields
deprecation_message: ''
security: RobloxScriptSecurity
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
events: []
callbacks: []
8 changes: 6 additions & 2 deletions content/en-us/reference/engine/classes/GeometryService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ methods:
- `weldConstraintPreserve` — A `Enum.WeldConstraintPreserve` enum value
describing how `Class.WeldConstraint|WeldConstraints` are preserved in
the resulting recommendation table.
- `dropAttachmentsWithoutConstraints` — Boolean with default of `true`. If set to `false`, `Class.Attachment|Attachments` that have no `Class.Constraint|Constraints` will be preserved.
- `dropAttachmentsWithoutConstraints` — Boolean with default of `true`. If
set to `false`, `Class.Attachment|Attachments` that have no
`Class.Constraint|Constraints` will be preserved.
code_samples:
- GeometryService-CalculateConstraintsToPreserve
parameters:
Expand Down Expand Up @@ -72,7 +74,9 @@ methods:
- `weldConstraintPreserve` — A `Enum.WeldConstraintPreserve` enum
value describing how `Class.WeldConstraint|WeldConstraints` are
preserved in the resulting recommendation table.
- `dropAttachmentsWithoutConstraints` — Boolean with default of `true`. If set to `false`, `Class.Attachment|Attachments` that have no `Class.Constraint|Constraints` will be preserved.
- `dropAttachmentsWithoutConstraints` — Boolean with default of
`true`. If set to `false`, `Class.Attachment|Attachments` that have
no `Class.Constraint|Constraints` will be preserved.
returns:
- type: Array
summary: |
Expand Down
54 changes: 28 additions & 26 deletions content/en-us/reference/engine/classes/HttpService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ type: class
category: Data
memory_category: Instances
summary: |
Allows sending HTTP requests and provides various web-related and JSON methods.
Allows sending HTTP requests and provides various web-related and JSON
methods.
description: |
`HttpService` allows HTTP requests to be sent from game servers using
`Class.HttpService:RequestAsync()|RequestAsync`,
Expand All @@ -16,9 +17,9 @@ description: |
`HttpService` also houses the `Class.HttpService:JSONEncode()|JSONEncode` and
`Class.HttpService:JSONDecode()|JSONDecode` methods which are useful for
communicating with services that use the [JSON](https://json.org) format. In
addition, the `Class.HttpService:GenerateGUID()|GenerateGUID` method
provides random 128‑bit labels which can be treated as probabilistically
unique in a variety of scenarios.
addition, the `Class.HttpService:GenerateGUID()|GenerateGUID` method provides
random 128‑bit labels which can be treated as probabilistically unique in a
variety of scenarios.
You should only send HTTP requests to trusted third-party platforms to avoid
making your experience vulnerable to security risks.
Expand All @@ -27,41 +28,43 @@ description: |
##### Enable HTTP requests
Request-sending methods aren't enabled by default. To send requests, toggle
on **Allow&nbsp;HTTP&nbsp;Requests** through the [Game
Settings](../../../studio/game-settings.md) interface in Studio, or set
`Class.HttpService.HttpEnabled|HttpEnabled` to `true` in the [Command
Bar](../../../studio/ui-overview#command-bar.md) for **unpublished**
Request-sending methods aren't enabled by default. To send requests, toggle on
**Allow&nbsp;HTTP&nbsp;Requests** through the
[Game Settings](../../../studio/game-settings.md) interface in Studio, or set
`Class.HttpService.HttpEnabled|HttpEnabled` to `true` in the
[Command Bar](../../../studio/ui-overview.md#command-bar) for **unpublished**
experiences:
`game:GetService("HttpService").HttpEnabled = true`
##### Use in plugins
`HttpService` can be used by Studio plugins. They may do this to
check for updates, send usage data, download content, or other business logic.
The first time a plugin attempts to do this, the user may be prompted to give
the plugin permission to communicate with the particular web address. A user
may accept, deny, and revoke such permissions at any time through the **Plugin
`HttpService` can be used by Studio plugins. They may do this to check for
updates, send usage data, download content, or other business logic. The first
time a plugin attempts to do this, the user may be prompted to give the plugin
permission to communicate with the particular web address. A user may accept,
deny, and revoke such permissions at any time through the **Plugin
Management** window.
Plugins may also communicate with other software running on the same computer
through the `localhost` and `127.0.0.1` hosts. By running programs compatible
with such plugins, you can extend the functionality of your plugin beyond the
normal capabilities of Studio, such as interacting with your computer's
file system. Beware that such software must be distributed separately from the
normal capabilities of Studio, such as interacting with your computer's file
system. Beware that such software must be distributed separately from the
plugin itself and can pose security hazards if you aren't careful.
##### Additional considerations
- There are port restrictions. You cannot use port `1194` or any port below
`1024`, except `80` and `443`. If you try to use a blocked port, you will receive either a `403 Forbidden` or `ERR_ACCESS_DENIED` error.
`1024`, except `80` and `443`. If you try to use a blocked port, you will
receive either a `403 Forbidden` or `ERR_ACCESS_DENIED` error.
- For each Roblox game server, there is a limit of 500 HTTP requests per
minute. Exceeding this may cause request-sending methods to stall entirely
for about 30 seconds.
- Requests cannot be made to any Roblox website, such as www.roblox.com.
- Web requests can fail for many reasons, so it is important to "code
defensively" (use `Global.LuaGlobals.pcall()`) and have a plan for when requests fail.
defensively" (use `Global.LuaGlobals.pcall()`) and have a plan for when
requests fail.
- Although the `http://` protocol is supported, you should use `https://`
wherever possible.
- Requests sent should provide a secure form of authentication, such as a
Expand Down Expand Up @@ -118,7 +121,7 @@ methods:
wrapped in curly braces (`{}`). For instance:
- `true`: `{94b717b2-d54f-4340-a504-bd809ef5bf5c}`
- `false`: `db454790-7563-44ed-ab4b-397ff5df737b`
- `false`: `db454790-7563-44ed-ab4b-397ff5df737b`
code_samples:
- HttpService-GenerateGUID
parameters:
Expand Down Expand Up @@ -180,8 +183,8 @@ methods:
- Keys of the table are strings or numbers but not both. If a JSON object
contains both, string keys are ignored.
- An empty JSON object generates an empty Lua table (`{}`).
- If the `input` string is not a valid JSON object, this method will
throw an error.
- If the `input` string is not a valid JSON object, this method will throw
an error.
To encode a Lua table into a JSON object, use the
`Class.HttpService:JSONEncode()` method.
Expand Down Expand Up @@ -210,8 +213,8 @@ methods:
summary: |
Generate a JSON string from a Lua table.
description: |
This method transforms a Lua [table](../../../luau/tables.md)
into a JSON object or array based on the following guidelines:
This method transforms a Lua [table](../../../luau/tables.md) into a JSON
object or array based on the following guidelines:
- Keys of the table must be either strings or numbers. If a table contains
both, an array takes priority (string keys are ignored).
Expand Down Expand Up @@ -260,9 +263,8 @@ methods:
data of the media type `application/x-www-form-urlencoded`
(`Enum.HttpContentType|Enum.HttpContentType.ApplicationUrlEncoded`).
For instance, when you encode the URL
`https://www.roblox.com/discover#/`, this method returns
`https%3A%2F%2Fwww%2Eroblox%2Ecom%2Fdiscover%23%2F`.
For instance, when you encode the URL `https://www.roblox.com/discover#/`,
this method returns `https%3A%2F%2Fwww%2Eroblox%2Ecom%2Fdiscover%23%2F`.
code_samples:
- HttpService-UrlEncode
- HttpService-Pastebin
Expand Down
8 changes: 4 additions & 4 deletions content/en-us/reference/engine/classes/Humanoid.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1438,10 +1438,10 @@ methods:
`Enum.HumanoidStateType.PlatformStanding` will cause the humanoid state
to be automatically set to `Enum.HumanoidStateType.Running`.
Note that in order to set the `Class.Humanoid` state using this function,
you must do it in a `Class.LocalScript` owned by the NetworkOwner of the
`Class.Player.Character`. You can use this function in a `Class.Script`, but the NetworkOwner
of the `Class.Player.Character` must be the Server.
Note that in order to set the `Class.Humanoid` state using this function,
you must do it in a `Class.LocalScript` owned by the NetworkOwner of the
`Class.Player.Character`. You can use this function in a `Class.Script`,
but the NetworkOwner of the `Class.Player.Character` must be the Server.
See also `Class.Humanoid:SetStateEnabled()` to enable or disable a
particular state, and `Class.Humanoid:GetState()` to get the current
Expand Down
25 changes: 24 additions & 1 deletion content/en-us/reference/engine/classes/PublishService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,29 @@ tags:
- NotReplicated
deprecation_message: ''
properties: []
methods: []
methods:
- name: PublishService:CreateAssetOrAssetVersionAndPollAssetWithTelemetryAsyncWithAddParamErrorJson
summary: ''
description: ''
code_samples: []
parameters:
- name: serializedInstance
type: string
default:
summary: ''
- name: publishInfo
type: Dictionary
default:
summary: ''
returns:
- type: Dictionary
summary: ''
tags:
- Yields
deprecation_message: ''
security: RobloxScriptSecurity
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
events: []
callbacks: []
Loading

0 comments on commit c11b7af

Please sign in to comment.