Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Capture

A class which defines a piece of content, such as a screenshot or video, taken in-experience.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable, NotReplicated]

Member index 6

HistoryMember
684CaptureTime: DateTime
684CaptureType: CaptureType
687FilePathString: string
684LocalId: string
684SourcePlaceId: int64
684SourceUniverseId: int64
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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).

History 7

Members 6

CaptureTime

TypeDefault
DateTime

The date and time at which the capture was taken, as a DateTime. It defaults to the moment the Capture is created. This property is read-only.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 1

Tags: [ReadOnly, NotReplicated]

CaptureType

TypeDefault
CaptureType__api_dump_failed_to_create_class__

Indicates the kind of content the capture holds, as an CaptureType value. Defaults to CaptureType.Screenshot. This property is read-only.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 1

Tags: [ReadOnly, NotReplicated]

FilePathString

TypeDefault
string__api_dump_failed_to_create_class__

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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 1

Tags: [ReadOnly, NotReplicated]

LocalId

TypeDefault
string__api_dump_failed_to_create_class__

A local identifier for the capture's stored file, in the form rbxtemp://<key>. 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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 1

Tags: [ReadOnly, NotReplicated]

SourcePlaceId

TypeDefault
int64__api_dump_failed_to_create_class__

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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 1

Tags: [ReadOnly, NotReplicated]

SourceUniverseId

TypeDefault
int64__api_dump_failed_to_create_class__

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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 1

Tags: [ReadOnly, NotReplicated]

Settings