Data type
Content
Represents a reference to asset content stored externally or as an object within the place.
The Content data type represents a reference to asset content stored
externally or as an object within the place, wrapping a single value of one of
the supported ContentSourceType values.
Warning#
Replication is not yet supported for Object values.
When an Instance with a Content property containing a
Object value is replicated, an unusable placeholder
Object of the same type will be used instead of the Object
itself, and any attempt to read or write the contents of that placeholder
object will throw. These placeholder objects will render as a cyan and magenta
checkerboard pattern.
This will be replaced with standard replication behavior in the future. For
now, do not use EditableImage or EditableMesh as
Content on the server on an Instance that can replicate to
clients.
Constructors 3#
| fromUri | Returns a new Content with an
asset URI string value
referencing content external to the place. |
| fromAssetId | Returns a new Content from a numeric asset ID. |
| fromObject | Returns a new Content with a strong reference to an Object. |
fromUri(uri: string)#
Returns a new Content with an
asset URI string value
referencing content external to the place.
Content.SourceType will be Uri, and
Content.Uri will contain a non‑nil string value.
If uri is empty, Content.none will be returned instead.
| Name | Type | Default | Description |
|---|---|---|---|
uri | string | The asset URI string. |
fromAssetId(assetId: number)#
Returns a new Content from a numeric asset ID. This is a convenience
constructor equivalent to calling
Content.fromUri("rbxassetid://" .. tostring(assetId)).
Content.SourceType will be Uri, and
Content.Uri will contain the formatted rbxassetid:// URI
string.
If assetId is 0, Content.none will be returned instead.
Throws if assetId is non‑finite, for example math.huge() or
0/0.
| Name | Type | Default | Description |
|---|---|---|---|
assetId | number | The numeric asset ID. |
fromObject(object: Object)#
Returns a new Content with a strong reference to an Object.
Content.SourceType will be Object, and
Content.Object will contain a non‑nil Object
reference.
Content.Object references are strong references that hold
shared ownership of the Object. Any Content.Object
reference will extend the lifetime of that Object and prevent it
from being garbage collected.
Throws if object is nil.
Constants 1#
| none | An empty Content value with Content.SourceType of
None. |
none: Content#
An empty Content value with Content.SourceType of
None.
Properties 5#
noneContent | An empty Content value with Content.SourceType of
None. |
SourceTypeEnum.ContentSourceType | The source type of the contained value. |
Uristring? | A URI string if Content.SourceType is
Uri, otherwise nil. |
ObjectObject? | A reference to a non-nil Object if Content.SourceType
is Object, otherwise nil. |
OpaqueOpaque? | A reference to a non-nil Opaque content if
Content.SourceType is Opaque,
otherwise nil. |
none: Content#
An empty Content value with Content.SourceType of
None.
SourceType: Enum.ContentSourceType#
The source type of the contained value. Indicates which property contains
a non‑nil value.
Uri: string?#
A URI string if Content.SourceType is
Uri, otherwise nil.
Object: Object?#
A reference to a non-nil Object if Content.SourceType
is Object, otherwise nil.
Opaque: Opaque?#
A reference to a non-nil Opaque content if
Content.SourceType is Opaque,
otherwise nil.