ContentId

Stub

This article is a stub. You can help the Roblox Wiki by expanding it.

ContentId
Source	Roblox engine

The ContentId data type (formerly Content) is a formatted string which is a link to a file, usually in form of an asset, and is used in properties that require a link to an asset, such as the Decal.Texture property. In Properties, the engine rejects any string entered into a ContentId property that is not properly formatted.

Like ProtectedString, the data type itself is not accessible in Lua, since ContentId properties are treated as strings instead.

Valid protocols

The format for a ContentId string is "protocol://string", and the protocol is restricted to certain values. Anything not in this format or using an invalid protocol will result in a loading failure.

Protocol	String	Description	Example
rbxasset	A file path	Fetches a file from Roblox's content files (stored on PC)	rbxasset://textures/face.png
rbxassetid	An existing asset ID	Fetches an asset ID from the Roblox website. Must be approved.	rbxassetid://607948062
rbxgameasset	Folder/category + asset name	Fetches a file uploaded through the game explorer in studio.	rbxgameasset://Images/Potion
rbxhttp	A path on the website	Fetches content from the Roblox website. Shorthand for ContentProvider.BaseUrl.	rbxhttp://Thumbs/Avatar.ashx?x=100&y=100&format=png
rbxthumb	Ordered parameters and values	Fetches a thumbnail and supports retrying in case of failure. Order of params is enforced.	rbxthumb://type=Asset&id=24813339&w=150&h=150
http / https	URL	Fetches content from a website. Only works on Roblox-approved sites and will fail otherwise.	https://www.roblox.com/asset/?id=607948062

Referenced by

• Animation.AnimationId
• AnimationClipProvider:GetAnimationClip (assetId)
• AnimationClipProvider:RegisterActiveAnimationClip
• AnimationClipProvider:RegisterAnimationClip
• AnimationClipProvider:GetAnimationClipAsync (assetId)
• AnimationClipProvider:GetClipEvaluatorAsync (assetId)
• AssetService:CheckTextureAlphaAsync (textureId)
• AssetService:CreateEditableMeshStripSkinningAsync (meshId)
• BaseWrap.CageMeshId
• BaseWrap.HSRAssetId
• WrapLayer.ReferenceMeshId
• Beam.Texture
• CaptureService:PromptShareCapture (contentId)
• CaptureService:GetCaptureFilePathAsync (captureContentId)
• CaptureService:GetCaptureSizeAsync (captureContentId)
• CaptureService.OpenShareCapturePrompt (contentId)
• CaptureService.UserCaptureSaved (captureContentId)
• Pants.PantsTemplate
• Shirt.ShirtTemplate
• ShirtGraphic.Graphic
• ClickDetector.CursorIcon
• DragDetector.ActivatedCursorIcon
• ContentProvider:GetAssetFetchStatus (contentId)
• ContentProvider:GetAssetFetchStatusChangedSignal (contentId)
• ContentProvider:Preload (contentId)
• ContentProvider:RegisterEncryptedAsset (assetId)
• ContentProvider:RegisterSessionEncryptedAsset (contentId)
• ContentProvider:UnregisterEncryptedAsset (assetId)
• ContentProvider.AssetFetchFailed (assetId)
• FileMesh.MeshId
• FileMesh.TextureId
• Decal.Texture
• File:GetTemporaryId
• GeometryService:HashMeshAsync (meshId)
• ImageButton.HoverImage
• ImageButton.Image
• ImageButton.PressedImage
• ImageLabel.Image
• ScrollingFrame.BottomImage
• ScrollingFrame.MidImage
• ScrollingFrame.TopImage
• VideoFrame.Video
• ViewportFrame:CaptureSnapshotAsync
• AdGui.FallbackImage
• FloorWire.Texture
• ImageHandleAdornment.Image
• HeightmapImporterService:IsValidColormap (colormapAssetId)
• HeightmapImporterService:IsValidHeightmap (heightmapAssetId)
• HeightmapImporterService:GetHeightmapPreviewAsync (heightmapAssetId)
• HeightmapImporterService:ImportHeightmap (heightmapAssetId, colormapAssetId)
• InsertService:LoadPackageAsset (url)
• InsertService:CreateMeshPartAsync (meshId)
• InsertService:LoadPackageAssetAsync (url)
• KeyframeSequenceProvider:GetKeyframeSequence (assetId)
• KeyframeSequenceProvider:RegisterActiveKeyframeSequence
• KeyframeSequenceProvider:RegisterKeyframeSequence
• KeyframeSequenceProvider:GetKeyframeSequenceAsync (assetId)
• BaseScript.LinkedSource
• ModuleScript.LinkedSource
• MaterialVariant.ColorMap
• MaterialVariant.MetalnessMap
• MaterialVariant.NormalMap
• MaterialVariant.RoughnessMap
• Mouse.Icon
• MeshPart.MeshId
• MeshPart.TextureID
• BackpackItem.TextureId
• PackageLink.PackageId
• ParticleEmitter.Texture
• PluginToolbarButton.Icon
• PublishService:PublishCageMeshAsync
• SafetyService.ScreenshotContentReady (contentId)
• ScreenshotHud.CameraButtonIcon
• DataModel:GetObjects (url)
• DataModel:GetObjectsAllOrNone (url)
• DataModel:Load (url)
• DataModel:GetObjectsAsync (url)
• DataModel:InsertObjectsAndJoinIfLegacyAsync (url)
• Sky.MoonTextureId
• Sky.SkyboxBk
• Sky.SkyboxDn
• Sky.SkyboxFt
• Sky.SkyboxLf
• Sky.SkyboxRt
• Sky.SkyboxUp
• Sky.SunTextureId
• Sound.SoundId
• StudioAssetService:AutoSetupAvatarAsync (modelId)
• StudioAssetService:RequestAvatarAutosetupAsync (meshId, textureId)
• SurfaceAppearance.ColorMap
• SurfaceAppearance.MetalnessMap
• SurfaceAppearance.NormalMap
• SurfaceAppearance.RoughnessMap
• SurfaceAppearance.TexturePack
• TerrainDetail.ColorMap
• TerrainDetail.MetalnessMap
• TerrainDetail.NormalMap
• TerrainDetail.RoughnessMap
• TextService:GetFamilyInfoAsync (assetId)
• Trail.Texture
• UGCValidationService:FetchAssetWithFormat (url)
• UIDragDetector.ActivatedCursorIcon
• UIDragDetector.CursorIcon
• UserInputService.MouseIcon
• UserInputService:GetImageForKeyCode
• VideoPlayer.Asset
• VideoPlayer.Thumbnail
• GeometryService:StitchMeshesAsync (removed)
• WrapDeformer.RenderMeshID (removed)

