Skip to content

Consolidate HttpEnabled explaination #1014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 5, 2025
Merged

Consolidate HttpEnabled explaination #1014

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
547ca0e
clarify HttpEnabled
Superburke Feb 5, 2025
18ba4d9
Update content/en-us/reference/engine/classes/HttpService.yaml
IgnisRBX Feb 5, 2025
223d4f1
Update content/en-us/reference/engine/classes/HttpService.yaml
IgnisRBX Feb 5, 2025
8a7b414
Merge branch 'main' into patch-1
IgnisRBX Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions content/en-us/reference/engine/classes/HttpService.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,8 @@ description: |

##### Enable HTTP requests

Request-sending methods aren't enabled by default. To send requests, toggle on
**Allow HTTP 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`
Request-sending methods aren't enabled by default. To send requests, you must
[enable HTTP requests](#HttpEnabled) for your experience.

##### Use in plugins

Expand Down Expand Up @@ -87,9 +81,17 @@ properties:
summary: |
Indicates whether HTTP requests can be sent to external websites.
description: |
When set to `true`, you are able to send requests to other websites using
When set to `true`, allows scripts to send requests to websites using
`Class.HttpService:GetAsync()`, `Class.HttpService:PostAsync()`, and
`Class.HttpService:RequestAsync()`.

To send requests, this property must be toggled on through the
[Game Settings](../../../studio/game-settings.md) interface in Studio, or
for **unpublished** experiences, set this property to `true` using the
[Command Bar](../../../studio/ui-overview.md#command-bar):

`game:GetService("HttpService").HttpEnabled = true`

code_samples:
type: bool
tags: []
Expand Down