Skip to content

Add rbxgameasset to asset url types #879

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 6 commits into from
Oct 28, 2024
Merged

Add rbxgameasset to asset url types #879

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
504b8ca
Add `rbxgameasset` to asset url types
ccuser44 Oct 22, 2024
10d9d13
Add `rbxgameasset` to content datatype
ccuser44 Oct 22, 2024
1e86d7a
Fix typo
ccuser44 Oct 22, 2024
cd3220e
Merge branch 'main' into patch-3
ccuser44 Oct 24, 2024
244d337
Merge branch 'main' into patch-3
IgnisRBX Oct 28, 2024
3f76a3f
Update index.md
IgnisRBX Oct 28, 2024
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
10 changes: 10 additions & 0 deletions content/en-us/projects/assets/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,16 @@ The content folder's location depends on the user's operating system:
</TabItem>
</Tabs>

### rbxgameasset

`rbxgameasset` points to an asset uploaded through the [Asset Manager](../../projects/assets/manager.md). It allows access to assets by a user-friendly name instead of ID, so if you upload an image named `Potion.png`, you can reference it as:

<span><Chip label='rbxgameasset://Images/Potion.png' color='primary' size='large' /></span><br />

In the above example, "Images" is the category/folder that appears in the Asset Manager, and "Potion" is the asset name, minus its extension.

> Note that **rbxgameasset** only works for the current game. If you paste a parent object that utilizes the asset in to another game, the asset will not load (or will load a different asset if you've uploaded one with the same name to that ither game). If you need an asset to work across multiple games, use **rbxassetid** instead of **rbxgameasset**.

### rbxthumb

`rbxthumb` points to a thumbnail image for the provided asset. Its string format takes a thumbnail type (`type`), an asset ID (`id`), and width/height (`w`/`h`).
Expand Down
8 changes: 7 additions & 1 deletion content/en-us/reference/engine/datatypes/Content.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,18 @@ description: |
<td>Fetches a user-created asset uploaded to Roblox.</td>
<td>rbxassetid://7229442422</td>
</tr>
<tr>
<tr>
<td><b>rbxasset</b></td>
<td>A file path</td>
<td>Fetches a file from Roblox's content folders.</td>
<td>rbxasset://textures/face.png</td>
</tr>
<tr>
<td><b>rbxgameasset</b></td>
<td>Path for uploaded asset</td>
<td>A textual path to an asset uploaded through the [Asset Manager](../../projects/assets/manager.md).</td>
<td>rbxasset://Images/Potion.png</td>
</tr>
<tr>
<td><b>rbxthumb</b></td>
<td>Parameters and values</td>
Expand Down
Loading