Capture

Inherits from: Object

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

Inherits from: Object

Descendants: ScreenshotCapture, VideoCapture

Memory category: Instances

Tags: NotCreatable, NotReplicated

Properties

Name	Type / Returns	Description
Capture.CaptureTime	DateTime	The date and time at which the capture was taken.
Capture.CaptureType	CaptureType	Indicates whether the capture is a screenshot or a video.
Capture.FilePathString	string	The local filesystem path to the capture's file, as a string.
Capture.LocalId	string	A temporary local identifier for the capture's stored file.
Capture.SourcePlaceId	int64	The ID of the place in which the capture was taken.
Capture.SourceUniverseId	int64	The ID of the experience in which the capture was taken.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

Capture.CaptureTime

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.

Field	Value
type	DateTime
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":true}
capabilities	["Capture"]

Capture.CaptureType

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

Field	Value
type	CaptureType
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":true}
capabilities	["Capture"]

Capture.FilePathString

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.

Field	Value
type	string
tags	["ReadOnly","NotReplicated"]
security	{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":true}
capabilities	["Capture"]

Capture.LocalId

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.

Field	Value
type	string
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":true}
capabilities	["Capture"]

Capture.SourcePlaceId

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.

Field	Value
type	int64
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":true}
capabilities	["Capture"]

Capture.SourceUniverseId

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.

Field	Value
type	int64
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":true}
capabilities	["Capture"]

Methods

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

Events

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.