Removed API using Content

The following removed API used the Content data type before it was renamed to ContentId.

• AssetService:CreateEditableImageAsync (content)
• AssetService:CreateEditableMeshAsync (content)
• AssetService:CreateMeshPartAsync (meshContent)
• BaseWrap.CageMeshContent
• WrapDeformer:SetCageMeshContent (content)
• WrapLayer.ReferenceMeshContent
• ImageButton.ImageContent
• ImageLabel.ImageContent
• MeshPart.MeshContent
• MeshPart.TextureContent
• Button.Icon (removed)
• ImageDataExperimental.TemporaryId (removed)
• ImageDataExperimental:PopulateFromImageAsync (textureId) (removed)
• LocalAsset:GetTemporaryId (removed)
• MeshDataExperimental:PopulateFromMeshAsync (meshId) (removed)
• TextureTrail.Texture (removed)
• Humanoid.WalkingSound (removed)
• Humanoid.JumpSound (removed)
• Humanoid.GettingUpSound (removed)
• Humanoid.FallingDownSound (removed)
• AssetService:CreateDynamicImageAsync (textureId) (removed)
• AssetService:CreateDynamicMeshAsync (meshId) (removed)
• AssetService:LoadImageAsync (textureId) (removed)
• DataModel:get (url) (removed)
• DataModel:Save (url) (removed)
• DynamicMesh:InitializeFromMeshIdAsync (meshId) (removed)
• EditableImage:GetContent (removed)
• EditableMesh:GetContent (removed)
• HeightmapImporterService:GetGreyscale (heightmapAssetId) (removed)
• MeshPart.MeshID (removed)
• MeshPart.TextureId (removed)
• PackageLink.Package Id (removed)
• Terrain:ImportHeightmap (heightmapAssetId, colormapAssetId) (removed)
• TextureGuiExperimental.TemporaryId (removed)
• Workspace:InsertContent (url) (removed)

External links

• ContentId on the Roblox Creator Documentation
• Content Format Strings section of Asset Types on the Roblox Creator Documentation