Class
Capture
NotCreatableNotReplicated
A class which defines a piece of content, such as a screenshot or video, taken in-experience.
Represents a single piece of content — a screenshot or a video — captured
within an experience. A Capture records metadata about that content,
including when it was taken (Capture.CaptureTime), what kind of
content it is (Capture.CaptureType), the place and experience it
originated from (Capture.SourcePlaceId and
Capture.SourceUniverseId), and where its underlying file is stored
(Capture.LocalId and Capture.FilePathString).
Properties 6#
CaptureTimeDateTime | The date and time at which the capture was taken.ReadSafeReadOnlyNotReplicated |
CaptureTypeCaptureType | Indicates whether the capture is a screenshot or a video.ReadSafeReadOnlyNotReplicated |
FilePathStringstring | The local filesystem path to the capture's file, as a string.Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafeReadOnlyNotReplicated |
LocalIdstring | A temporary local identifier for the capture's stored file.ReadSafeReadOnlyNotReplicated |
SourcePlaceIdint64 | The ID of the place in which the capture was taken.ReadSafeReadOnlyNotReplicated |
SourceUniverseIdint64 | The ID of the experience in which the capture was taken.ReadSafeReadOnlyNotReplicated |
CaptureTime: DateTime#
ReadOnlyNotReplicatedReadSafe
CaptureType: CaptureType#
ReadOnlyNotReplicatedReadSafe
Indicates the kind of content the capture holds, as an CaptureType
value. Defaults to CaptureType.Screenshot. This property is
read-only.
FilePathString: string#
ReadOnlyNotReplicatedRead: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe
The path to the capture's file on the local filesystem, returned as a string. It resolves to the file backing the capture in local capture storage, or an empty string when no file is associated with the capture. This property is read-only.
LocalId: string#
ReadOnlyNotReplicatedReadSafe
A local identifier for the capture's stored file, in the form
rbxtemp://. It is empty until the capture has been saved to local
capture storage, after which it references the stored file by key. This
property is read-only.
SourcePlaceId: int64#
ReadOnlyNotReplicatedReadSafe
The PlaceId of the place in which the capture
was taken. Defaults to 0 when the source place is unknown or unset. This
property is read-only.
SourceUniverseId: int64#
ReadOnlyNotReplicatedReadSafe
The universe (experience) ID of the experience in which the capture was
taken. Defaults to 0 when the source universe is unknown or unset. This
property is read-only.